Dokka - пропустить генерацию Javadoc для пакетов Android по умолчанию

Question

Я пытаюсь использовать плагин Dokka для генерации Javadoc для Android приложения Kotlin. Я добавил плагин в свой Gradle:

classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15"

Затем я сделал базовую конфигурацию, следуя инструкциям проекта:

dokka {
    outputFormat = 'javadoc'
    outputDirectory = "$rootDir/docs"
    skipEmptyPackages = true
    noStdlibLink = true
}

Я генерирую документацию, используя базовую команду gradle:

[user@linux AppDir]$ bash gradlew dokka

Вывод в порядке, но он включает в себя несколько каталогов от Android или плагинов, которые я добавил в свой проект, например:

android.R
android.support
com.google
com.crashlytics
.
.
.
etc.

Как мне пропустить эти пакеты? Есть ли способ создать док только для моей папки /app/scr/java и файлов, которые я создал? Любая помощь приветствуется.

Answer 1

Dokka версии 0.9.16 будет содержать исправление для удаления сгенерированных файлов из документации.

В версии 0.9.15 следующий коммит, по-видимому, решал проблему " Подавить вывод android.R и других сгенерированных вещей в dokka-android", но, видимо, после создания suppresedFiles карта с необходимой информацией, она не использовалась для фильтрации sourceSets,

---

ОБНОВЛЕНИЕ: Dokka 0.9.16 была выпущена с исправлением, среди других улучшений.

# 224 Отфильтрованы сгенерированные Android классы из документов

Answer 2

Вот рабочий пример с Dokka 0.9.16:

task dokka(overwrite: true, type: org.jetbrains.dokka.gradle.DokkaAndroidTask) {
    outputFormat = 'javadoc'
    outputDirectory = "$buildDir/docs"

    // Do not create index pages for empty packages
    skipEmptyPackages = true

    //Do not output deprecated members. Applies globally, can be overridden by packageOptions
    skipDeprecated = false

    //No default documentation link to kotlin-stdlib
    noStdlibLink = false
}

Если вы используете Android, тогда важен тип: org.jetbrains.dokka.gradle.DokkaAndroidTask

Не DokkaTask но DokkaAndroidTask,

Ура, Пол