You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by up...@apache.org on 2016/02/02 23:00:41 UTC

incubator-geode git commit: GEODE-572: Generate public javadocs

Repository: incubator-geode
Updated Branches:
  refs/heads/develop f7b2714c1 -> 01c9337ba


GEODE-572: Generate public javadocs

Adding a task to generate javadocs for the public API as part of the
assembly project. The javadocs are now included in the binary
distribution in a folder called javadocs.


Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/01c9337b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/01c9337b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/01c9337b

Branch: refs/heads/develop
Commit: 01c9337ba7a8f12623652ba149c17b43fccc52d4
Parents: f7b2714
Author: Dan Smith <up...@apache.org>
Authored: Tue Feb 2 10:00:49 2016 -0800
Committer: Dan Smith <up...@apache.org>
Committed: Tue Feb 2 13:59:26 2016 -0800

----------------------------------------------------------------------
 gemfire-assembly/build.gradle | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/01c9337b/gemfire-assembly/build.gradle
----------------------------------------------------------------------
diff --git a/gemfire-assembly/build.gradle b/gemfire-assembly/build.gradle
index 21ee604..a02b0a3 100755
--- a/gemfire-assembly/build.gradle
+++ b/gemfire-assembly/build.gradle
@@ -195,6 +195,21 @@ task gfshDepsJar (type: Jar, dependsOn: ':gemfire-core:classes') {
   }
 }
 
+
+def docsDir = file("$buildDir/javadocs")
+task docs(type: Javadoc) {
+    source parent.subprojects*.javadoc*.source
+    classpath = files(parent.subprojects*.javadoc*.classpath)
+    title = "Apache Geode ${project.version}"
+    include 'com/gemstone/gemfire/**/'
+    exclude 'com/gemstone/gemfire/internal/**/'
+    exclude 'com/gemstone/gemfire/**/internal/**/'
+    exclude 'com/gemstone/gemfire/**/xml/**/'
+    exclude 'com/gemstone/gemfire/distributed/**/util/**/'
+    exclude 'com/gemstone/gemfire/test/**/'
+    destinationDir = docsDir
+}
+
 gradle.taskGraph.whenReady( { graph ->
   tasks.withType(AbstractArchiveTask).findAll {
     it.name.toLowerCase().contains("dist")
@@ -297,6 +312,10 @@ distributions {
         }
       }
 
+      into ('javadoc') {
+        from docs
+      }
+
       into ('tools/Pulse') {
         from (project(":gemfire-pulse").configurations.archives.allArtifacts.files) {
           exclude '*.jar'