[ Etc #1 ] KDoc ( Kotlin Document ) with Dokka

 

Dokka 는 Java Document 와 동일한 기능을 수행하는 엔진.

 

Kotlin 과 Java 모두 Document 로 만들 수 있다.

 

 

[ app/build.gradle ]

apply plugin: 'org.jetbrains.dokka-android'

dokka {
    outputFormat = 'html'
    outputDirectory = "$rootDir/javadocs"
    includeNonPublic = true
}

dependencies {
	..
	..
}

 

[ project/build.gradle ]

buildscript {
    ..

    ext.dokka_version = '0.9.18'
    
    dependencies {
    	..
        
        classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:${dokka_version}"
    }
}

 

반응형

 

스튜디오 터미널 이건, OS 자체 터미널 이건간에 상관 없이 해당 프로젝트 폴더 안에서 실행 가능.

 ./gradlew dokka

 

실행 한 후, App Gradle 에서 세팅 한 디렉토리 폴더 outputDirectory = "$rootDir/javadocs"  에 저장됨.