在Android工作室3中找不到Dokka插件

Question

我试图在我的Kotlin项目中使用dokka插件，但是我得到了以下信息：

错误：(7，0)没有找到id 'org.jetbrains.dokka‘的插件。

我正在使用Android 3.0版本。

提前谢谢。

Answer 1

第一次在Android Studio中使用Dokka与Kotlin

#1.设置

##1.1设置在build.gradle(项目)中

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中(模块: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中的Gradle窗口，在单击"Gradle“窗口后，必须单击Android 3右上角的"Gradle”。-> MyProject -> app ->任务-> DocsByDokka

​

​

Android Studio中的分级窗口

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

#3.找到docs ##3.1转到你的项目文件夹，选择项目而不是安卓视图。我发现默认情况下，这是在Android的左上角。-> 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

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

应用插件：“org.jetbras.dokka-android”

和

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

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