[beam] branch master updated: [BEAM-4108] Generate javadocs for release (#5121)

[al...@apache.org]

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

altay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git


The following commit(s) were added to refs/heads/master by this push:
     new c743632  [BEAM-4108] Generate javadocs for release (#5121)
c743632 is described below

commit c743632e47f92719913a5104cd2c356c8b02f36b
Author: Scott Wegner <sw...@gmail.com>
AuthorDate: Wed Apr 18 12:30:33 2018 -0700

    [BEAM-4108] Generate javadocs for release (#5121)
    
    * [BEAM-3249] Add the ability to generate and aggregated javadoc
---
 sdks/java/javadoc/build.gradle | 111 +++++++++++++++++++++++++++++++++++++++++
 settings.gradle                |   2 +
 2 files changed, 113 insertions(+)

diff --git a/sdks/java/javadoc/build.gradle b/sdks/java/javadoc/build.gradle
new file mode 100644
index 0000000..08282dc
--- /dev/null
+++ b/sdks/java/javadoc/build.gradle
@@ -0,0 +1,111 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * License); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+description = "Apache Beam :: SDKs :: Java :: Aggregated Javadoc"
+apply plugin: 'java'
+
+def exportedJavadocProjects = [
+  ':beam-runners-apex',
+  ':beam-runners-core-construction-java',
+  ':beam-runners-core-java',
+  ':beam-local-artifact-service-java',
+  ':beam-runners-java-fn-execution',
+  ':beam-runners-local-java-core',
+  ':beam-runners-direct-java',
+  ':beam-runners-reference-java',
+  ':beam-runners-reference-job-server',
+  ':beam-runners-flink_2.11',
+  ':beam-runners-google-cloud-dataflow-java',
+  ':beam-runners-spark',
+  ':beam-runners-gearpump',
+  ':beam-sdks-java-core',
+  ':beam-sdks-java-fn-execution',
+  ':beam-sdks-java-extensions-google-cloud-platform-core',
+  ':beam-sdks-java-extensions-join-library',
+  ':beam-sdks-java-extensions-json-jackson',
+  ':beam-sdks-java-extensions-protobuf',
+  ':beam-sdks-java-extensions-sketching',
+  ':beam-sdks-java-extensions-sorter',
+  ':beam-sdks-java-extensions-sql',
+  ':beam-sdks-java-harness',
+  ':beam-sdks-java-io-amazon-web-services',
+  ':beam-sdks-java-io-amqp',
+  ':beam-sdks-java-io-cassandra',
+  ':beam-sdks-java-io-elasticsearch',
+  ':beam-sdks-java-io-elasticsearch-tests-2',
+  ':beam-sdks-java-io-elasticsearch-tests-5',
+  ':beam-sdks-java-io-elasticsearch-tests-common',
+  ':beam-sdks-java-io-google-cloud-platform',
+  ':beam-sdks-java-io-hadoop-common',
+  ':beam-sdks-java-io-hadoop-file-system',
+  ':beam-sdks-java-io-hadoop-input-format',
+  ':beam-sdks-java-io-hbase',
+  ':beam-sdks-java-io-hcatalog',
+  ':beam-sdks-java-io-jdbc',
+  ':beam-sdks-java-io-jms',
+  ':beam-sdks-java-io-kafka',
+  ':beam-sdks-java-io-kinesis',
+  ':beam-sdks-java-io-mongodb',
+  ':beam-sdks-java-io-mqtt',
+  ':beam-sdks-java-io-redis',
+  ':beam-sdks-java-io-solr',
+  ':beam-sdks-java-io-tika',
+  ':beam-sdks-java-io-xml',
+]
+
+for (String exportedJavadocProject : exportedJavadocProjects) {
+  evaluationDependsOn(exportedJavadocProject)
+}
+
+task aggregateJavadoc(type: Javadoc) {
+  source exportedJavadocProjects.collect { project(it).sourceSets.main.allJava }
+  classpath = files(exportedJavadocProjects.collect { project(it).sourceSets.main.compileClasspath })
+  destinationDir = file("${buildDir}/docs/javadoc")
+
+  exclude "org/apache/beam/examples/*"
+  exclude "org/apache/beam/fn/harness/*"
+  exclude "org/apache/beam/runners/apex/translation/*"
+  exclude "org/apache/beam/runners/core/*"
+  exclude "org/apache/beam/runners/dataflow/internal/*"
+  exclude "org/apache/beam/runners/flink/examples/*"
+  exclude "org/apache/beam/runners/flink/translation/*"
+  exclude "org/apache/beam/runners/spark/examples/*"
+  exclude "org/apache/beam/runners/spark/translation/*"
+  exclude "org/apache/beam/sdk/transforms/reflect/*"
+  exclude "org/apache/beam/sdk/runners/*"
+  exclude "org/apache/beam/sdk/util/*"
+
+  options.with {
+    failOnError false
+    title "Apache Beam 2.5.0"
+    overview 'overview.html'
+    addStringOption('Xdoclint:all', '-quiet')
+    addStringOption('Xdoclint:-missing', '-quiet')
+    linksOffline 'http://avro.apache.org/docs/1.7.7/api/java/', 'avro-docs'
+    linksOffline 'https://developers.google.com/api-client-library/java/google-api-java-client/reference/1.22.0/', 'apiclient-docs'
+    linksOffline 'https://developers.google.com/api-client-library/java/google-oauth-java-client/reference/1.22.0/', 'oauth-docs'
+    linksOffline 'https://developers.google.com/resources/api-libraries/documentation/bigquery/v2/java/latest/', 'bq-docs'
+    linksOffline 'http://googlecloudplatform.github.io/google-cloud-java/0.8.0/apidocs/index.html', 'datastore-docs'
+    linksOffline 'http://google.github.io/guava/releases/20.0/api/docs/', 'guava-docs'
+    linksOffline 'http://fasterxml.github.io/jackson-annotations/javadoc/2.7/', 'jackson-annotations-docs'
+    linksOffline 'http://fasterxml.github.io/jackson-databind/javadoc/2.7/', 'jackson-databind-docs'
+    linksOffline 'http://hamcrest.org/JavaHamcrest/javadoc/1.3/', 'hamcrest-docs'
+    linksOffline 'http://www.joda.org/joda-time/apidocs', 'joda-docs'
+    linksOffline 'http://junit.sourceforge.net/javadoc/', 'junit-docs'
+  }
+}
diff --git a/settings.gradle b/settings.gradle
index 99cd60b..c814712 100644
--- a/settings.gradle
+++ b/settings.gradle
@@ -138,6 +138,8 @@ include "beam-sdks-java-io-tika"
 project(":beam-sdks-java-io-tika").dir = file("sdks/java/io/tika")
 include "beam-sdks-java-io-xml"
 project(":beam-sdks-java-io-xml").dir = file("sdks/java/io/xml")
+include "beam-sdks-java-javadoc"
+project(":beam-sdks-java-javadoc").dir = file("sdks/java/javadoc")
 include "beam-sdks-java-maven-archetypes-examples"
 project(":beam-sdks-java-maven-archetypes-examples").dir = file("sdks/java/maven-archetypes/examples")
 include "beam-sdks-java-maven-archetypes-starter"

-- 
To stop receiving notification emails like this one, please contact
altay@apache.org.