Встроенная разметка
Для встроенной разметки KDoc использует обычный синтаксис Markdown , расширенный до
поддержка сокращенного синтаксиса для ссылки на другие элементы в коде.
Связывание с элементами
Для ссылки на другой элемент (класс, метод, свойство или параметр),
просто введите его имя в квадратных скобках:
Для этой цели используйте метод [foo].
Если вы хотите указать пользовательский
для ссылки используйте синтаксис стиля ссылки Markdown:
Используйте [this method][foo] для этой цели. Вы также можете использовать квалифицированные
имена в ссылках. Обратите внимание, что в отличие от JavaDoc, квалифицированные имена всегда
используйте символ точки для разделения компонентов, даже перед методом
Имя:
Используйте [kotlin.reflect.KClass.properties] для перечисления свойств
класс. Имена в ссылках разрешаются с использованием тех же правил, как если бы
имя было использовано внутри документируемого элемента. В частности, это
означает, что если вы импортировали имя в текущий файл, вы
не нужно полностью квалифицировать его, когда вы используете его в комментарии KDoc.
Обратите внимание, что в KDoc нет синтаксиса для разрешения перегруженных
участники в ссылках. Поскольку инструмент генерации документации Kotlin ставит
документация для всех перегрузок функции на одной странице,
определение конкретной перегруженной функции не требуется для
ссылка на работу.