AndroidDokka多项目文档生成如何实现?
创始人
2024-10-07 13:33:14
0
  1. 创建Kotlin多项目:首先需要创建一个Kotlin多项目,在其中包含所有需要文档化的模块。
  2. 配置Dokka插件:在每个模块的build.gradle文件中添加Dokka插件的配置,如下所示:
plugins {
    id 'org.jetbrains.dokka' version '0.x.x'
}
  1. 配置Dokka插件属性:设置Dokka插件的属性来指定文档的输出路径、格式和其他选项。例如,以下是一个示例配置文件:
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
        }
    }
}

  1. 生成文档:在项目根目录中执行以下命令,以生成文档:
./gradlew dokkaHtmlMultiModule

即可生成所有模块的文档。文档将保存在每个模块的build/dokka/html目录中。

注意:在以上代码示例中,“0.x.x”和“module_name”应该分别替换为Dokka插件当前版本和

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...