AndroidDokka多项目文档生成如何实现?
创始人
2024-10-07 13:31:55
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插件当前版本和

相关内容

热门资讯

专业讨论!wepoker模拟器... wepoker模拟器哪个好用AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏...
重大消息!wpk有那种辅助吗,... 重大消息!wpk有那种辅助吗,WPK有挂吗教程(先前有开挂)AI 智能体黑科技再上新,自动化能力开挂...
推荐几款新版!wepoker底... 您好:wepoker底牌透视这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多用...
总算了解!wpk有作弊吗,德普... 总算了解!wpk有作弊吗,德普之星外卦神器软件教程(竟然有开挂)AI 智能体黑科技再上新,自动化能力...
大神推荐!wepoker透视脚... wepoker透视脚本免费AI 游戏攻略黑科技上线本地缓存功能,离线查阅能力开挂。提前下载对应游戏攻...
避坑细节!如何下载德普之星辅助... 『标题:当前标题』主打赛后复盘的 AI 游戏攻略黑科技走红,对局总结能力开挂。上传对局回放或者战绩截...
一分钟了解!!wepoker辅... AI 黑科技赛道又上新,这款智能处理工具堪称效率开挂,专门面向短视频创作者打造。它打通脚本撰写、AI...
玩家科普!wpk真的有透视嘛,... 玩家科普!wpk真的有透视嘛,WPK透视脚本工具(好像存在有辅助挂)AI 智能体黑科技再上新,自动化...
一分钟揭秘!德普之星辅助工具如... 您好:德普之星辅助工具如何打开这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很多...
大家学习交流!wepoker游... 您好:wepoker游戏安装教程这款游戏可以开挂的,确实是有挂的,很多玩家在这款游戏中打牌都会发现很...