9

背景

经过大量的研究和尝试，并寻求帮助，我已经成功地在 Jitpack 上使用 maven 发布了一个私有的 Github 存储库（写在这里）。

所以，目前我放在 Jitpack 存储库中的文件就是这些：

  • jitpack.yml - 告诉使用哪些文件
  • library-release.aar - （混淆的）代码本身
  • pom-default.xml - 依赖项和其他一些配置。

问题

虽然依赖问题和 AAR 文件本身都很好，并且我可以使用该库，但我注意到我无法找到一种方法将我在那里编写的内容作为 KDoc（如 JavaDocs，但对于 Kotlin）提供给使用它的任何人。

我试过的

除了各种 gradle 任务，我还尝试了 Android Studio 本身的简单操作来制作它。由于没有提到 KDoc，我使用Tools->Generate JavaDocs代替。

可悲的是，它告诉我没有，而且确实在这里报道过。

但即使它确实成功了，我也不知道如何将它与其余文件一起发布。

问题

我希望这是可能的，但是如何在 Jitpack 上使用 maven 生成和公开 KDoc？

4

1 回答 1

1

您需要使用 Dokka 来自动记录 Kotlin 项目。您可以在本文中找到 Dokka 的简要说明，并在需要时阅读文档。

使用 Gradle 插件

首选方法是使用插件块。

build.gradle.kts:

plugins {
    id("org.jetbrains.dokka") version "1.4.32" }

repositories {
    mavenCentral() }

该插件将dokkaHtml、dokkaJavadoc和 任务添加到项目中dokkaGfm。dokkaJekyll

应用插件

Dokka 插件为每种输出格式创建 Gradle 配置，格式如下dokka${format}Plugin：

dependencies {
    dokkaHtmlPlugin("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.32") }

您还可以创建自定义 Dokka 任务并直接在其中添加插件：

val customDokkaTask by creating(DokkaTask::class) {
    dependencies {
        plugins("org.jetbrains.dokka:kotlin-as-java-plugin:1.4.32")
    } }

请注意 dokkaJavadoc 任务将仅正确记录单个 jvm 源集

要生成文档，请使用适当的 dokka${format} Gradle 任务：

./gradlew dokkaHtml

请参阅 Dokka Gradle 示例项目以获取示例。

com.android.library确保在和 之后应用 Dokka kotlin-android。

buildscript {
    dependencies {
        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlin_version}")
        classpath("org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}")
    } } repositories {
    mavenCentral() } apply(plugin= "com.android.library") apply(plugin= "kotlin-android") apply(plugin= "org.jetbrains.dokka")

dokkaHtml.configure {
    dokkaSourceSets {
        named("main") {
            noAndroidSdkLink.set(false)
        }   
    } }

更多在官方 GitHub 存储库 - https://github.com/Kotlin/dokka 你也可能喜欢这篇文章。

于 2021-05-06T08:10:43.553 回答