Описание тега kotlin-dokka
Dokka - это механизм создания документации для языка Kotlin, обрабатывающий комментарии документации в стиле JavaDoc и KDoc.
1
ответ
Kotlin KDoc: документация?
Я видел здесь и там ссылки на KDoc, эквивалент утилиты JavaDoc для Kotlin. Тем не менее, я не могу найти никакой документации о том, как его использовать, не говоря уже о том, как его настроить или интегрировать в Maven или Gradle. Я знаю, что докум…
15 фев '15 в 15:43
1
ответ
Как добавить Dokka в проект Android без дополнительного пути к классам в разделе зависимостей?
Как добавить поддержку движка документации Dokka в проект Android без добавления в раздел зависимостей дополнительного classpath. У меня проблемы с совместимостью... Документация Dokka предлагает следующее, но это classpath нарушает мою сборку.. bui…
05 авг '18 в 10:58
2
ответа
Как сгенерировать javadoc jar для загрузки репозитория с помощью dokka?
Я недавно перенес компонент Java в Kotlin. До сих пор, когда я использовал плагин релиза maven, он автоматически генерировал javadoc и также был загружен на oss.sonatype.com. Dokka, с другой стороны, похоже, не интегрирован с плагином релиза из коро…
06 янв '18 в 12:47
0
ответов
Ошибка: несовместимые типы: NonExistentClass не может быть преобразован в Аннотация @error.NonExistentClass()
Я пытаюсь создать Doka документы моего проекта. Во время генерации я получаю ошибку, как указано выше. Я искал так много, но не смог найти решение этой проблемы. Я также прошел по этой ссылке. Здесь говорится, что это может быть проблема, связанная …
28 фев '19 в 06:43
1
ответ
Докка использует полные имена классов
Я использую Dokka для автоматического создания Java doc для меня. Хотя, когда он встречает любой класс не из моего проекта, он использует полностью определенные имена. Можно ли использовать только имена классов и заставить dokka предоставить ссылку …
08 май '17 в 18:50
0
ответов
Аннотации KDoc не отображаются в Dokka, сгенерированном HTML
В настоящее время я тестирую документацию Dokka, и некоторые сделанные мной аннотации не отображаются. Вот мои выводы: Классы не показывают @sampleи HTML-теги <p></p>, <h1></h1>: Увидеть SimpleCalculator документация по класс…
04 янв '18 в 14:40
4
ответа
Не удается получить докку для создания документации kotlin в проекте gradle/android
Я следую за разделом плагинов Gradle в https://github.com/Kotlin/dokka. Я также попробовал пример dokka-gradle-example в https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-example. Версии, которые я использую: android: '23.…
18 фев '16 в 00:11
3
ответа
Плагин Dokka не найден в Android Studio 3
Я пытаюсь использовать плагин dokka в своем проекте Kotlin, но получаю следующее сообщение: Ошибка:(7, 0) Плагин с идентификатором 'org.jetbrains.dokka' не найден. Я использую Android Studio версии 3.0. Заранее спасибо.
07 ноя '17 в 21:42
2
ответа
Dokka - пропустить генерацию Javadoc для пакетов Android по умолчанию
Я пытаюсь использовать плагин Dokka для генерации Javadoc для Android приложения Kotlin. Я добавил плагин в свой Gradle: classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15" Затем я сделал базовую конфигурацию, следуя инструкциям проекта: dokk…
07 сен '17 в 14:33
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
2
ответа
Как я могу подавить документацию Dokka для определенных классов?
Я пытаюсь сгенерировать хорошие документы API для библиотеки, над которой я работаю, и я не нашел способа удержать Dokka от создания пустых страниц документации для сгенерированного кода, такого как R класс в моей посылке. Я уже использую packageOpt…
05 окт '18 в 15:32
2
ответа
Генерация KDOC и смотреть в браузере
Я не знаю, как смотреть сгенерированный kdoc в моем браузере. Я разрабатываю для Android с Kotlin и добавил докку в качестве зависимости в Gradle.Новый dokka Задача выполняется без ошибок. Я добавил докку в качестве зависимости в моих проектах build…
27 мар '17 в 12:24
1
ответ
Где / Как добавить документацию для пакетов Kotlin?
В Java, если вы хотите документировать пакет, он должен быть помещен в файл package-info.class. Это то же самое с Kotlin и KDoc? Я просмотрел некоторые источники Kotlin и не могу найти, где написана их документация к пакету.
04 фев '16 в 21:58
2
ответа
Сам плагин не может добавить зависимости buildscript и затем применить плагин dokka-android
Мы создали плагин GradleMavenPush, который выполняет загрузку артефактов (артефакты Gradle Android, артефакты Gradle Java и артефакты Gradle Kotlin) в репозитории Maven (JCenter, Maven Central, корпоративные серверы промежуточных / моментальных сним…
25 июл '18 в 06:31
0
ответов
Не удается перейти к тегу @sample
В стандартной библиотеке Kotlin у нас есть Preconditions.kt который использует @sample тег: /** * Throws an [IllegalStateException] if the [value] is false. * * @sample samples.misc.Preconditions.failCheckWithLazyMessage */ @kotlin.internal.InlineOn…
19 дек '17 в 14:46
2
ответа
Как сделать вложенный список в Dokka?
Попытка задокументировать некоторый код Kotlin с довольно обычной структурой: Нумерованный список.С маркированным подсписком. Где цифры продолжают правильно на верхнем уровне списка. То, что я считаю официальной страницей Dokka, даже не имеет слова …
14 мар '18 в 20:26
0
ответов
Ссылочный тест Spek в документации Kotlin
Я работаю со структурой тестирования kotlin Spek и хочу указать ссылку на Spec в моей документации. Но при ссылке на Spec IntelliJ показывает мне, что не находит Spec. Это понятно, потому что Spec находится в тестовом корне. Но есть ли способ сделат…
27 май '18 в 08:42
2
ответа
Как мне использовать несколько исходных путей с Fatjar Dokka?
Я использую Dokka для генерации кода для многомодульного проекта. Я успешно смог сгенерировать документацию для одного модуля с его Cli Fatjar, но модуль зависит от другого. Позвольте мне отметить, что единственное различие между командами процессов…
25 май '18 в 21:46
0
ответов
Kotlin Dokka - Ошибка при загрузке списка пакетов
Я пытаюсь сгенерировать документацию из своего проекта Kotlin, используя Dokka. Я использую версию 0.9.17. Вот моя конфигурация gradle: dokka { includes = ['../README.md'] outputFormat = 'html' outputDirectory = "$buildDir/outputs/doc" // Use to inc…
28 авг '18 в 14:23
0
ответов
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' ta…
11 сен '17 в 09:11