Вопросы по теме 'kdoc'
Как сгенерировать source.jar публичного API AAR с закрытым исходным кодом?
Мы разрабатываем библиотеку с закрытыми исходными кодами на Kotlin, которая выпускается как AAR. К сожалению, наши пользователи не могут видеть KDoc (JavaDoc для Kotlin) в IDE. Поэтому мы хотим выпустить только исходный код общедоступного API....
132 просмотров
schedule
09.09.2021
Как мне наследовать документацию KDoc?
В Javadoc Java есть способ унаследовать документацию метода в подклассе, используя {@inheritDoc} тег .
Есть ли способ сделать то же самое в Kotlin KDoc?
В принципе, я хотел бы сделать следующее:
abstract class Base {
/**
* Some...
3852 просмотров
schedule
31.01.2023
KDoc: вставьте фрагмент кода
Как мне вставить фрагмент кода в KDoc, инструмент документации Kotlin по умолчанию?
В Java я могу использовать следующее:
/**
* Example usage:
*
* <pre>
* <code>@JavaAnnotation
* public void foo() {
* // Code
* }...
5043 просмотров
schedule
08.07.2023
Как добавить форматирование, такое как жирный шрифт, курсив, подчеркивание и т. д., в документацию Kotlin (KDoc)
Я нашел страницу Документирование кода Kotlin в официальном Ссылка на Котлин.
Тем не менее, я не мог найти, как выделить определенные части документации, например, выделить их курсивом или жирным шрифтом.
Я новичок в Kotlin, пришел из Java...
2307 просмотров
schedule
17.09.2023
Как экранировать символы в документации Kotlin Dokka/Kdoc?
Я хочу добавить такой комментарий
/**
* @param scrollFraction In range [0..1].
*/
Но Dokka/Kdoc интерпретирует содержимое в квадратных скобках как ссылку. Это приводит к плохо отображаемым комментариям, когда вы проверяете...
472 просмотров
schedule
18.05.2023
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
Можно ли в документации Kotlin (KDoc) указать конкретный перегруженный метод?
Рассмотрим комментарий класса этого класса Kotlin:
/**
* This class has two methods, one that takes one parameters ([foo]),
* and another one that takes two parameters ([foo]).
**/
class Clazz {
/* Foo with one. */
fun foo(a: Int) {...
466 просмотров
schedule
07.09.2023
Как обеспечить полную документацию по коду Kotlin
Какой плагин или инструмент следует использовать для обеспечения полной документации kdoc в новом коде Kotlin? Java-код проверяется checkstyle с набором правил Sun, для него нужен Kotlin-аналог.
97 просмотров
schedule
17.06.2023
Документация Kotlin: ссылка на методы с разными сигнатурами?
В Java у нас есть что-то вроде этого:
/**
* Link1: {@linkplain java.io.Writer#write(int)}
* Link2: {@linkplain java.io.Writer#write(char[],int,int)}
*/
Нажав на ссылку, перейдите к различным методам.
Я мог бы несколько достичь первой...
24 просмотров
schedule
31.01.2023