Вопросы по теме 'kotlin-dokka'

Ошибка при создании Javadoc Kdoc для проекта Kotlin с использованием Dokka в Android Studio
Я использую плагин Dokka для создания документации для моего проекта kotlin Вот URL-адрес плагина https://github.com/Kotlin/dokka Я выполнил инструкции, вот как выглядит мой Project.gradle buildscript { ext.kotlin_version =...
1022 просмотров

Исключить образцы из документации dokka
Я указал каталог образцов dokka на мои исходники тестов, чтобы я мог сослаться на методы тестирования с @sample в моей документации и иметь проверенные примеры. Это работает, за исключением того, что теперь dokka также генерирует документацию для...
205 просмотров
schedule 22.09.2022

Gradle Dokka снова отказывается работать
Структура моего проекта состоит из нескольких модулей, каждый модуль имеет одинаковые задачи dokka. Плагин gradle dokka дает мне очень странные результаты: Во-первых, часто нужны какие-то артефакты моей сборки, вроде других файлов modules.jar,...
24 просмотров
schedule 20.09.2022

Как мне наследовать документацию KDoc?
В Javadoc Java есть способ унаследовать документацию метода в подклассе, используя {@inheritDoc} тег . Есть ли способ сделать то же самое в Kotlin KDoc? В принципе, я хотел бы сделать следующее: abstract class Base { /** * Some...
3852 просмотров
schedule 31.01.2023

Подавить жалобы Dokka на отсутствие документации для com.foo.Bar$toString()?
Я использую плагин Gradle Dokka версии 0.9.16-eap-1 для создания документации для некоторого кода Kotlin. Я не сторонник сломанных окон и, следовательно, немного разочарован тем, что плагин генерирует массу сообщений для классов, для которых я явно...
916 просмотров

Как экранировать символы в документации Kotlin Dokka/Kdoc?
Я хочу добавить такой комментарий /** * @param scrollFraction In range [0..1]. */ Но Dokka/Kdoc интерпретирует содержимое в квадратных скобках как ссылку. Это приводит к плохо отображаемым комментариям, когда вы проверяете...
472 просмотров
schedule 18.05.2023

Потребителю библиотечного модуля Android необходимо добавить зависимости пути к классам
У меня есть приложение для Android (модуль app ) и модуль библиотеки Android (модуль lib ), каждый из которых является отдельным проектом Android Studio, но проект приложения добавил lib в качестве зависимости модуля в своем проекте. lib...
374 просмотров

KDoc: порядок изменения параметров
У меня есть следующие параметры в сопутствующем объекте на Kotlin companion object Constants { /** * Values for the various type of connection that a device can have. */ const val CONNECTION_KEY = "Connection_type"...
57 просмотров
schedule 21.06.2023

Готовые примеры документации, созданной с помощью Dokka?
В официальной документации по Dokka говорится, что Dokka может выводить результат в разных форматах. : Выходные форматы html - минималистичный формат html, используемый по умолчанию, классы Java переведены на Kotlin javadoc...
608 просмотров
schedule 28.07.2023