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

相关推荐
2601_949146535 小时前
C语言语音通知接口接入教程:如何使用C语言直接调用语音预警API
c语言·开发语言
曹牧5 小时前
Spring Boot:如何测试Java Controller中的POST请求?
java·开发语言
KYGALYX6 小时前
服务异步通信
开发语言·后端·微服务·ruby
zmzb01036 小时前
C++课后习题训练记录Day98
开发语言·c++
爬山算法6 小时前
Hibernate(90)如何在故障注入测试中使用Hibernate?
java·后端·hibernate
kfyty7256 小时前
集成 spring-ai 2.x 实践中遇到的一些问题及解决方案
java·人工智能·spring-ai
猫头虎6 小时前
如何排查并解决项目启动时报错Error encountered while processing: java.io.IOException: closed 的问题
java·开发语言·jvm·spring boot·python·开源·maven
李少兄6 小时前
在 IntelliJ IDEA 中修改 Git 远程仓库地址
java·git·intellij-idea
YUJIANYUE7 小时前
PHP纹路验证码
开发语言·php
忆~遂愿7 小时前
ops-cv 算子库深度解析:面向视觉任务的硬件优化与数据布局(NCHW/NHWC)策略
java·大数据·linux·人工智能