[beam] branch release-2.6.0 updated: Changed hardcoded version number into env variable. Added more comments.

[pa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

pabloem pushed a commit to branch release-2.6.0
in repository https://gitbox.apache.org/repos/asf/beam.git


The following commit(s) were added to refs/heads/release-2.6.0 by this push:
     new c5d0dbf  Changed hardcoded version number into env variable. Added more comments.
c5d0dbf is described below

commit c5d0dbfd045ec3798c532bec6556d5225ce27b76
Author: Boyuan Zhang <bo...@google.com>
AuthorDate: Wed Jul 25 17:26:05 2018 -0700

    Changed hardcoded version number into env variable. Added more comments.
    
    (cherry picked from commit 28f193b in master)
---
 sdks/java/javadoc/build.gradle | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/sdks/java/javadoc/build.gradle b/sdks/java/javadoc/build.gradle
index e6f7c4d..240aef4 100644
--- a/sdks/java/javadoc/build.gradle
+++ b/sdks/java/javadoc/build.gradle
@@ -16,6 +16,13 @@
  * limitations under the License.
  */
 
+/*
+ * Aggregate Javadoc is not published to Maven Central. Each Java module that is published
+ * to Maven Cental packages its own Javadoc. To generate aggregated javadocs, run:
+ *   ./gradlew :beam-sdks-java-javadoc:aggregateJavadoc
+ * Generated files will be located under beam/sdks/java/javadoc/build/docs/javadoc and are
+ * used as part of the beam-site source tree.
+ */
 description = "Apache Beam :: SDKs :: Java :: Aggregated Javadoc"
 apply plugin: 'java'
 
@@ -91,7 +98,7 @@ task aggregateJavadoc(type: Javadoc) {
 
   options.with {
     failOnError false
-    title "Apache Beam 2.5.0"
+    title "Apache Beam " + project.version
     overview 'overview.html'
     addStringOption('Xdoclint:all', '-quiet')
     addStringOption('Xdoclint:-missing', '-quiet')