Closes apache#1290

mransley · Nov 5, 2016 · 5864a38 · 5864a38
2 parents 14e093a + 717b431
commit 5864a38
Show file tree

Hide file tree

Showing 56 changed files with 119 additions and 503 deletions.
diff --git a/examples/java/pom.xml b/examples/java/pom.xml
@@ -283,74 +283,6 @@
  <artifactId>maven-source-plugin</artifactId>
  </plugin>
 
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <windowtitle>Apache Beam Examples</windowtitle>
- <doctitle>Apache Beam Examples</doctitle>
-
- <subpackages>org.apache.beam.examples</subpackages>
- <additionalparam>-exclude org.apache.beam.sdk.runners.worker:org.apache.beam.sdk.runners.dataflow:org.apache.beam.sdk.util ${beam.javadoc_opts}</additionalparam>
- <use>false</use>
- <quiet>true</quiet>
- <bottom><![CDATA[<br>]]></bottom>
-
- <offlineLinks>
- <!-- The Dataflow SDK docs -->
- <offlineLink>
- <url>https://cloud.google.com/dataflow/java-sdk/JavaDoc/</url>
- <location>${basedir}/../../sdks/java/javadoc/dataflow-sdk-docs</location>
- </offlineLink>
- <!-- Other dependencies -->
- <offlineLink>
- <url>https://developers.google.com/api-client-library/java/google-api-java-client/reference/1.20.0/</url>
- <location>${basedir}/../../sdks/java/javadoc/apiclient-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://avro.apache.org/docs/${avro.version}/api/java/</url>
- <location>${basedir}/../../sdks/java/javadoc/avro-docs</location>
- </offlineLink>
- <offlineLink>
- <url>https://developers.google.com/resources/api-libraries/documentation/bigquery/v2/java/latest/</url>
- <location>${basedir}/../../sdks/java/javadoc/bq-docs</location>
- </offlineLink>
- <offlineLink>
- <url>https://cloud.google.com/datastore/docs/apis/javadoc/</url>
- <location>${basedir}/../../sdks/java/javadoc/datastore-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://docs.guava-libraries.googlecode.com/git-history/release18/javadoc/</url>
- <location>${basedir}/../../sdks/java/javadoc/guava-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://fasterxml.github.io/jackson-annotations/javadoc/2.7/</url>
- <location>${basedir}/../../sdks/java/javadoc/jackson-annotations-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://fasterxml.github.io/jackson-databind/javadoc/2.7/</url>
- <location>${basedir}/../../sdks/java/javadoc/jackson-databind-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://www.joda.org/joda-time/apidocs</url>
- <location>${basedir}/../../sdks/java/javadoc/joda-docs</location>
- </offlineLink>
- <offlineLink>
- <url>https://developers.google.com/api-client-library/java/google-oauth-java-client/reference/1.20.0/</url>
- <location>${basedir}/../../sdks/java/javadoc/oauth-docs</location>
- </offlineLink>
- </offlineLinks>
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>jar</goal>
- </goals>
- <phase>package</phase>
- </execution>
- </executions>
- </plugin>
-
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>

diff --git a/examples/java8/pom.xml b/examples/java8/pom.xml
@@ -119,14 +119,6 @@
 
  <build>
  <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>-Xdoclint:missing</additionalparam>
- </configuration>
- </plugin>
-
  <plugin>
  <artifactId>maven-compiler-plugin</artifactId>
  <configuration>

diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
@@ -100,7 +100,8 @@ public class GameStats extends LeaderBoard {
  /**
  * Filter out all but those users with a high clickrate, which we will consider as 'spammy' uesrs.
  * We do this by finding the mean total score per user, then using that information as a side
- * input to filter out all but those user scores that are > (mean * SCORE_WEIGHT)
+ * input to filter out all but those user scores that are larger than
+ * {@code (mean * SCORE_WEIGHT)}.
  */
  // [START DocInclude_AbuseDetect]
  public static class CalculateSpammyUsers

diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
@@ -73,7 +73,7 @@
  * results, e.g. for 'team prizes'. We're now outputting window results as they're
  * calculated, giving us much lower latency than with the previous batch examples.
  *
- * <p>Run {@link injector.Injector} to generate pubsub data for this pipeline. The Injector
+ * <p>Run {@code injector.Injector} to generate pubsub data for this pipeline. The Injector
  * documentation provides more detail on how to do this.
  *
  * <p>To execute this pipeline using the Dataflow service, specify the pipeline configuration

diff --git a/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java b/examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
@@ -68,7 +68,7 @@
  * where the BigQuery dataset you specify must already exist.
  *
  * <p>Optionally include the --input argument to specify a batch input file.
- * See the --input default value for example batch data file, or use {@link injector.Injector} to
+ * See the --input default value for example batch data file, or use {@code injector.Injector} to
  * generate your own batch data.
  */
 public class UserScore {

diff --git a/pom.xml b/pom.xml
@@ -160,6 +160,9 @@
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <additionalparam>${beam.javadoc_opts}</additionalparam>
+ </configuration>
  <executions>
  <execution>
  <id>javadoc</id>
@@ -212,6 +215,11 @@
  <groupId>org.apache.rat</groupId>
  <artifactId>apache-rat-plugin</artifactId>
  </plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
  </plugins>
  </build>
  </profile>
@@ -222,9 +230,10 @@
  <jdk>[1.8,)</jdk>
  </activation>
  <properties>
- <beam.javadoc_opts>-Xdoclint:-missing</beam.javadoc_opts>
+ <beam.javadoc_opts>-Xdoclint:all -Xdoclint:-missing</beam.javadoc_opts>
  </properties>
  </profile>
+
  <profile>
  <id>java7-packageinfo</id>
  <activation>

diff --git a/runners/core-java/pom.xml b/runners/core-java/pom.xml
@@ -63,29 +63,6 @@
  <artifactId>maven-source-plugin</artifactId>
  </plugin>
 
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <windowtitle>Beam Runners Core utilities ${project.version} API</windowtitle>
- <doctitle>Beam Runners Core utilities for Java, version ${project.version}</doctitle>
- <overview>../javadoc/overview.html</overview>
-
- <subpackages>org.apache.beam.runners.core</subpackages>
- <use>false</use>
- <quiet>true</quiet>
- <bottom><![CDATA[<br>]]></bottom>
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>jar</goal>
- </goals>
- <phase>package</phase>
- </execution>
- </executions>
- </plugin>
-
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>

diff --git a/runners/direct-java/pom.xml b/runners/direct-java/pom.xml
@@ -92,67 +92,6 @@
  </executions>
  </plugin>
 
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <windowtitle>Apache Beam Direct Runner ${project.version}</windowtitle>
- <doctitle>Apache Beam Direct Runner, version ${project.version}</doctitle>
-
- <subpackages>org.apache.beam.runners.direct</subpackages>
- <use>false</use>
- <quiet>true</quiet>
- <bottom><![CDATA[<br>]]></bottom>
-
- <offlineLinks>
- <offlineLink>
- <url>https://developers.google.com/api-client-library/java/google-api-java-client/reference/1.20.0/</url>
- <location>${basedir}/../../sdks/java/javadoc/apiclient-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://avro.apache.org/docs/${avro.version}/api/java/</url>
- <location>${basedir}/../../sdks/java/javadoc/avro-docs</location>
- </offlineLink>
- <offlineLink>
- <url>https://developers.google.com/resources/api-libraries/documentation/bigquery/v2/java/latest/</url>
- <location>${basedir}/../../sdks/java/javadoc/bq-docs</location>
- </offlineLink>
- <offlineLink>
- <url>https://cloud.google.com/datastore/docs/apis/javadoc/</url>
- <location>${basedir}/../../sdks/java/javadoc/datastore-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://docs.guava-libraries.googlecode.com/git-history/release19/javadoc/</url>
- <location>${basedir}/../../sdks/java/javadoc/guava-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://hamcrest.org/JavaHamcrest/javadoc/1.3/</url>
- <location>${basedir}/../../sdks/java/javadoc/hamcrest-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://fasterxml.github.io/jackson-annotations/javadoc/2.7/</url>
- <location>${basedir}/../../sdks/java/javadoc/jackson-annotations-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://fasterxml.github.io/jackson-databind/javadoc/2.7/</url>
- <location>${basedir}/../../sdks/java/javadoc/jackson-databind-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://www.joda.org/joda-time/apidocs</url>
- <location>${basedir}/../../sdks/java/javadoc/joda-docs</location>
- </offlineLink>
- <offlineLink>
- <url>http:https://junit.sourceforge.net/javadoc/</url>
- <location>${basedir}/../../sdks/java/javadoc/junit-docs</location>
- </offlineLink>
- <offlineLink>
- <url>https://developers.google.com/api-client-library/java/google-oauth-java-client/reference/1.20.0/</url>
- <location>${basedir}/../../sdks/java/javadoc/oauth-docs</location>
- </offlineLink>
- </offlineLinks>
- </configuration>
- </plugin>
-
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-shade-plugin</artifactId>

diff --git a/runners/flink/examples/pom.xml b/runners/flink/examples/pom.xml
@@ -109,14 +109,6 @@
  </executions>
  </plugin>
 
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>-Xdoclint:missing</additionalparam>
- </configuration>
- </plugin>
-
  <plugin>
  <groupId>org.codehaus.mojo</groupId>
  <artifactId>exec-maven-plugin</artifactId>

diff --git a/...examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java b/...examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java
@@ -53,11 +53,9 @@
 
 /**
  * To run the example, first open a socket on a terminal by executing the command:
- * <li>
- * <li>
- * <code>nc -lk 9999</code>
- * </li>
- * </li>
+ * <ul>
+ * <li><code>nc -lk 9999</code>
+ * </ul>
  * and then launch the example. Now whatever you type in the terminal is going to be
  * the input to the program.
  * */

diff --git a/...examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java b/...examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java
@@ -39,14 +39,10 @@
 
 /**
  * To run the example, first open two sockets on two terminals by executing the commands:
- * <li>
- * <li>
- * <code>nc -lk 9999</code>, and
- * </li>
- * <li>
- * <code>nc -lk 9998</code>
- * </li>
- * </li>
+ * <ul>
+ * <li><code>nc -lk 9999</code>, and
+ * <li><code>nc -lk 9998</code>
+ * </ul>
  * and then launch the example. Now whatever you type in the terminal is going to be
  * the input to the program.
  * */

diff --git a/...mples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java b/...mples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java
@@ -170,7 +170,7 @@ public static void main(String[] args) {
 
  /**
  * Serialiation/Deserialiation schema for Avro types.
- * @param <T>
+ * @param <T> the type being encoded
  */
  static class AvroSerializationDeserializationSchema<T>
  implements SerializationSchema<T>, DeserializationSchema<T> {

diff --git a/...les/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java b/...les/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java
@@ -42,11 +42,9 @@
 
 /**
  * To run the example, first open a socket on a terminal by executing the command:
- * <li>
- * <li>
- * <code>nc -lk 9999</code>
- * </li>
- * </li>
+ * <ul>
+ * <li><code>nc -lk 9999</code>
+ * </ul>
  * and then launch the example. Now whatever you type in the terminal is going to be
  * the input to the program.
  * */

diff --git a/runners/flink/runner/pom.xml b/runners/flink/runner/pom.xml
@@ -242,14 +242,6 @@
  </executions>
  </plugin>
 
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <additionalparam>-Xdoclint:missing</additionalparam>
- </configuration>
- </plugin>
-
  <!-- Integration Tests -->
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>