Android sdk 生成api doc文档

编写的sdk提供外部使用时需要api文档供三方查看,此时就要生成apidoc。
Android Studio支持生成apidoc

1.AS生成

选择Tools Generate JavaDoc
在这里插入图片描述
选择需要生成的module,设置生成路径,语言,以及设置utf-8编码。
![在这里插入图片描述](https://img-blog.csdnimg.cn/cb52fb593c2f493298d9f1d81ac8b373.png
但是如果是kotlin就无法生效
在这里插入图片描述
此时就使用第二种方式

2.dokka

dokka是一个开源项目,dokka
project的build.gradle导入依赖

 dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath 'com.android.tools.build:gradle:4.2.0'

        classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.5.30")

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files


        BUILD_SCRIPT_CLASSPATH.each {cla->
            classpath cla
        }
    }

对应module下引入插件

apply plugin: 'org.jetbrains.dokka'


tasks.dokkaJavadoc.configure {
    // 导出的文档目录路径
    outputDirectory.set(new File(rootDir, "doc"))
    dokkaSourceSets {
        named("main") {
            noAndroidSdkLink.set(true)
            noStdlibLink.set(true)
            noJdkLink.set(true)
        }

    }
}

设置输出路径以及配置

在这里插入图片描述
打开右侧的Gradle窗口,然后通过项目名 --> app --> Tasks --> documentation --> dokka找到该任务,双击运行任务
或者在底部Terminal窗口中输入./gradlew dokka执行任务

3.结果

在这里插入图片描述
对应目录下找到apidoc,点击inerx.html就可以查看apidoc了

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值