Articles of kotlin dokka

Как создать javadoc jar для загрузки репозитория с помощью dokka?

Недавно я перенесла компонент java в kotlin. До сих пор, когда я использовал плагин релиза maven, он автоматически генерировал javadoc, и он также был загружен на oss.sonatype.com. Dokka, с другой стороны, похоже, не интегрирован с выпуском плагина из коробки. В результате после загрузки на oss.sonatype.com nexus отклоняет выпуск с ошибкой проверки, поскольку отсутствует javadoc jar. […]

Плагин Dokka не найден в студии Android 3

Я пытаюсь использовать плагин dokka в моем проекте Kotlin, но я получаю следующее сообщение: Ошибка: (7, 0) Плагин с id 'org.jetbrains.dokka' не найден. Я использую Android Studio версии 3.0. Заранее спасибо.

Не удается перейти к тегу @sample

В стандартной библиотеке Kotlin у нас есть Preconditions.kt который использует тег @sample : /** * Throws an [IllegalStateException] if the [value] is false. * * @sample samples.misc.Preconditions.failCheckWithLazyMessage */ @kotlin.internal.InlineOnly public inline fun check(value: Boolean): Unit { Можно ли использовать этот тег в IntelliJ? Я хочу увидеть содержимое samples.misc.Preconditions на месте или сделать его доступным. Мне […]

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

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

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

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

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 […]

Dokka javadoc jar не работает с Intellij IDE

У меня есть следующая конфигурация в файле build.gradle: buildscript { ext.dokka_version='0.9.15' repositories { jcenter() } dependencies { classpath "org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version" } } apply plugin: 'org.jetbrains.dokka' task dokkaJavadoc(type: org.jetbrains.dokka.gradle.DokkaTask) { outputFormat = 'javadoc' outputDirectory = "$buildDir/dokkaJavadoc" } task packageJavadoc(type: Jar, dependsOn: 'dokkaJavadoc') { from "$buildDir/dokkaJavadoc" classifier = 'javadoc' } artifacts { archives packageJavadoc } Это создает правильно […]

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

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

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

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

Intereting Posts
Котлин: Разрушение в лямбда-параметрах Realm, инициализируя пустой массив строк, возвращает «Unsupported type java.lang.String » on build RxJava: Отменить подписку async, наблюдаемую из другого асинхронного производства Если isConnected возвращает true, почему Exeption говорит, что он не подключен? Android загружает несколько документов firestore Файл-файл TornadoFX Встроенный сеттер или Нет для создания неиспользуемого сеттера в Котлине? Возможно ли запустить последнюю версию Akka Framework (2.5.2) в Android-проекте? Как я могу создать «статический» метод для перечисления в Котильне? java.lang.NoSuchMethodException при попытке запуска приложения TornadoFX Частичное обновление REST в Spring Boot и Kotlin Использование расширений ресурсов Google для Kotlin с использованием только Maven Плагин Intellij Idea: что вызывает вызов метода для решения ссылки Kotlin Индексный оператор Котлина vs get (0) Аннотации к классам файлов