commit 9562a3b639225d406d736b64a12e2d75459259e3
author Alan Viverette <alanv@google.com> Fri Jul 01 13:26:39 2016 -0400
committer Alan Viverette <alanv@google.com> Fri Jul 01 13:26:39 2016 -0400
tree 0f0247ca0f024729e1433631d52daf0f207dc3d2
parent 1fa246fb379bda7b211f390577de558171f0c6b6

Add offline docs target for support lib gradle build

Fixes standalone docs issues like references to hidden framework class
R.styleable. Removes reference to BackupAgent, which makes doclava choke
for some unknown reason.

Standalone online docs may now be built with ./gradlew :generateDocs

Bug: 28124434
Change-Id: If76ac9018be1d17f1258802d4ef3ce1ad67b4903

build.gradle

diff --git a/build.gradle b/build.gradle
index 3d2e800..fdda8dc0 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,3 +1,4 @@
+import android.support.doclava.DoclavaMultilineJavadocOptionFileOption
 import com.android.build.gradle.internal.coverage.JacocoReportTask
 import com.android.build.gradle.internal.tasks.DeviceProviderInstrumentTestTask
 
@@ -253,24 +254,50 @@
     }
 }
 
-void registerForDocs(Project subProject, releaseVariant) {
-    rootProject.generateApi.dependsOn releaseVariant.javaCompile
-    rootProject.generateApi.source {
+void registerForDocsTask(Task task, Project subProject, releaseVariant) {
+    task.dependsOn releaseVariant.javaCompile
+    task.source {
         def buildConfig = fileTree(releaseVariant.getGenerateBuildConfig().sourceOutputDir)
         return releaseVariant.javaCompile.source.minus(buildConfig) +
             fileTree(releaseVariant.aidlCompile.sourceOutputDir) +
             fileTree(releaseVariant.outputs[0].processResources.sourceOutputDir)
     }
-    rootProject.generateApi.classpath += files(releaseVariant.javaCompile.classpath) +
+    task.classpath += files(releaseVariant.javaCompile.classpath) +
             files(releaseVariant.javaCompile.destinationDir)
 
     if (subProject.hasProperty('allSS')) {
         subProject.allSS.each { ss ->
-            rootProject.generateApi.source ss.java
+            task.source ss.java
         }
     }
 }
 
+// Generates online docs.
+task generateDocs(type: DoclavaTask, dependsOn: configurations.doclava) {
+    docletpath = configurations.doclava.resolve()
+    destinationDir = new File(project.docsDir, "online")
+
+    // Base classpath is Android SDK, sub-projects add their own.
+    classpath = getAndroidPrebuilt(gradle.ext.currentSdk)
+
+    def hdfOption = new DoclavaMultilineJavadocOptionFileOption('hdf')
+    hdfOption.add(
+            ['android.whichdoc', 'online'],
+            ['android.hasSamples', 'true']);
+
+    options {
+        addStringOption "templatedir",
+                "${project.rootDir}/../../build/tools/droiddoc/templates-sdk"
+        addStringOption "federate Android", "http://developer.android.com"
+        addStringOption "federationapi Android",
+                "${project.rootDir}/../../prebuilts/sdk/api/24.txt"
+        addStringOption "stubpackages", "android.support.*"
+        addStringOption "samplesdir", "${project.rootDir}/samples"
+        addOption hdfOption
+    }
+
+    exclude '**/BuildConfig.java'
+}
 
 // Generates API files.
 task generateApi(type: DoclavaTask, dependsOn: configurations.doclava) {
@@ -462,7 +489,8 @@
                 && !(p.android.hasProperty('noDocs') && p.android.noDocs)) {
             p.android.libraryVariants.all { v ->
                 if (v.name == 'release') {
-                    registerForDocs(p, v)
+                    registerForDocsTask(rootProject.generateDocs, p, v)
+                    registerForDocsTask(rootProject.generateApi, p, v)
                 }
             }
         }