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

Question

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

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

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

Answer 1

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

然而，像gradle和maven這樣的構建系統支持額外的jar：如果你將工件上傳到例如Maven central，只需添加一個-sources或-javadoc后綴的jar，其中相應的內容與主jar並行。

要生成這些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
}