如何生成包含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
}