Kotlin Gradle DSL을 사용하여 Dokka로 멀티 모듈 프로젝트 문서화

제목대로입니다.

환경

OS: Mac OS X 11.4 aarch64
CPU: Apple M1
Java: OpenJDK Runtime Environment Zulu16.30+19-CA (build 16.0.1+9)
Gradle: Gradle 7.0
Dokka: 1.5.0

build.gradle.kts

Using the Gradle plugin #Multiplatform - Dokka

Multi-module projects¶

For documenting Gradle multi-module projects, you can use dokka${format}Multimodule tasks.

tasks.dokkaHtmlMultiModule.configure {
outputDirectory.set(buildDir.resolve("dokkaCustomMultiModuleOutput"))
documentationFileName.set("README.md")
}
DokkaMultiModule depends on all Dokka tasks in the subprojects, runs them, and creates a toplevel page (based on the documentationFile) with links to all generated (sub)documentations

와 같이 dokka${format}MutliModule 작업을 변경합니다.
Module의 M이 소문자로 되어 있는 것은 아마 타이포일 것입니다. 정확하게는 MultiModule입니다.

모든 하위 프로젝트에 Dokka 플러그인을 적용해야합니다.

문서를 HTML로 출력하는 예입니다.

build.gradle.kts

group = "com.uramnoil"
version = "0.0.1"

buildscript {
    repositories {
        mavenCentral()
    }
}

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

allprojects {
    repositories {
        mavenCentral()
    }
}

subprojects {
    plugins.apply("org.jetbrains.dokka")
}

tasks.getByName<org.jetbrains.dokka.gradle.DokkaMultiModuleTask>("dokkaHtmlMultiModule") {
    outputDirectory.set(buildDir.resolve("dokkaHtmlMultiModuleOutput"))
}

subprojects 블록에서 모든 서브 프로젝트에 dokka 플러그인을 적용한 후,dokkaHtmlMultiModule 작업 설정을 변경합니다.

결과

./gradlew dokkaHtmlMultiModuel를 실행하면,dokkaHtmlMultiModuel 작업에서 설정한 출력 폴더에 문서가 생성됩니다.

이 프로젝트에서 문서를 생성하면 톱 페이지는 다음 이미지와 유사합니다.