android - 在 Android studio 3 中找不到 Dokka 插件

Question

我正在尝试在我的 Kotlin 项目中使用 dokka 插件，但我收到以下消息:

Error:(7, 0) Plugin with id 'org.jetbrains.dokka' not found.

我使用的是 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

Gradle-Window in Android Studio

##2.3 生成文档在 Gradle-Window 中双击 DocsByDokka。

#3。查找文档##3.1 转到您的项目文件夹选择项目而不是 Android View 。我默认在 Android Studio 的左上角找到它。--> 我的项目 --> 应用程序 --> 构建 --> dokka --> 应用程序您将在那里找到 index.html。右键单击并选择“在浏览器中打开”。