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

相关推荐
蛋蛋的就会顺顺的5 小时前
hot100 p0——栈,贪心算法,动态规划
java·前端·javascript·算法·leetcode·力扣
需要8266 小时前
Spring Bean 生命周期:从实例化到销毁的完整钩子
java·后端·spring
小 黄 鸡6 小时前
HashMap 面试必会知识点详解(JDK 8)
java·面试·职场和发展
死磕音视频7 小时前
让小模型做选择题:限定候选项并读取 logits 概率的入门实践(附 Python 代码)
开发语言·python·大模型·文本分类·transformers
伯恩bourne8 小时前
Spring Boot Bean 注册的两种方式:@Component 家族 vs @Configuration + @Bean
java·spring boot·后端
silvamux_8 小时前
curl 测试 OpenAI 兼容 API 的完整流程
java·人工智能·缓存·ai·oneapi
省钱兄--zs9 小时前
深圳24小时自助健身房软硬件解决方案实战指南与开发流程详解
java·数据仓库·spring boot·小程序·架构
顽疲9 小时前
Java vue 养老系统源码详解:月账单 care_month_bill 与 Quartz 扣费 Job 实践
java·开发语言·vue.js·vue养老·springboot养老·java养老
Wang's Blog9 小时前
Java 项目实战: 交友项目 - 安装开发工具与环境准备
java·开发语言·交友
用户21296835261689 小时前
开源了一个 Java 多智能体 LLM 框架 Baton:一个依赖,把 Agent 循环、工具调用、记忆、编排全配齐
java·llm