Java、Kotlin混合开发， Dokka 多 module 生成 doc 简单实现步骤

标题Dokka 多 module 生成 doc 简单实现步骤

在项目的build.gradle 文件中添加

repositories {
	...
	 maven { url 'https://maven.aliyun.com/nexus/content/groups/public/' }
}
dependencies {
        ...
        classpath 'org.jetbrains.dokka:dokka-gradle-plugin:1.5.30'
}

在 module build.gradle 中添加

plugins {
    ...
    //重点！重点！重点！
    id 'kotlin-android'
    //需要放到最后
    id 'org.jetbrains.dokka'
}

...
dokkaHtml.configure {
    String dokkaPath = projectDir.absolutePath.replace(rootDir.absolutePath, "")
    outputDirectory.set(new File(rootDir.absolutePath + File.separator + "dokka" + dokkaPath))
    dokkaSourceSets {
        named("main") {
            includeNonPublic.set(true)
            noJdkLink.set(true)
            noStdlibLink.set(true)
            noAndroidSdkLink.set(true)
            suppressInheritedMembers.set(true)
            suppressObviousFunctions.set(false)
        }
    }
}

运行

terminal中运行

./gradlew dokkaHtml

dokka官方

github地址
参数配置

dokka官方文档

飞机票

dokka其他生成文档命令

dokkaJavadoc
dokkaHtml
dokkaJekyll
dokkaGfm