JavaDoc,如何通过 gradle 任务为特定 类 生成文档?
JavaDoc, how to generate documents via gradle task for specific classes?
我调查了这个 ,但它对我没有帮助。
我的任务是仅为特定的 类.
生成 javadoc
sourceSets {
main {
java {
srcDir 'src/main/java/com/project/module'
}
}
}
task javadocApi(type: Javadoc) {
source = sourceSets.main.java.srcDirs
classpath = sourceSets.main.java.srcDirs()
destinationDir = file("../javadoc/")
include("**/ClassObject.java")
include("**/ClassListener.java")
failOnError true
}
当我 运行 任务 javadocApi
我得到这个错误:
error: package android.app does not exist for whole code in these classes ClassObject and ClassListener
[ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] > Javadoc generation failed. Generated Javadoc options file (useful for troubleshooting): '/Users/user/Documents/Projects/project/Developement/Sources/moduleaandroid/android/build/tmp/javadocApi/javadoc.options'
嗯,经过一番尝试,我找到了这个解决方案:
task generateApiDoc(type: Javadoc) {
failOnError false
final Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
final def sdkDir = properties.getProperty('sdk.dir')
options.bootClasspath(new File(sdkDir + "/platforms/android-30/android.jar"))
source = android.sourceSets.main.java.srcDirs
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
classpath += configurations.compile
destinationDir = file("../release/Resources/JavaDoc")
include("**/ClassName.java")
include("**/ClassName.java")
}
我调查了这个
我的任务是仅为特定的 类.
生成 javadocsourceSets {
main {
java {
srcDir 'src/main/java/com/project/module'
}
}
}
task javadocApi(type: Javadoc) {
source = sourceSets.main.java.srcDirs
classpath = sourceSets.main.java.srcDirs()
destinationDir = file("../javadoc/")
include("**/ClassObject.java")
include("**/ClassListener.java")
failOnError true
}
当我 运行 任务 javadocApi
我得到这个错误:
error: package android.app does not exist for whole code in these classes ClassObject and ClassListener
[ERROR] [org.gradle.internal.buildevents.BuildExceptionReporter] > Javadoc generation failed. Generated Javadoc options file (useful for troubleshooting): '/Users/user/Documents/Projects/project/Developement/Sources/moduleaandroid/android/build/tmp/javadocApi/javadoc.options'
嗯,经过一番尝试,我找到了这个解决方案:
task generateApiDoc(type: Javadoc) {
failOnError false
final Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
final def sdkDir = properties.getProperty('sdk.dir')
options.bootClasspath(new File(sdkDir + "/platforms/android-30/android.jar"))
source = android.sourceSets.main.java.srcDirs
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
classpath += configurations.compile
destinationDir = file("../release/Resources/JavaDoc")
include("**/ClassName.java")
include("**/ClassName.java")
}