Javadoc

Javadoc 출력 형식은 아직 알파(Alpha) 버전이므로, 사용 시 버그가 발생하거나 마이그레이션 문제가 발생할 수 있습니다. Java의 Javadoc HTML을 입력으로 받는 도구와의 성공적인 통합은 보장되지 않습니다. 사용에 따른 모든 위험은 사용자 본인에게 있습니다.

Dokka의 Javadoc 출력 형식은 Java의 Javadoc HTML 형식과 유사합니다.

Javadoc 도구로 생성된 HTML 페이지를 시각적으로 모방하려 하지만, 직접적인 구현이나 정확한 복사본은 아닙니다.

모든 Kotlin 코드와 시그니처는 Java의 관점에서 렌더링됩니다. 이는 이 형식에 기본으로 번들되어 적용되는 Kotlin as Java Dokka 플러그인을 통해 이루어집니다.

Javadoc 출력 형식은 Dokka 플러그인으로 구현되며, Dokka 팀에서 유지보수합니다. 이것은 오픈 소스이며, 소스 코드는 GitHub에서 찾을 수 있습니다.

Javadoc 문서 생성

Javadoc 형식은 멀티플랫폼 프로젝트를 지원하지 않습니다.

GradleMavenCLI

Dokka용 Gradle 플러그인에는 Javadoc 출력 형식이 포함되어 있습니다. 다음 작업을 사용할 수 있습니다:

작업	설명
dokkaJavadoc	단일 프로젝트에 대한 Javadoc 문서를 생성합니다.
dokkaJavadocCollector	멀티 프로젝트 빌드에서 부모 프로젝트에 대해서만 생성되는 Collector 작업입니다. 이 작업은 모든 서브프로젝트에 대해 dokkaJavadoc를 호출하고 모든 출력을 단일 가상 프로젝트로 병합합니다.

javadoc.jar 파일은 별도로 생성할 수 있습니다. 자세한 내용은 javadoc.jar 빌드를 참조하세요.

Dokka용 Maven 플러그인에는 Javadoc 출력 형식이 내장되어 있습니다. 다음 목표(goal)를 사용하여 문서를 생성할 수 있습니다:

Goal	설명
dokka:javadoc	Javadoc 형식으로 문서를 생성합니다.
dokka:javadocJar	Javadoc 형식의 문서를 포함하는 javadoc.jar 파일을 생성합니다.

Javadoc 출력 형식은 Dokka 플러그인이므로, 플러그인의 JAR 파일을 다운로드해야 합니다.

Javadoc 출력 형식에는 추가 JAR 파일로 제공해야 하는 두 가지 의존성(dependency)이 있습니다:

• kotlin-as-java plugin
• korte-jvm

명령줄 옵션을 통해:

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

JSON 설정을 통해:

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

자세한 내용은 CLI 러너 문서의 기타 출력 형식을 참조하세요.