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

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

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

При документировании проектов с несколькими проектами необходимо применить плагин Gradle и в подпроектах:

subprojects {
    apply(plugin = "org.jetbrains.dokka")
}

Для генерации документации выполните следующие задачи Gradle:

• dokkaHtml для проектов из одного модуля

• dokkaHtmlMultiModule для проектов с несколькими модулями

По умолчанию, выходной каталог задан как /build/dokka/html и /build/dokka/htmlMultiModule.

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

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

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

При документировании многомодульных проектов, необходимо применить плагин Gradle и в подпроектах:

subprojects {
    apply plugin: 'org.jetbrains.dokka'
}

Для генерации документации выполните следующие задачи Gradle:

• dokkaHtml для проектов из одного модуля

• dokkaHtmlMultiModule для многомодульных проектов

По умолчанию, выходной каталог задан как /build/dokka/html и /build/dokka/htmlMultiModule.

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

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

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

Для генерации документации выполните цель dokka:dokka.

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

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