Skip to content

Commit

Permalink
Closes apache#1290
Browse files Browse the repository at this point in the history
  • Loading branch information
@dhalperi
dhalperi committed Nov 5, 2016
2 parents 14e093a + 717b431 commit 5864a38
Show file tree
Hide file tree
Showing 56 changed files with 119 additions and 503 deletions.
68 changes: 0 additions & 68 deletions examples/java/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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://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://docs.guava-libraries.googlecode.com/git-history/release18/javadoc/</url>
<location>${basedir}/../../sdks/java/javadoc/guava-docs</location>
</offlineLink>
<offlineLink>
<url>http://fasterxml.github.io/jackson-annotations/javadoc/2.7/</url>
<location>${basedir}/../../sdks/java/javadoc/jackson-annotations-docs</location>
</offlineLink>
<offlineLink>
<url>http://fasterxml.github.io/jackson-databind/javadoc/2.7/</url>
<location>${basedir}/../../sdks/java/javadoc/jackson-databind-docs</location>
</offlineLink>
<offlineLink>
<url>http://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>
Expand Down
8 changes: 0 additions & 8 deletions examples/java8/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
3 changes: 2 additions & 1 deletion examples/java8/src/main/java/org/apache/beam/examples/complete/game/GameStats.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/java8/src/main/java/org/apache/beam/examples/complete/game/LeaderBoard.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/java8/src/main/java/org/apache/beam/examples/complete/game/UserScore.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
11 changes: 10 additions & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down
23 changes: 0 additions & 23 deletions runners/core-java/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
61 changes: 0 additions & 61 deletions runners/direct-java/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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://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://docs.guava-libraries.googlecode.com/git-history/release19/javadoc/</url>
<location>${basedir}/../../sdks/java/javadoc/guava-docs</location>
</offlineLink>
<offlineLink>
<url>http://hamcrest.org/JavaHamcrest/javadoc/1.3/</url>
<location>${basedir}/../../sdks/java/javadoc/hamcrest-docs</location>
</offlineLink>
<offlineLink>
<url>http://fasterxml.github.io/jackson-annotations/javadoc/2.7/</url>
<location>${basedir}/../../sdks/java/javadoc/jackson-annotations-docs</location>
</offlineLink>
<offlineLink>
<url>http://fasterxml.github.io/jackson-databind/javadoc/2.7/</url>
<location>${basedir}/../../sdks/java/javadoc/jackson-databind-docs</location>
</offlineLink>
<offlineLink>
<url>http://www.joda.org/joda-time/apidocs</url>
<location>${basedir}/../../sdks/java/javadoc/joda-docs</location>
</offlineLink>
<offlineLink>
<url>http://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>
Expand Down
8 changes: 0 additions & 8 deletions runners/flink/examples/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
8 changes: 3 additions & 5 deletions ...examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/AutoComplete.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* */
Expand Down
12 changes: 4 additions & 8 deletions ...examples/src/main/java/org/apache/beam/runners/flink/examples/streaming/JoinExamples.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* */
Expand Down
2 changes: 1 addition & 1 deletion ...mples/src/main/java/org/apache/beam/runners/flink/examples/streaming/KafkaIOExamples.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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> {
Expand Down
8 changes: 3 additions & 5 deletions ...les/src/main/java/org/apache/beam/runners/flink/examples/streaming/WindowedWordCount.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* */
Expand Down
8 changes: 0 additions & 8 deletions runners/flink/runner/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading

0 comments on commit 5864a38

Please sign in to comment.