Kotlin 코드 문서화 'Dokka' 사용법

** Dokka는 Kotlin API 문서화를 위한 엔진

     KDoc 주석과 JavaDoc 주석의 이해가 필요하다

 

 

 적용하기

   

   build.gradle.kts   (app/src/build.gradle)

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

 

 

HTML 형식으로 문서 생성  

 

Terminal    (Android Studio - 왼쪽 하단)

./gradlew dokkaHtml

 

 

생성된 문서 열기

 

index.html    (Project > app > build > dokka > html > index.html)

 

 

 

 

참고 사이트:

• https://kotlinlang.org/docs/dokka-gradle.html#build-javadoc-jar

Gradle | Kotlin

• https://blog.protein.tech/document-your-kotlin-android-project-using-dokka-a4129a461203