Articles of документация

Подавить жалобы Dokka о «Нет документации для com.foo.Bar $ toString ()»?

Я использую плагин Gradle Dokka версии 0.9.16-eap-1 для создания документации для некоторого кода Kotlin. Я не являюсь человеком с разбитыми окнами и, следовательно, немного расстроен тем, что плагин генерирует тонну сообщений для классов, для которых я явно не документировал переопределенный метод, который адекватно документирован в базовом классе, например : package com.foo /** * A silly […]

Kotlin Dokka – Не удается найти задачу Dokka в андроид-студии

Я новичок в Котлине и Докке; Следуя wikis и учебным пособиям, я попытался настроить мой проект для документа документации dokka со следующими строками в файлах построения градиента: В файле проекта gradle: classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.15" В файле модуля gradle: apply plugin: 'org.jetbrains.dokka-android' Версия для Android версии 2.3.3 После синхронизации, перезагрузки проекта и перезагрузки студии Android я ожидал, […]

Документирование параметров параметра функции в Котлине

Предположим, у меня есть функция более высокого порядка, которая регистрирует какой-то прослушиватель кликов. Я могу документировать его назначение и параметр listener который передается так: /** * Adds a [listener] that's called when the item is clicked. * * @param listener The listener to add */ fun addClickListener(listener: (count: Int) -> Unit) { … } Мой […]

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

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

KDoc: Вставить фрагмент кода

Как вставить фрагмент кода в KDoc, инструмент документации по умолчанию Kotlin? В Java я могу использовать следующее: /** * Example usage: * * <pre> * <code>@JavaAnnotation * public void foo() { * // Code * } * </code> * </pre> */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface JavaAnnotation {} Кажется, что нет никакого эквивалента в Котлине. Я […]