Create external link in Javadoc using Gradle in Android Studio

☆樱花仙子☆ 提交于 2019-12-21 22:06:02

问题


I have created a Gradle task that generates a javadoc using Doclava:

My code (the arguments of some of my methods) references classes defined in Android. When Javadoc is built, these references link correctly to the Android online reference. However, when I use the @ling tag to link to Android references, it does not work and I get something like:

configurations {
    jaxDoclet
    classpaths
}

dependencies {

    // For Doclava JavaDoc
    jaxDoclet("com.google.doclava:doclava:1.0.6")
    classpaths files('build/intermediates/classes/debug')
    classpaths project.files(android.getBootClasspath().join(File.pathSeparator))
}

task javadoc(type: Javadoc) {
    source = android.sourceSets.main.allJava
    source += fileTree("build/generated/source/r/debug")
    title = null
    options {
        docletpath = configurations.jaxDoclet.files.asType(List)
        doclet "com.google.doclava.Doclava"
        bootClasspath new File(System.getenv('JAVA_HOME') + "/jre/lib/rt.jar")
        classpath += configurations.classpaths.files.asType(List)
        addStringOption "public"
        addStringOption "federate android", "http://d.android.com/reference"
        addStringOption "federationxml android", "http://doclava.googlecode.com/svn/static/api/android-10.xml"
    }
}

warning 101: Unresolved link/see tag "Runnable" in com....

In similar questions in SO, it was advised to use -link and -linkoffline flags. However, when I do that I get:

javadoc: error - invalid flag: -linkoffline

I am using Android Studio 1.5.1 and Gradle 2.11.

Update It seems that Doclava may not support -link and -linksoffline according to these tickets. If I use the default doclet, links work correctly.

来源:https://stackoverflow.com/questions/35422458/create-external-link-in-javadoc-using-gradle-in-android-studio

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!