Описание тега kdoc

Описание тега Вопросы с тегом
KDoc - это система генерации документации, которая считывает специально отформатированные комментарии в исходном коде Kotlin и генерирует скомпилированную документацию. Обычно он используется для создания документации API в виде веб-страниц HTML.
1 ответ

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

Я видел здесь и там ссылки на KDoc, эквивалент утилиты JavaDoc для Kotlin. Тем не менее, я не могу найти никакой документации о том, как его использовать, не говоря уже о том, как его настроить или интегрировать в Maven или Gradle. Я знаю, что докум…
15 фев '15 в 15:43
1 ответ

Документация Kotlin не поддерживает такие теги, как<p>

Я пишу комментарии к документу, чтобы описать метод. /** * &lt;p&gt;necessary * &lt;p&gt;setType is to set the PendingIntend's request code&lt;/p&gt; */ Но это не покажет параграфы. Если я не использую &lt;p&gt;Вся документация в строке без перерыва…
06 янв '16 в 11:29
0 ответов

Документирование кода Kotlin: как создать таблицу?

Я прочитал эту статью о документировании кода Kotlin, а также эту статью. Я попробовал этот код: /** * | First Header | Second Header | * | ------------- | ------------- | * | Content Cell | Content Cell | * | Content Cell | Content Cell | */ И это:…
22 дек '18 в 10:32
1 ответ

Как мне наследовать документацию KDoc в классе Java?

У меня есть классы Kotlin с KDoc, например: abstract class Something { /** # Documentation */ abstract fun someFun() } Этот класс расширен классами Kotlin и Java. KDoc правильно наследуется классами Kotlin. KDoc отображается при нажатии Ctrl+Q в Int…
30 янв '19 в 15:11
1 ответ

Докка использует полные имена классов

Я использую Dokka для автоматического создания Java doc для меня. Хотя, когда он встречает любой класс не из моего проекта, он использует полностью определенные имена. Можно ли использовать только имена классов и заставить dokka предоставить ссылку …
08 май '17 в 18:50
1 ответ

Как документировать атрибуты в классе данных Kotlin?

Где мне разместить Javadoc для атрибутов в классе данных Kotlin? Другими словами, как написать в Kotlin следующий код Java: /** * Represents a person. */ public class Person { /** * First name. -- where to place this documentation in Kotlin? */ priv…
05 апр '18 в 14:31
0 ответов

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

В настоящее время я тестирую документацию Dokka, и некоторые сделанные мной аннотации не отображаются. Вот мои выводы: Классы не показывают @sampleи HTML-теги &lt;p&gt;&lt;/p&gt;, &lt;h1&gt;&lt;/h1&gt;: Увидеть SimpleCalculator документация по класс…
04 янв '18 в 14:40
0 ответов

Как задокументировать аргумент по умолчанию с помощью KDoc

Есть ли синтаксис для документирования аргументов по умолчанию с помощью KDoc, или я должен сделать это вручную? /** * A group of *members*. * * This class has no useful logic; it's just a documentation example. * * @property name the name of this g…
27 ноя '18 в 17:46
3 ответа

Разрыв строки, новая строка в KDoc

Предполагая, что у нас есть такая задокументированная строка /** retrieve a state of the service * &lt;br/&gt; HTTP code 200 - normal state * &lt;br/&gt; HTTP code 403 - some recoverable state: const val SERVICE_STATE = "servicestate" */ Есть нескол…
29 мар '18 в 14:38
1 ответ

Kotlin - @hide эквивалент Javadoc

Я пытаюсь скрыть метод, который должен быть виден только для тестового использования. Есть ли эквивалент для Javadoc? @hide Я не эксперт по использованию KDoc и JavaDoc. Если мне не хватает какой-либо концепции, укажите мне на это. /** @hide */ fun …
17 янв '18 в 17:09
2 ответа

Где разместить документацию для файла Kotlin (не пакет, не модуль, не класс)

Где я должен оставить комментарий о исходном файле Kotlin? Классы и другие объекты имеют KDoc: /** * Summary * * Rest of documentation goes here. */ class A { ... } Но куда мне положить что-то подобное? // This file contains constants shared between…
07 окт '18 в 06:08
1 ответ

Котлин: Документация для правообладателя

Я пишу библиотеку Котлина. В одном из классов у меня есть следующее: class SessionWrapper { /** * The time in milliseconds after which the session will expire. */ var expiryTime = DEFAULT_EXPIRY_TIME get() { mainThreadCheck() return field } set(valu…
16 апр '18 в 08:47
2 ответа

Как мне пропустить строку в kDoc

В моем kDoc я хочу пустую строку между абзацами. Как мне это сделать? (Также есть где-нибудь полное руководство? Например, как создавать таблицы, маркеры и т. Д.?)
31 окт '18 в 16:34
1 ответ

Генерация шаблонов документов котлин

Работая раньше в Android Studio, если перед функцией я поставил / ** и нажал ввод, то я автоматически сгенерировал следующий документ с аннотациями для описания параметров, возвращаемого значения и т. Д. /** * @params a * @return */ int f(int a) { r…
03 фев '18 в 22:18
1 ответ

Котлин: Как я могу ссылаться на метод в kDoc, используя @see?

Я использовал для ссылки на методы в Java Doc следующим образом: /** * @see com.myapp.view.fragment.PlaybackControlFragment#onPlaybackStateChanged */ Я не знаю, как ссылаться на тот же метод в kotlin? Часть com.myapp.view.fragment.PlaybackControlFra…
23 окт '18 в 11:15
1 ответ

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

В Kotlin v1.1+ есть возможность объявления псевдонимов типов , которые предоставляют альтернативные имена для существующих типов. Это особенно полезно для типов функций - например: typealias OnItemClick = (view: View, position: Int) -&gt; Boolean И …
10 мар '18 в 15:00
1 ответ

Как сгенерировать source.jar публичного API AAR с закрытым исходным кодом?

Мы разрабатываем библиотеку закрытых источников в Котлине, которая выпускается как AAR. К сожалению, наши пользователи не могут видеть KDoc (JavaDoc для Kotlin) в IDE. Поэтому мы хотим опубликовать только исходный код открытого API. Внутренние компо…
24 янв '19 в 09:54
1 ответ

Копировать документы 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){ .... } Ест…
12 мар '16 в 10:33
1 ответ

Таблицы в KDoc?

У нас обычно есть журнал изменений в нашем Java DTO, который состоит из таблицы, определенной в Javadoc: /** * Changelog: * * &lt;table&gt; * &lt;tr&gt;&lt;th&gt;Version&lt;/th&gt;&lt;th&gt;Description&lt;/th&gt;&lt;/tr&gt; * &lt;tr&gt; * &lt;td&gt;…
28 апр '18 в 08:02
1 ответ

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

В Java, если вы хотите документировать пакет, он должен быть помещен в файл package-info.class. Это то же самое с Kotlin и KDoc? Я просмотрел некоторые источники Kotlin и не могу найти, где написана их документация к пакету.
04 фев '16 в 21:58