Javadoc

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

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

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

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

Создание документации Javadoc

Плагин Dokka для Gradle включает формат вывода Javadoc. Необходимо применить соответствующий идентификатор плагина в блоке plugins {} файла build.gradle.kts вашего проекта:

plugins {
    id("org.jetbrains.dokka-javadoc") version "2.2.0"
}

После применения плагина можно запустить следующие задачи:

dokkaGenerate для создания документации во всех доступных форматах в зависимости от применённых плагинов.
dokkaGeneratePublicationJavadoc для создания документации только в формате Javadoc.

Файл javadoc.jar можно создать отдельно. Дополнительные сведения см. в разделе Создание javadoc.jar.

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

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

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

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

С помощью параметров командной строки:

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

С помощью конфигурации JSON:

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

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

18 декабря 2025 г.

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