Javadoc

Формат вывода Javadoc от Dokka похож на формат HTML Javadoc Java.

Он пытается визуально воспроизвести HTML-страницы, генерируемые инструментом Javadoc, но не является непосредственной реализацией или точной копией.

Весь Kotlin-код и сигнатуры отображаются с точки зрения Java. Это достигается с помощью нашего плагина Dokka «Kotlin как Java», который включён и применяется по умолчанию для этого формата.

Формат вывода Javadoc реализован в виде плагина Dokka, и его поддерживает команда Dokka. Он открытый и исходный код можно найти на GitHub.

Генерация документации Javadoc

Плагин Gradle для Dokka включает в себя формат вывода Javadoc. Вы можете использовать следующие задачи:

Задача	Описание
`dokkaJavadoc`	Генерирует документацию Javadoc для одного проекта.
`dokkaJavadocCollector`	Задача `Collector`, созданная только для родительских проектов в многопроектных сборках. Она вызывает `dokkaJavadoc` для каждого подпроекта и объединяет все результаты в один виртуальный проект.

Файл javadoc.jar может быть сгенерирован отдельно. Подробнее см. Создание javadoc.jar.

Плагин Maven для Dokka включает в себя формат вывода Javadoc. Вы можете сгенерировать документацию, используя следующие цели:

Цель	Описание
`dokka:javadoc`	Генерирует документацию в формате Javadoc
`dokka:javadocJar`	Генерирует файл `javadoc.jar`, содержащий документацию в формате Javadoc

Поскольку формат вывода Javadoc является плагином Dokka, вам нужно скачать JAR-файл плагина: JAR-файл.

Для формата вывода Javadoc необходимо предоставить две зависимости в виде дополнительных JAR-файлов:

Через параметры командной строки:

java -jar dokka-cli-1.8.20.jar \
     -pluginsClasspath "./dokka-base-1.8.20.jar;...;./javadoc-plugin-1.8.20.jar" \
     ...

Через конфигурацию JSON:

{
  ...
  "pluginsClasspath": [
    "./dokka-base-1.8.20.jar",
    "...",
    "./kotlin-as-java-plugin-1.8.20.jar",
    "./korte-jvm-3.3.0.jar",
    "./javadoc-plugin-1.8.20.jar"
  ],
  ...
}

Дополнительную информацию см. в документации исполнителя командной строки в разделе Другие форматы вывода.

Последнее изменение: 25 июля 2023 г.

© 2010–2023 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/docs/dokka-javadoc.html