Generiere JavaDocs mit dem Android Gradle Plugin

Wie kann ich das generieren von JavaDocs für ein Android-Projekt mit dem neuen Gradle-build-system?

Hier ist was ich habe kommen mit, aber es funktioniert nicht.

task generateJavadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    ext.cp = android.libraryVariants.collect { variant ->
        variant.javaCompile.classpath.files
    }
    classpath = files(ext.cp) 
}

Das Hauptproblem ist, dass ich nicht die richtige android.jar auf den classpath, so dass einige der links in den JavaDocs nicht gelöst werden. Ich muss einen Weg finden, um alle notwendigen jars im classpath.

Ein weiteres problem bei der Herangehensweise ist, sammelt es die klassenpfade für alle build-Varianten, die eher als die Auswahl eines.

InformationsquelleAutor der Frage Matt Accola | 2013-06-10

31

Für Android-gradle-plugin 1.1.2+ (com.android.tools.bauen:gradle:1.1.2+)

libraryVariants - funktioniert nicht mehr

verwenden:
```
task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    destinationDir = file("../javadoc/")
    failOnError false
}
```
destinationDir = file("../javadoc/") - suchen Sie javadocs an der Wurzel von Projekt-Verzeichnis (auf diese Weise jenkins javadoc-plugin finden konnte, es und zeigen Sie in speziellen Bedienfeld "Dokument")

failOnError false - für Warnmeldungen unterdrücken, die verursachen können, fail build auf jenkins

InformationsquelleAutor der Antwort Flinbor

Gradle 1.11 - Gradle-Plugin 0.10.0

Ersetzen android.plugin.sdkDirectory durch android.sdkDirectory

android.libraryVariants.all { variant ->
    task("generate${variant.name}Javadoc", type: Javadoc) {
        description "Generates Javadoc for $variant.name."
        source = variant.javaCompile.source
        ext.androidJar = "${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"
        classpath = files(variant.javaCompile.classpath.files) + files(ext.androidJar)
        options.links("http://docs.oracle.com/javase/7/docs/api/");
        options.links("http://d.android.com/reference/");
        exclude '**/BuildConfig.java'
        exclude '**/R.java'
    }
}

InformationsquelleAutor der Antwort flav

Die Lösung landete ich sich auf wie folgt:

android.libraryVariants.all { variant ->

    task("generate${variant.name}Javadoc", type: Javadoc) {
        description "Generates Javadoc for $variant.name."
        source = variant.javaCompile.source
        ext.androidJar = "${android.plugin.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"
        classpath = files(variant.javaCompile.classpath.files) + files(ext.androidJar)
    }

}

Xavier Ducrohet bestätigte dies ist der Weg, es zu tun (mit Einschränkungen) auf der adt-dev-Gruppe, https://groups.google.com/forum/#!searchin/adt-dev/javadoc/adt-dev/seRizEn8ICA/bafEvUl6mzsJ.

InformationsquelleAutor der Antwort Matt Accola

Mit android-gradle-tools 1.10.+ immer die android-SDK-dir ist anders als vorher. Sie haben folgende Einstellungen zu ändern:

android.sdkDirectory

statt

android.plugin.sdkDirectory

Dies ist die vollständige Lösung des Problems:

android.applicationVariants.all { variant ->

    task("generate${variant.name.capitalize()}Javadoc", type: Javadoc) {
        title = "Documentation for Android $android.defaultConfig.versionName b$android.defaultConfig.versionCode"
        destinationDir = new File("${project.getProjectDir()}/doc/compiled/", variant.baseName)
        source = variant.javaCompile.source

        ext.androidJar = "${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"
        classpath = files(variant.javaCompile.classpath.files) + files(ext.androidJar)

        description "Generates Javadoc for $variant.name."

        options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PRIVATE
        options.links("http://docs.oracle.com/javase/7/docs/api/");
        options.links("http://developer.android.com/reference/");
        exclude '**/BuildConfig.java'
        exclude '**/R.java'
    }
}

InformationsquelleAutor der Antwort Julian Liebl

8

Android Gläser scheinen in der Eigenschaft android.plugin.runtimeJarList. Es ist nicht dokumentiert überall obwohl, so dass es brechen könnte, jederzeit.

