plugins {
id 'org.jetbrains.dokka' version '0.x.x'
}
dokka {
outputFormat = 'html' //指定输出格式为HTML
outputDirectory = "$buildDir/javadoc" //指定HTML输出路径
moduleName = 'module_name' //指定生成文档的模块
moduleDisplayName = 'Module Display Name' //指定文档的显示名称
includeNonPublic = true //包括非公共成员
skipEmptyPackages = true //跳过空包
jdkVersion = 8 //指定JDK版本
perPackageOptions {
matchRegex = "com.example.(?!.*test).*" //为给定包名的所有子包指定选项,排除包含"test"的包
externalDocumentationLink {
url = "https://docs.oracle.com/javase/8/docs/api/" //为外部文档提供链接
packageListUrl = "https://docs.oracle.com/javase/8/docs/api/package-list" //指定包列表URL
}
}
}
./gradlew dokkaHtmlMultiModule
即可生成所有模块的文档。文档将保存在每个模块的build/dokka/html目录中。
注意:在以上代码示例中,“0.x.x”和“module_name”应该分别替换为Dokka插件当前版本和