在 Android studio 3 中找不到 Dokka 插件

Question

我正在嘗試在我的 Kotlin 項目中使用 dokka 插件，但我收到以下消息：

錯誤：(7, 0) 未找到 ID 為“org.jetbrains.dokka”的插件。

我正在使用 Android Studio 3.0 版。

提前致謝。

Answer 1

首次在 Android Studio 中將 Dokka 與 Kotlin 結合使用

#1. 設置

##1.1 build.gradle(Project) 中的設置

buildscript {
    ext {
        version_dokka = "0.10.0"
        version_gradle = "3.5.2"
        version_kotlin = "1.3.41"
        ...
    }
    dependencies {
        classpath "com.android.tools.build:gradle:$version_gradle"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$version_kotlin"
        classpath "org.jetbrains.dokka:dokka-gradle-plugin:${version_dokka}"
        ...
    }
}
allprojects {
    repositories {
        google()
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

##1.2 build.gradle(Module:app)中的設置

android {
    compileSdkVersion 29
    buildToolsVersion "29.0.2"
    ...
    // Dokka used for auto-generation documentation
    dokka {
        outputFormat = 'html'
        //outputDirectory = "$buildDir/dokka"

        configuration {
            // Do not output deprecated members
            skipDeprecated = true

            // Emit warnings about not documented members.
            reportUndocumented = true

            // Do not create index pages for empty packages
            skipEmptyPackages = true
        }
    }
}

// workaround: create DocsByDokka
task DocsByDokka (type: org.jetbrains.dokka.gradle.DokkaTask) {
    outputFormat = "html"
    outputDirectory = "$buildDir/dokka"
}

不要忘記同步

#2. 構建文檔

##2.1 你的代碼應該包含注釋。 請查看以下鏈接以獲取更多詳細信息： https : //kotlinlang.org/docs/reference/kotlin-doc.html

##2.2 轉到Android Studio 中的Gradle-Window 我必須點擊Android Studio 3 右上角的“Gradle” 點擊“Gradle”后會打開一個窗口。 --> 我的項目 --> 應用程序 --> 任務 --> DocsByDokka

Android Studio 中的 Gradle 窗口

##2.3 生成文檔在 Gradle 窗口中雙擊 DocsByDokka。

#3. 查找文檔 ##3.1 轉到您的項目文件夾 選擇項目而不是 Android 視圖。 默認情況下，我在 Android Studio 的左角找到了它。 --> MyProject --> app --> build --> dokka --> app 在那里你會找到index.html 。 右鍵單擊並選擇“在瀏覽器中打開”。

項目視圖中的 index.html

Answer 2

因此，當我遇到這個問題時，例如我正在閱讀的示例，並沒有具體說明將dokka依賴項放在dokka 。 一旦我想通了這些，項目就會編譯並構建：

build.gradle（項目級文件）：

buildscript {
    ext.kotlin_version = '1.2.51'
    ext.kotlin_version = '1.2.30'
    ext.dokka_version = '0.9.17'
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.1.3'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:$dokka_version"
    }
}

allprojects {
    repositories {
        google()
        jcenter()
    }
}

build.gradle（模塊級文件）：

apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'org.jetbrains.dokka-android'

android {
    compileSdkVersion 27

    defaultConfig {
        minSdkVersion 23
        targetSdkVersion 27
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
...

    dokka {
        outputFormat = 'javadoc'
        outputDirectory = "$buildDir/javadoc"
    }
}

Answer 3

在 Android 代碼上運行 Dokka 時，您需要使用特定於 Android 的插件版本，而不是獨立的 Gradle 形式：

應用插件：'org.jetbrains.dokka-android'

和

類路徑“org.jetbrains.dokka:dokka-android-gradle-plugin:${versions.dokka}”

正如 Dokka GitHub 頁面的 Android 部分所指出的那樣。

Answer 4

運行 android apply plugin: 'org.jetbrains.dokka-android'
結果是未找到 ID 為“org.jetbrains.dokka-android”的插件。

所以更改為org.jetbrains.dokka是有效的

Answer 5

您可以在沒有 Dokka 插件的情況下生成 Dokka 文檔...使用EasyDokkaPlugin

在您希望生成文檔的每個子模塊的build.gradle末尾添加以下內容：

apply from: 'https://raw.github.com/Vorlonsoft/EasyDokkaPlugin/master/dokka.gradle'

您現在可以通過 Dokka 文檔引擎以 Javadoc 格式生成文檔：

$ gradle dokkaJavadocsJar