[컴] dokka 사용

 dokka / javadoc / kotilin javadoc

dokka 사용

dokka 는 javadoc 처럼 소스에 적힌 comment 를 보고 문서를 만들어 준다.

dokka 는 2가지를 같이 지원한다. 그래서 저것을 다양한 format 의 output 을 만들어준다.(html, javadoc, markdown)

• java file 에 있는 javadoc 주석
• kotlin file 에 있는 KDoc 주석

사용법

2가지 방법으로 사용할 수 있다.

1. 그냥 dokka-cli-1.5.0.jar 이용해서 console 에서 실행하는 방법:
   • 이 방법은 package manager 의 configuration file 에서 잡아주는 설정을 command line 의 option 에 넣어주는 것이라 이해하면 된다.
2. 현재의 project 의 package manager(gradle 또는 maven) 을 이용해서 실행하는 방법

Dokka CLI

• Maven Repository: org.jetbrains.dokka » dokka-cli
• Problems running dokka-cli-1.4.0-rc.jar from the command line - Kotlin Discussions

아래처럼 실행하면 된다. 아래 command 에서도 볼 수 있듯이 .jar file 들이 같이 필요하다. 아래 경로에 가서 download 하자. 이 download 가 귀찮은 것도 있어서 그냥 gradle plugin 등을 이용하는 방법이 더 편할 수 있다.

• dokka-base.jar
• dokka-analysis.jar
• kotlin-analysis-compiler.jar
• kotlin-analysis-intellij.jar
• kotlinx-coroutines-core.jar
• kotlinx-html-jvm.jar

rem windows 10 batch file

set path=%path%;d:\a\apps\java\openjdk-jdk-15.0.1\bin
set srcSet="-src D:\a\prog\kotlin\MyApplication2\app\src"

java -jar dokkalib/dokka-cli-1.5.0.jar -outputDir . -moduleName cfg -sourceSet %srcSet% ^
-pluginsClasspath ^"dokkalib/dokka-analysis-1.5.0.jar;^
dokkalib/dokka-base-1.5.0.jar;^
dokkalib/kotlin-analysis-compiler-1.5.0.jar;^
dokkalib/kotlin-analysis-intellij-1.5.0.jar;^
dokkalib/kotlinx-coroutines-core-1.3.9.jar;^
dokkalib/kotlinx-html-jvm-0.7.3.jar^"

gradle 을 이용한 방법

…

Reference

1. Kotlin/dokka: Documentation Engine for Kotlin
2. Dokka