Dokka是Kotlin官方推荐的文档生成工具,目前看来也是唯一的生成工具。在配置gradle方式的时候提示错误很有限,可以使用命令行形式配置。

官方文档

参考官方配置只是第一步,链接->官方命令行配置,这里没有说完整,所以还是运行不起来的。

注意事项

一般这些问题会被忽略导致运行失败, 需要参考社区讨论才能找到答案:

1、pluginsClasspath参数和plugin处理: 从命令行运行,一定要把需要依赖的jar文件下载到本地,然后填写到pluginsClasspath参数,否则缺少相关依赖无法运行。

2、sourceSet参数的设置非常特殊: 它下面还有其他参数,比如src,moduleName,需要写成-sourceSet “-src xxx -moduleName xxx”的形式

这样就没问题了。下面是一个示范,src/main/java应该替换成自己实际的代码位置,./doc也应该替换成实际的用来放置帮助文档的目录;pluginsClasspath里面的各个文件也需要替换成实际的文件位置。

正确运行的dokka命令行示范

一个很长的命令行,据说也可以使用json格式配置,但是json格式配置没有探索出来: java -jar ../dokkaplugin/dokka-cli-1.4.0-rc.jar -pluginsClasspath “../dokkaplugin/dokka-analysis-1.4.0-rc.jar;../dokkaplugin/dokka-base-1.4.0-rc.jar;../dokkaplugin/kotlin-analysis-compiler-1.4.0-rc.jar;../dokkaplugin/kotlin-analysis-intellij-1.4.0-rc.jar;../dokkaplugin/kotlinx-coroutines-core-1.4.0-M1.jar;../dokkaplugin/kotlinx-html-jvm-0.7.1-1.4.0-rc.jar” -sourceSet “-moduleName sampleModule -src src/main/java/” -outputDir ./doc