编写的sdk提供外部使用时需要api文档供三方查看,此时就要生成apidoc。
Android Studio支持生成apidoc
1.AS生成
选择Tools Generate JavaDoc
选择需要生成的module,设置生成路径,语言,以及设置utf-8编码。
但是如果是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了