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

原创已于 2023-04-04 14:23:01 修改 · 641 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#android #java #kotlin

于 2023-03-30 17:14:45 首次发布

Android 同时被 3 个专栏收录

3 篇文章

订阅专栏

java

3 篇文章

订阅专栏

Kotlin

2 篇文章

订阅专栏

本文详细介绍了如何在Gradle项目中配置Dokka插件，以便为KotlinAndroid模块生成文档。首先，需在build.gradle文件中添加Dokka依赖和阿里云仓库。接着，在module的build.gradle中应用Dokka插件并配置输出目录和选项，如包括非公开API、禁用链接等。最后，通过运行./gradlewdokkaHtml命令生成Html格式的文档。Dokka还支持Javadoc、Jekyll和Gfm等不同格式的文档生成。

标题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

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

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

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

在 module build.gradle 中添加

运行

dokka官方

dokka官方文档

dokka其他生成文档命令

1 条评论