kotlin项目实现Java doc的方案:使用Dokka

执行指令**./gradlew dokkaHtml** 后,会在 "yourLibraryModule"/build/dokka/html/index.html路径生成对应的html文件

但是这个命令执行会存在一些报错,接下来逐步解释一下遇到的报错:

首先是Gradle版本与Android Gradle Plugin插件的版本不兼容:

报错内容如下: FAILURE: Build failed with an exception.

  • What went wrong: A problem occurred configuring root project 'SmartInterationCarLink'.
    Could not resolve all files for configuration ':classpath'.
    Could not resolve com.android.tools.build:gradle:7.4.2. Required by: project :
    No matching variant of com.android.tools.build:gradle:7.4.2 was found.
    The consumer was configured to find a library for use during runtime,
    compatible with Java 8, packaged as a jar, and its dependencies declared externally,
    as well as attribute 'org.gradle.plugin.api-version' with value '8.6' but: - Variant 'apiElements' capability com.android.tools.build:gradle:7.4.2 declares a library,
    packaged as a jar, and its dependencies declared externally:

解决方案:降级Gradle版本到7.5

**Step 1:**确认当前 Gradle 版本:./gradlew -v

查看当前结果是:Gradle 8.6

**Step 2:**修改 Gradle Wrapper gradle的版本

打开文件:gradle/wrapper/gradle-wrapper.properties

修改为:distributionUrl=https://services.gradle.org/distributions/gradle-7.5-bin.zip

**Step 3:**确保 JDK 至少是 11(或17)

使用./gradlew -v 查看 JVM版本

如果不是17,可以通过gradle.properties内指定绝对路径,参考:

org.gradle.java.home=/usr/lib/jvm/java-17-openjdk-amd64

  • 如果不知道路径,可以用 readlink -f $(which javac) 这个命令查看路径
  • 如果本地没安装17,ubuntu系统可以使用 此命令进行安装 sudo apt install openjdk-17-jdk

以上基本可以解决全部环境问题。

接下来是Dokka 插件应用问题,确保环境正常后再次执行./gradlew dokkaHtml

会报错如下:

Configure project :app WARNING:The option 'android.databinding.enableV2' is deprecated.

The current default is 'true'.

It has been removed from the current version of the Android Gradle plugin. Databinding v1 is removed.

FAILURE: Build failed with an exception.

What went wrong: Task 'dokkaHtml' not found in root project 'SmartInterationCarLink'.

出现这个问题的原因是Dokka是个插件,需要在工程中引用,引用方法如下:

在根目录的build.gradle 中统一声明版本

复制代码
plugins {
    id "org.jetbrains.dokka" version "1.9.20" apply false
}

在需要生成doc的模块增加插件引用:

复制代码
plugins {
    id 'org.jetbrains.dokka'
}

完成以上步骤就可以实现kotlin版本的doc生成啦

相关推荐
好家伙VCC1 分钟前
**发散创新:基于Python与ROS的机器人运动控制实战解析**在现代机器人系统开发中,**运动控制**是实现智能行为的核心
java·开发语言·python·机器人
2401_827499991 分钟前
python项目实战09-AI智能伴侣(ai_partner_2-3)
开发语言·python
派葛穆4 分钟前
汇川PLC-Python与汇川easy521plc进行Modbustcp通讯
开发语言·python
程途知微44 分钟前
ConcurrentHashMap线程安全实现原理全解析
java·后端
lzhdim44 分钟前
SharpCompress:跨平台的 C# 压缩与解压库
开发语言·c#
嘿嘿嘿x31 小时前
Linux记录过程
linux·开发语言
Mars酱1 小时前
1分钟编写贪吃蛇 | JSnake贪吃蛇单机版
java·后端·开源
devpotato1 小时前
人工智能(四)- Function Calling 核心原理与实战
java·人工智能
默 语1 小时前
Records、Sealed Classes这些新特性:Java真的变简单了吗?
java·开发语言·python
止观止1 小时前
拥抱 ESNext:从 TC39 提案到生产环境中的现代 JS
开发语言·javascript·ecmascript·esnext