Repository: incubator-reef Updated Branches: refs/heads/master a1851ca00 -> 12aea93c6
[REEF-536] Add missing Javadoc comments in Java code: reef-webserver JIRA: [REEF-536](https://issues.apache.org/jira/browse/REEF-536) Pull request: This closes #510 Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/12aea93c Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/12aea93c Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/12aea93c Branch: refs/heads/master Commit: 12aea93c657785b7ff1cfcb13b671e196b25b1cb Parents: a1851ca Author: Mariia Mykhailova <mar...@apache.org> Authored: Mon Sep 21 16:55:36 2015 -0700 Committer: Andrew Chung <afchun...@gmail.com> Committed: Thu Sep 24 09:57:46 2015 -0700 ---------------------------------------------------------------------- lang/java/reef-webserver/pom.xml | 11 +++++++++++ .../apache/reef/webserver/EvaluatorInfoSerializer.java | 3 +++ .../apache/reef/webserver/EvaluatorListSerializer.java | 2 +- .../reef/webserver/HttpServerReefEventHandler.java | 3 +++ .../java/org/apache/reef/webserver/package-info.java | 2 +- .../apache/reef/webserver/TestAvroSerializerForHttp.java | 3 +++ .../org/apache/reef/webserver/TestParsedHttpRequest.java | 3 +++ .../java/org/apache/reef/webserver/package-info.java | 2 +- 8 files changed, 26 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/pom.xml ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/pom.xml b/lang/java/reef-webserver/pom.xml index a6d628a..0ebb5d8 100644 --- a/lang/java/reef-webserver/pom.xml +++ b/lang/java/reef-webserver/pom.xml @@ -66,6 +66,17 @@ under the License. </executions> </plugin> </plugins> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <configuration> + <configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation> + </configuration> + </plugin> + </plugins> + </pluginManagement> </build> <dependencies> <dependency> http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorInfoSerializer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorInfoSerializer.java b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorInfoSerializer.java index 11255eb..11d2b1e 100644 --- a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorInfoSerializer.java +++ b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorInfoSerializer.java @@ -24,6 +24,9 @@ import org.apache.reef.tang.annotations.DefaultImplementation; import java.util.List; import java.util.Map; +/** + * Interface for EvaluatorInfoSerializer. + */ @DefaultImplementation(AvroEvaluatorInfoSerializer.class) public interface EvaluatorInfoSerializer { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorListSerializer.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorListSerializer.java b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorListSerializer.java index b92b39e..1df0261 100644 --- a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorListSerializer.java +++ b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/EvaluatorListSerializer.java @@ -24,7 +24,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation; import java.util.Map; /** - * interface for EvaluatorListSerializer. + * Interface for EvaluatorListSerializer. */ @DefaultImplementation(AvroEvaluatorListSerializer.class) public interface EvaluatorListSerializer { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/HttpServerReefEventHandler.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/HttpServerReefEventHandler.java b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/HttpServerReefEventHandler.java index 01bfb8c..9055130 100644 --- a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/HttpServerReefEventHandler.java +++ b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/HttpServerReefEventHandler.java @@ -45,6 +45,9 @@ import java.util.Set; import java.util.logging.Level; import java.util.logging.Logger; +/** + * Http handler for REEF events. + */ public final class HttpServerReefEventHandler implements HttpHandler { private static final Logger LOG = Logger.getLogger(HttpServerReefEventHandler.class.getName()); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/package-info.java b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/package-info.java index 06338c8..b196245 100644 --- a/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/package-info.java +++ b/lang/java/reef-webserver/src/main/java/org/apache/reef/webserver/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * TODO: Document. + * HTTP Server component to implement a REST API for the Driver or Evaluators. */ package org.apache.reef.webserver; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestAvroSerializerForHttp.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestAvroSerializerForHttp.java b/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestAvroSerializerForHttp.java index a31d413..095851d 100644 --- a/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestAvroSerializerForHttp.java +++ b/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestAvroSerializerForHttp.java @@ -108,6 +108,9 @@ public class TestAvroSerializerForHttp { } } + /** + * Configuration Module Builder for EvaluatorDescriptor. + */ public static final class EvaluatorDescriptorConfig extends ConfigurationModuleBuilder { static final ConfigurationModule CONF = new EvaluatorDescriptorConfig() .bindImplementation(EvaluatorDescriptor.class, EvaluatorDescriptorMock.class) http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestParsedHttpRequest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestParsedHttpRequest.java b/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestParsedHttpRequest.java index 51be76d..36ad90e 100644 --- a/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestParsedHttpRequest.java +++ b/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/TestParsedHttpRequest.java @@ -31,6 +31,9 @@ import java.util.HashMap; import java.util.LinkedHashMap; import java.util.List; +/** + * Test ParsedHttpRequest. + */ public final class TestParsedHttpRequest { private Request request; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/12aea93c/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/package-info.java b/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/package-info.java index 06338c8..c7d233a 100644 --- a/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/package-info.java +++ b/lang/java/reef-webserver/src/test/java/org/apache/reef/webserver/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * TODO: Document. + * Tests for HTTP Server component. */ package org.apache.reef.webserver;
