2017-09-07 49 views
5

我正在嘗試使用Dokka插件爲Android Kotlin應用程序生成Javadoc。我加入了插件我gradle這個:Dokka - 跳過爲默認安卓包生成javadoc

classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15" 

然後,我做出以下項目指令的基本配置:

dokka { 
    outputFormat = 'javadoc' 
    outputDirectory = "$rootDir/docs" 
    skipEmptyPackages = true 
    noStdlibLink = true 
} 

我使用基本gradle這個命令生成文檔:

[[email protected] AppDir]$ bash gradlew dokka 

輸出是罰款,但它包含了多個來自Android或插件的目錄,例如我已添加到我的項目中,例如:

android.R 
android.support 
com.google 
com.crashlytics 
. 
. 
. 
etc. 

如何跳過這些軟件包?有什麼方法可以爲我的/ app/scr/java文件夾和我創建的文件生成碼頭嗎?任何幫助表示讚賞。

回答

1

創建gradle這個任務,除去必需的 '跳過' 包:

task dokkaJavaDoc(type: org.jetbrains.dokka.gradle.DokkaTask) { 
    outputFormat = 'javadoc' 
    outputDirectory = "$rootDir/docs" 
} 

task deleteUnusedDokkaAssets(type: Delete) { 
    file("$rootDir/docs").listFiles().each { 
     if(it.name.contains("android.R")) project.delete it 
     if(it.name.contains("android.support")) project.delete it 
     if(it.name.contains("com.google")) project.delete it 
     if(it.name.contains("com.crashlytics")) project.delete it 
    } 
} 
+0

這種方法的問題是,索引引用此文件中的類,所以最終的結果將是一種打破。 –

+0

@ bloque13這不適合我 –