如何生成包含javadoc的Android * .jar庫？

Question

我正在爲Android Studio和Android Studio合作開發一個庫項目。該項目包含一個javadoc，但是當我使用Gradle構建一個jar文件並在另一個項目中使用該庫時，我無法訪問該文檔。

生成html javadoc是可能的，但不是很方便。我希望將文檔放在jar文件中（這些文檔將發送給其他用戶）以直接查看它，例如，在代碼上使用Android Studio鼠標懸停功能。

有沒有辦法將javadoc包含到生成的jar文件中？

Answer 1

無法從編譯的jar中獲取源代碼或javadoc。

但是，像gradle和maven這樣的構建系統支持附加的jar：如果您將工件上傳到例如Maven中央，只需將一個附加罐子與一個-sources或-javadoc後綴與各自的內容並行到主jar。

產生這些罐子，請使用以下任務的gradle

task sourcesJar(type: Jar) { 
    from android.sourceSets.main.java.srcDirs 
    classifier = 'sources' 
} 

task javadoc(type: Javadoc) { 
    source = android.sourceSets.main.java.srcDirs 
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator)) 
    failOnError false 
} 

task javadocJar(type: Jar, dependsOn: javadoc) { 
    classifier = 'javadoc' 
    from javadoc.destinationDir 
}