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

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

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

packageOptions {
  prefix = "android"
  suppress = true
}

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

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

kotlin kotlin-dokka

05.10.2018 17:32

Стоит ли изучать PHP в 2026-2027 годах?

Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...

Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией

В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.

Приемы CSS-макетирования - floats и Flexbox

Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...

Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest

В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...

Концепция локализации и ее применение в приложениях React ⚡️

Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...

Пользовательский скаляр GraphQL

Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...

731

Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

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

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

24.01.2019 23:33

Другие вопросы по теме

Как добавить Dokka в проект Android без дополнительного пути к классам в разделе зависимостей?

Сам плагин не может добавлять зависимости buildscript, а затем применять плагин dokka-android

Android Dokka - создавать документы только для моего кода и пропускать все остальное

Как мне использовать несколько исходных путей с помощью dokka fatjar?

Как мне создать вложенный список в Dokka?

Как заставить Dokka создать разворачиваемую вики на github?

Не удалось определить зависимости задачи ':app:dokka'

BuildDir по умолчанию для проектов kotlin

Исключить образцы из документации dokka

Ошибка: несовместимые типы: NonExistentClass не может быть преобразован в аннотацию @error.NonExistentClass()

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

Ответы 1

Другие вопросы по теме

Похожие вопросы