Ich verfeinert haben Ihre Lösung für die Arbeit über build-Varianten:
```
android.applicationVariants.all { variant ->
    def name = variant.name
    task "javadoc$name"(type: Javadoc) {
        description = "Generates javadoc for build $name"
        destinationDir = new File(destinationDir, variant.baseName)
        source = files(variant.javaCompile.source)
        classpath = files(android.plugin.runtimeJarList, variant.javaCompile.classpath)
        exclude '**/R.html', '**/R.*.html'
    }
}
```
Es im Allgemeinen nicht sinnvoll, das zu tun javadoc nur auf den main-branch, da Sie vielleicht setzen auf einige Dinge, die von der Produkt-Aromen. Auch debug vs. release konnte einige Unterschiede. Man könnte natürlich, wählen Sie einfach eine Standard-Variante zu verwenden. So könnte man etwas tun,
```
task javadoc(dependsOn: javadocDebug)
```
InformationsquelleAutor der Antwort thatsmydoing

Hier ist eine aktualisierte version, die verwendet, um die Arbeit in 2014:

android.libraryVariants.all { variant ->
    def name = variant.buildType.name

    if (name.equalsIgnoreCase("debug")) {
        return; //Skip debug builds.
    }
    task("javadoc${variant.name.capitalize()}", type: Javadoc) {
        description "Generates Javadoc for $variant.name."
        source = variant.javaCompile.source
        ext.androidJar = files(plugins.findPlugin("com.android.library").getBootClasspath())
        classpath = files(variant.javaCompile.classpath.files) + ext.androidJar
        exclude '**/internal/**'
        failOnError false
    }

    task("bundleJavadoc${variant.name.capitalize()}", type: Jar) {
        description "Bundles Javadoc into zip for $variant.name."
        classifier = "javadoc"
        from tasks["javadoc${variant.name.capitalize()}"]
    }
}

InformationsquelleAutor der Antwort volkersfreunde

Machte ich ein open-source-plugin für das. GitHub-Repository

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "gradle.plugin.com.vanniktech:gradle-android-javadoc-plugin:0.2.1"
    }
}

Fügen Sie diese Zeile in Ihre bauen.gradle

apply plugin: "com.vanniktech.android.javadoc"

Dann einfach eines der folgenden ausführen:

./gradlew generateDebugJavadoc
./gradlew generateReleaseJavadoc

Der java Dokumentation finden Sie im module/javaDoc/

InformationsquelleAutor der Antwort Niklas

Fand ich, dass diese Lösung funktioniert auf Gradle plugin 1.3.1, wenn Sie verschiedene Produkt-Aromen.

Dadurch wird Gradle-Aufgaben zum generieren von Javadoc für jedes Produkt Geschmack und bauen geben. Zum Beispiel, wenn das Modul name ist app und Sie haben eine production und dev Produkt Geschmack und debug und release build-Typen, haben Sie die folgenden Gradle Aufgaben:

:app:generateDevDebugJavadoc
:app:generateDevReleaseJavadoc
:app:generateProductionDebugJavadoc
:app:generateProductionReleaseJavadoc

app/build.gradle

android {

    //...

    applicationVariants.all { variant ->
        //create tasks to generate Javadocs
        task("generate${variant.name.capitalize()}Javadoc", type: Javadoc) {
            source = variant.javaCompile.source
            classpath += project.files(android.getBootClasspath().join(File.pathSeparator))

            //choose the destination that works best for you here
            //I chose this particular directory because Jenkins pulls reports 
            //from this directory already if you need to have the output 
            //folder be parameterized for the build variant, use
            //"build/outputs/docs/javadoc-${variant.name}/" instead and it'll 
            //be in `javadoc-productionRelease` for example
            destinationDir = file("build/outputs/docs/javadoc/")

            //the name that will appear in the docs
            title = rootProject.name

            //you will probably get errors from using the @annotations and 
            //the support library, so just turn off failing for errors
            failOnError false    
        }
    }

    //...

}

InformationsquelleAutor der Antwort Phazor

Einer mehr

android.libraryVariants.alle { Variante -> 
if(variant.name.equals('release')) 
Aufgabe("generateJavadoc", geben Sie ein: Javadoc) { 
Beschreibung "Generate Javadoc" 
source = android.sourceSets.main.java.srcDirs 
//println '=== Quelle ===' 
//Quelle.sammeln { relativePath () }.sort().each { println it } 
ext.androidJar = "${android.sdkDirectory}/Plattformen/${android.compileSdkVersion}/android.jar" 
classpath = Dateien(Variante.javaCompile.classpath.Dateien) + - Dateien(ext.androidJar) 
//println '=== classpath ===' 
//classpath.sammeln { relativePath () }.sort().each { println it } 
} 
}