Articles of kdoc

Markdown # против нескольких #

Я заметил, что использование # или ## или #### эквивалентно … всегда будет так? Я хочу использовать только «#» иногда, потому что это более удобно, если в будущем он не станет намного большим текстом. Я не уверен, относится ли это к сгенерированной документации, так как я не знаю, как ее генерировать, я только нашел команды […]

KDoc Аннотации, не отображаемые в Dokka, генерируются HTML

В настоящее время я тестирую документацию Dokka, и некоторые из аннотаций, которые я сделал, не отображаются. Вот мои выводы: В классах не отображаются @sample и html <p></p> , <h1></h1> : см. SimpleCalculator класса SimpleCalculator Если описание находилось под тегом html, оно не будет отображаться: см. Документацию кода enum class OPERATOR Методы вообще не отображают @sample […]

kotlin неразрешенная ссылка KDoc, но IntelliJ не любит импорт, который его исправляет

import abc.MyClass.MyEnum; /// from Java /** * [MyClass.MyEnum] */ class efg () : MyClass.MyEnum { return MyClass.MyEnum.BiGNUMBER; } У меня есть что-то похожее на вышесказанное в IntelliJ … но оно будет идентифицировать импорт как неиспользованный – так что оптимизация импорта удалит его … однако, если я не буду вставлять этот импорт вручную, то в моих […]

Dokka использует полностью квалифицированные имена классов

Я использую dokka для автоматического создания javadoc для меня. Хотя, когда он встречает какой-либо класс не из моего проекта, он использует полностью квалифицированные имена. Можно ли использовать только имена классов и сделать dokka для этого ссылкой? Например: java.lang.String getName() Я бы хотел вместо java.lang.String иметь String со ссылкой на Java doc Моя конфигурация градиента: ext.simpleName […]

Как связать со статическим членом класса Java в KDoc?

В KDoc вы можете сделать это: /** * [Integer.equals] is an instance method. */ Но вы не можете этого сделать: /** * [Integer.signum] is a static method. */ «Вы не можете», я имею в виду, что IntelliJ IDEA не приведет вас к объявлению статического члена, если вы используете Navigate → Действие объявления на нем. Переход […]

Где / Как вы добавляете документацию для пакетов Kotlin?

В Java, если вы хотите документировать пакет, его нужно поместить в файл package-info.class. Это то же самое с Котлином и KDoc? Я просмотрел некоторые источники из Kotlin и не могу найти, где написана их документация по пакетам.

Какое правильное название для встроенной документации Kotlin?

Поскольку механизм генерации документации KDoc заброшен в пользу Dokka , следует ли упоминать документацию Kotlin как «комментарии KDoc» или как «комментарии Dokka»?

Копирование документов KDoc с одного метода на другой

Для двух приведенных методов: /** * Adds a [DataItem] to the Android Wear network. The updated item is synchronized across all devices. */ fun putItem(){ …. } /** * "same KDOC here with above" */ fun putItem(putRequest: PutDataRequest){ …. } Есть ли возможность скопировать / связать документы второго метода с тем же самым с первым? […]

Kotlin KDoc: Документация?

Я видел здесь , кое- где ссылки на KDoc, эквивалент утилиты JavaDoc для Kotlin. Однако я не могу найти документацию о том, как ее использовать, не говоря уже о том, как ее настроить или интегрировать в Maven или Gradle. Я знаю, что документ Kotlin API создается с помощью KDoc, поскольку исходный код страницы имеет следующий […]

Как использовать @link и @code в kotlin kDoc

Я пытаюсь документировать метод и пытаюсь использовать @link и @code как в JavaDoc . Я знаю, что в kotlin есть kDoc, но я не могу найти их или, по крайней мере, что-то подобное.