android - 在 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”后会打开一个窗口。--> MyProject --> 应用程序 --> 任务 --> DocsByDokka

Android Studio 中的 Gradle-Window

##2.3 生成文档 在 Gradle 窗口中双击 DocsByDokka。

#3。查找文档 ##3.1 转到您的项目文件夹 选择项目而不是 Android 视图。我默认在 Android Studio 的左角找到它。--> MyProject --> app --> build --> dokka --> app 在那里你会找到index.html。右键单击并选择“在浏览器中打开”。

Answer 2

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

运行 androidapply plugin: 'org.jetbrains.dokka-android'
结果是找不到 ID 为“org.jetbrains.dokka-android”的插件。

所以更改org.jetbrains.dokka为有效

Answer 4

在 Android 代码上运行 Dokka 时，您需要使用特定于 Android 的插件版本，而不是独立的 Gradle 形式：

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

和

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

正如 Dokka GitHub 页面的 Android 部分所指出的那样。

Answer 5

您可以在没有 Dokka 插件的情况下生成 Dokka 文档...使用EasyDokkaPlugin

build.gradle在您希望生成文档的每个子模块的末尾添加以下内容：

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

您现在可以通过 Dokka 文档引擎生成 Javadoc 格式的文档：

$ gradle dokkaJavadocsJar