android - 如何使用Javadoc生成Android * .jar库？

Question

我正在使用Android Studio为Android开发图书馆项目。该项目包含一个Javadoc，但是当我使用Gradle构建jar文件并在另一个项目中使用该库时，我无法访问该文档。

可以生成html javadoc，但是不太方便。我想将文档包含在jar文件中(该文件将交付给其他用户)以直接查看，例如在代码上使用Android Studio鼠标悬停功能。

有没有办法将javadoc包含到生成的jar文件中？

Answer 1

无法从已编译的jar中获取源代码或javadoc。

但是诸如gradle和maven之类的构建系统支持其他jars:如果将 Artifact 上传到例如Maven中央，只需放置一个带有-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
}