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生成啦

相关推荐
z落落7 小时前
C#WinForm 窗体切换与窗体传值(登录跳转案例)+WinForm 窗体传值(从上往下传、从下往上传)
开发语言·windows·c#
allway27 小时前
How to Echo Multiline to a File in Bash [3 Methods]
开发语言·chrome·bash
weixin_462446237 小时前
手把手教你用 Bash 脚本自动更新 /etc/hosts —— 自动绑定网卡 IP 与节点名
开发语言·tcp/ip·bash
一个梦醒了7 小时前
安装git bash选项推荐
开发语言·git·bash
摇滚侠7 小时前
SpringMVC 入门到实战 文件上传 75-77
java·后端·spring·maven·intellij-idea
GIS数据转换器7 小时前
城市排水生命线安全运行监测平台深度解析
java·运维·人工智能·python·安全·数据挖掘·无人机
ct9787 小时前
React 状态管理方案深度对比
开发语言·前端·react
数量技术宅8 小时前
2026量化前沿:从Reddit热帖到Python实战,如何用赫斯特指数(Hurst)狙击虚假突破?
开发语言·python
华如锦8 小时前
面了很多 Java转AI Agent方向,一些面试题总结
java·开发语言·人工智能·python·ai
睡不醒男孩0308238 小时前
CLup 6.x 版本中针对StarRocks 存算一体集群的完整操作手册
java·服务器·网络·clup