Я пытаюсь использовать плагин Dokka для создания Javadoc для приложения Android Kotlin. Я добавил плагин к своей градиенте:
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.
Как пропустить эти пакеты? Есть ли способ создать док-станцию только для папки my / app / scr / java и файлов, которые я создал? Любая помощь приветствуется.
Версия Dokka 0.9.16 будет содержать исправление для удаления сгенерированных файлов из документации .
В версии 0.9.15 следующая комманда, по-видимому, адресовала сообщение « Подавить вывод android.R и других сгенерированных файлов в dokka-android », но, судя по всему, после создания карты suppresedFiles
с необходимой информацией она не использовалась для фильтрации sourceSets
,
создайте задачу градиента для удаления необходимых «пропущенных» пакетов:
task dokkaJavaDoc(type: org.jetbrains.dokka.gradle.DokkaTask) { outputFormat = 'javadoc' outputDirectory = "$rootDir/docs" } task deleteUnusedDokkaAssets(type: Delete) { file("$rootDir/docs").listFiles().each { if( it.name.contains("android.R" ) ) project.delete it if( it.name.contains("android.support" ) ) project.delete it if( it.name.contains("com.google" ) ) project.delete it if( it.name.contains("com.crashlytics" ) ) project.delete it } }