Android Studio生成javadoc之gradle实现

和Eclipse一样,Android Studio也提供了导出javadoc的功能,在”Tools–>Generate javaDoc…”,而且还可以设置只导出哪些类的说明文档。我们这里主要介绍在gradle里配置javadoc的task,它的执行和上篇文章的生成jar包是一样的。
生成doc:

def name = 'EasyLinkSDKAPI'
def docDest = 'build/doc/'

task javadoc(type: Javadoc) {
    delete(docDest + name)
    source = android.sourceSets.main.java.srcDirs
    // 这里有用到aidl,所以也要导进来,否则会报找不到类的错误
    source += 'build/generated/source/aidl/release/com/paxsz/easylink/aidl/'
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))

    destinationDir = file(docDest + name)
    exclude '**/R.java', '**/Constants.java', '**/*.aidl'

    failOnError false
}

/*在javadoc task执行之前先添加第三方的依赖进来,否则会找不到相关的jar包*/
afterEvaluate {
    javadoc.classpath += files(android.libraryVariants.collect { variant2 ->
        variant2.getJavaCompiler().classpath.files
    })
}

javadoc {
    options {
        // 语言
        locale 'en_US'
        encoding 'UTF-8'
        charSet 'UTF-8'
        links "http://docs.oracle.com/javase/7/docs/api"
    }
}

相关option:
http://blog.csdn.net/lonewolf521125/article/details/51954886
http://blog.csdn.net/sinat_32955803/article/details/51301734

第三方jar和doc绑定:
http://blog.csdn.net/a739697044/article/details/28116189

相关讨论:
https://stackoverflow.com/questions/41076271/javadoc-generation-error-package-does-not-exist-in-multi-module-project

猜你喜欢

转载自blog.csdn.net/ithouse/article/details/79377032