Плагин Dokka не найден в Android Studio 3

Я пытаюсь использовать плагин dokka в своем проекте Kotlin, но получаю следующее сообщение:

Ошибка:(7, 0) Плагин с идентификатором 'org.jetbrains.dokka' не найден.

Я использую Android Studio версии 3.0.

Заранее спасибо.

Источник

3 ответа

Первое использование Dokka с Kotlin в Android Studio

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 Перейдите в окно Gradle в Android Studio

Я должен нажать "Gradle" в правом верхнем углу в Android Studio 3. После нажатия "Gradle" открывается окно. -> MyProject -> приложение -> Задачи -> DocsByDokka

Окно Gradle в Android Studio

2.3. Создание документов

Дважды щелкните DocsByDokka в окне Gradle.

3. Найдите документы.

3.1 Перейдите в папку проекта

Выберите проект, а не представление Android. Я нахожу это по умолчанию в левом углу Android Studio. -> MyProject -> app -> build -> dokka -> app Там вы найдетеindex.html. Щелкните правой кнопкой мыши и выберите "Открыть в браузере".

index.html в представлении проекта

Источник

Поэтому, когда я столкнулся с проблемой, пример, который я читал, не указал точно, где поставить 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"
    }
}
Источник

Когда работает андроид apply plugin: 'org.jetbrains.dokka-android'
Результатом является плагин с идентификатором "org.jetbrains.dokka-android" не найден.

так что поменяйте на org.jetbrains.dokka работает

Источник

При запуске Dokka для кода Android необходимо использовать версии плагина, специфичные для Android, вместо автономных форм Gradle:

применить плагин: 'org.jetbrains.dokka-android'

а также

classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:${versions.dokka}"

как указано в разделе Android на странице Dokka GitHub.

Источник

Вы можете создать документацию Dokka без плагина Dokka... Используйте EasyDokkaPlugin

Добавьте следующее в конце build.gradle каждого подмодуля, который вы хотите сгенерировать документацию:

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

Теперь вы можете создавать документацию с помощью движка документации Dokka в формате Javadoc:

$ gradle dokkaJavadocsJar
Источник
Другие вопросы по тегам