Javadoc

DANGER

Javadoc 출력 형식은 아직 알파 단계이므로, 사용 시 버그를 발견하고 마이그레이션 문제를 겪을 수 있습니다.

Java의 Javadoc HTML을 입력으로 받아들이는 도구와의 성공적인 통합은 보장되지 않습니다.

사용에 대한 모든 책임은 사용자에게 있습니다.

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

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

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

Javadoc 출력 형식은 Dokka 플러그인으로 구현되었으며, Dokka 팀이 관리합니다. 이는 오픈 소스이며, 소스 코드는 GitHub에서 확인할 수 있습니다.

Javadoc 문서 생성

DANGER

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

CLI

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