Как я могу подавить документацию Dokka для определенных классов?

Question

Я пытаюсь сгенерировать хорошие документы API для библиотеки, над которой я работаю, и я не нашел способа удержать Dokka от создания пустых страниц документации для сгенерированного кода, такого как R класс в моей посылке.

Я уже использую

packageOptions {
  prefix = "android"
  suppress = true
}

подавить документацию на уровне пакета, но есть ли способ предотвратить генерацию документации для определенных классов в пакете, для которого я хочу создать документацию? Или создать белый список классов, чтобы Докка генерировал документы только для этих классов?

Или есть другой генератор документов для Kotlin, который я должен изучить?

Answer 1

Похоже, вы можете указать имена классов, а также префиксы в packageOptions раздел. Вы просто указываете их так же, как и префикс.

packageOptions {
  prefix = "com.fqdn.MyPackage.R"
  suppress = true
}

Answer 2

Один из вариантов - установить желаемые классы какinternal. При этом документация для внутренних не будет генерироваться. Также полезно настроить dokka в файле gradle следующим образом:

          named("main"){
        //sourceRoots.setFrom(file("src/main/java/com/cujo/sb/util"))
        includeNonPublic.set(false)
        skipEmptyPackages.set(true)
        reportUndocumented.set(true)
        skipDeprecated.set(false)
    }