Начало работы с Dokka

Применение плагина Dokka для Gradle

Примените плагин Dokka для Gradle (DGP) в корневом скрипте сборки проекта:

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

Документирование сборок с несколькими проектами

Чтобы документировать сборки с несколькими проектами, примените плагин к каждому подпроекту, который нужно документировать. Чтобы использовать общую конфигурацию Dokka для подпроектов, выберите один из следующих подходов:

• Плагин соглашений

• Прямая настройка в каждом подпроекте, если вы не используете плагины соглашений

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

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

Чтобы создать документацию, выполните следующую задачу Gradle:

./gradlew :dokkaGenerate

Эта задача работает как для сборок с одним проектом, так и для сборок с несколькими проектами.

Запустите задачу dokkaGenerate из агрегирующего проекта, добавив перед задачей путь к проекту (:). Например:

./gradlew :dokkaGenerate

// OR

./gradlew :aggregatingProject:dokkaGenerate

Не запускайте ./gradlew dokkaGenerate вместо ./gradlew :dokkaGenerate или ./gradlew :aggregatingProject:dokkaGenerate. Если перед задачей не указан путь к проекту (:), Gradle попытается запустить все задачи dokkaGenerate во всей сборке, что может привести к выполнению ненужной работы.

Для создания вывода в формате HTML, Javadoc или в обоих форматах HTML и Javadoc можно использовать разные задачи.

Применение плагина Dokka для Gradle

Примените плагин Dokka для Gradle в корневом скрипте сборки проекта:

plugins {
    id 'org.jetbrains.dokka' version '2.2.0'
}

Документирование сборок с несколькими проектами

Чтобы документировать сборки с несколькими проектами, необходимо применить плагин к каждому подпроекту, который нужно документировать. Чтобы использовать общую конфигурацию Dokka для подпроектов, выберите один из следующих подходов:

• Плагин соглашений

• Прямая настройка в каждом подпроекте, если вы не используете плагины соглашений

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

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

Чтобы создать документацию, выполните следующую задачу Gradle:

./gradlew :dokkaGenerate

Эта задача работает как для сборок с одним проектом, так и для сборок с несколькими проектами.

Запустите задачу dokkaGenerate из агрегирующего проекта, добавив перед задачей путь к проекту. Например:

./gradlew :dokkaGenerate

// OR

./gradlew :aggregatingProject:dokkaGenerate

Не запускайте ./gradlew dokkaGenerate вместо ./gradlew :dokkaGenerate или ./gradlew :aggregatingProject:dokkaGenerate. Если перед задачей не указан путь к проекту (:), Gradle попытается запустить все задачи dokkaGenerate во всей сборке, что может привести к выполнению ненужной работы.

Для создания вывода в формате HTML, Javadoc или в обоих форматах HTML и Javadoc можно использовать разные задачи.

Добавьте плагин Dokka для Maven в раздел plugins файла POM:

<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.dokka</groupId>
            <artifactId>dokka-maven-plugin</artifactId>
            <version>2.2.0</version>
            <executions>
                <execution>
                    <phase>pre-site</phase>
                    <goals>
                        <goal>dokka</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Чтобы создать документацию, выполните цель dokka:dokka.

По умолчанию выходной каталог — target/dokka.

Дополнительную информацию об использовании Dokka с Maven см. в разделе Maven.