在Android studio 3中找不到Dokka插件

Question

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

  

错误：（7,0）找不到ID为'org.jetbrains.dokka'的插件。

我正在使用Android Studio 3.0版。

提前致谢。

Answer 1

因此，当我遇到这个问题时，例如我正在阅读的示例，没有确切说明放置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 2

首次在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中单击右上角的“渐变” 单击“渐变”后，将打开一个窗口。 -> MyProject->应用程序->任务-> DocsByDokka

Gradle-Window in Android Studio

2.3生成文档

在Gradle窗口中双击DocsByDokka。

3。查找文档

3.1转到项目文件夹

选择“项目”而不是“ Android”视图。我默认在Android Studio的左上角找到它。 -> MyProject->应用程序->构建-> dokka->应用程序 在这里您将找到index.html。右键单击并选择“在浏览器中打开”。

index.html in project view

Answer 3

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

  

申请插件：'org.jetbrains.dokka-android'

和

  

classpath“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