Repository: incubator-reef Updated Branches: refs/heads/master e70bb56c2 -> d81109959
[REEF-431]: Fix violations of JavadocStyle checkstyle This addressed the issue by * fixing malformated HTML * converting missing Javadoc for package-info.java files to TODO: Document JIRA: [REEF-431](https://issues.apache.org/jira/browse/REEF-431) Pull Request: This closes #259 Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/d8110995 Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/d8110995 Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/d8110995 Branch: refs/heads/master Commit: d81109959decb92d6189ba22438be0882843ac5d Parents: e70bb56 Author: Mariia Mykhailova <[email protected]> Authored: Mon Jun 29 16:46:53 2015 -0700 Committer: Markus Weimer <[email protected]> Committed: Mon Jun 29 17:20:08 2015 -0700 ---------------------------------------------------------------------- .../common/driver/evaluator/AllocatedEvaluatorImpl.java | 2 +- lang/java/reef-common/src/main/resources/checkstyle.xml | 4 +--- .../apache/reef/examples/hellohttp/HttpShellJobDriver.java | 8 ++++---- .../org/apache/reef/examples/scheduler/SchedulerDriver.java | 8 ++++---- .../org/apache/reef/io/network/exception/package-info.java | 3 +++ .../java/org/apache/reef/io/network/impl/package-info.java | 3 +++ .../java/org/apache/reef/io/network/naming/NameResolver.java | 2 +- .../reef/io/network/naming/exception/package-info.java | 3 +++ .../java/org/apache/reef/io/network/naming/package-info.java | 3 +++ .../main/java/org/apache/reef/io/network/package-info.java | 3 +++ .../java/org/apache/reef/io/network/util/package-info.java | 3 +++ .../reef/runtime/local/client/LocalRuntimeConfiguration.java | 2 +- .../reef/runtime/local/driver/LocalDriverConfiguration.java | 2 +- .../src/main/java/org/apache/reef/util/Optional.java | 2 +- 14 files changed, 32 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java index 0cd1bbb..5c8b7b2 100644 --- a/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java +++ b/lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/driver/evaluator/AllocatedEvaluatorImpl.java @@ -244,7 +244,7 @@ final class AllocatedEvaluatorImpl implements AllocatedEvaluator { } /** - * Utility to build a ConfigurationBuilder from an Optional<Configuration></Configuration>. + * Utility to build a ConfigurationBuilder from an Optional<Configuration>. */ private static ConfigurationBuilder getConfigurationBuilder(final Optional<Configuration> configuration) { if (configuration.isPresent()) { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-common/src/main/resources/checkstyle.xml ---------------------------------------------------------------------- diff --git a/lang/java/reef-common/src/main/resources/checkstyle.xml b/lang/java/reef-common/src/main/resources/checkstyle.xml index ce2b553..027d87e 100644 --- a/lang/java/reef-common/src/main/resources/checkstyle.xml +++ b/lang/java/reef-common/src/main/resources/checkstyle.xml @@ -85,9 +85,7 @@ <property name="allowMissingParamTags" value="true"/> <property name="severity" value="warning"/> </module> - <module name="JavadocStyle"> - <property name="severity" value="warning"/> - </module> + <module name="JavadocStyle"/> <!-- Checks for Naming Conventions. --> <!-- See http://checkstyle.sf.net/config_naming.html --> http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java index f1bea77..27a63a2 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hellohttp/HttpShellJobDriver.java @@ -179,10 +179,10 @@ public final class HttpShellJobDriver { /** * Possible states of the job driver. Can be one of: * <dl> - * <du><code>INIT</code></du><dd>initial state, ready to request the evaluators.</dd> - * <du><code>WAIT_EVALUATORS</code></du><dd>Wait for requested evaluators to initialize.</dd> - * <du><code>READY</code></du><dd>Ready to submitTask a new task.</dd> - * <du><code>WAIT_TASKS</code></du><dd>Wait for tasks to complete.</dd> + * <dt><code>INIT</code></dt><dd>initial state, ready to request the evaluators.</dd> + * <dt><code>WAIT_EVALUATORS</code></dt><dd>Wait for requested evaluators to initialize.</dd> + * <dt><code>READY</code></dt><dd>Ready to submitTask a new task.</dd> + * <dt><code>WAIT_TASKS</code></dt><dd>Wait for tasks to complete.</dd> * </dl> */ private enum State { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerDriver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerDriver.java index bd6bdb1..6753c48 100644 --- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerDriver.java +++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/scheduler/SchedulerDriver.java @@ -49,10 +49,10 @@ public final class SchedulerDriver { /** * Possible states of the job driver. Can be one of: * <dl> - * <du><code>INIT</code></du><dd>Initial state. Ready to request an evaluator.</dd> - * <du><code>WAIT_EVALUATORS</code></du><dd>Waiting for an evaluator allocated with no active evaluators.</dd> - * <du><code>READY</code></du><dd>Wait for the commands. Reactivated when a new Task arrives.</dd> - * <du><code>RUNNING</code></du><dd>Run commands in the queue. Go back to READY state when the queue is empty.</dd> + * <dt><code>INIT</code></dt><dd>Initial state. Ready to request an evaluator.</dd> + * <dt><code>WAIT_EVALUATORS</code></dt><dd>Waiting for an evaluator allocated with no active evaluators.</dd> + * <dt><code>READY</code></dt><dd>Wait for the commands. Reactivated when a new Task arrives.</dd> + * <dt><code>RUNNING</code></dt><dd>Run commands in the queue. Go back to READY state when the queue is empty.</dd> * </dl> */ private enum State { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/package-info.java index 4a5f5e5..67081d6 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/package-info.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/exception/package-info.java @@ -16,4 +16,7 @@ * specific language governing permissions and limitations * under the License. */ +/** + * TODO: Document. + */ package org.apache.reef.io.network.exception; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/package-info.java index 7694e66..6f3a8d2 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/package-info.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/impl/package-info.java @@ -16,4 +16,7 @@ * specific language governing permissions and limitations * under the License. */ +/** + * TODO: Document. + */ package org.apache.reef.io.network.impl; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameResolver.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameResolver.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameResolver.java index 8036b00..ac2bce6 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameResolver.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/NameResolver.java @@ -23,7 +23,7 @@ import org.apache.reef.tang.annotations.DefaultImplementation; import org.apache.reef.wake.Stage; /** - * NameClient interface + * NameClient interface. */ @DefaultImplementation(NameClient.class) public interface NameResolver extends Stage, Naming { http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/package-info.java index 755647f..45adb09 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/package-info.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/exception/package-info.java @@ -16,4 +16,7 @@ * specific language governing permissions and limitations * under the License. */ +/** + * TODO: Document. + */ package org.apache.reef.io.network.naming.exception; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/package-info.java index 0cce33d..3c6e2c1 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/package-info.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/naming/package-info.java @@ -16,4 +16,7 @@ * specific language governing permissions and limitations * under the License. */ +/** + * TODO: Document. + */ package org.apache.reef.io.network.naming; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-io/src/main/java/org/apache/reef/io/network/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/package-info.java index b04131e..b5c06d5 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/package-info.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/package-info.java @@ -16,4 +16,7 @@ * specific language governing permissions and limitations * under the License. */ +/** + * TODO: Document. + */ package org.apache.reef.io.network; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/package-info.java index bcc6ec8..819a2df 100644 --- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/package-info.java +++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/util/package-info.java @@ -16,4 +16,7 @@ * specific language governing permissions and limitations * under the License. */ +/** + * TODO: Document. + */ package org.apache.reef.io.network.util; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/LocalRuntimeConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/LocalRuntimeConfiguration.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/LocalRuntimeConfiguration.java index 0e62836..17c6780 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/LocalRuntimeConfiguration.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/LocalRuntimeConfiguration.java @@ -67,7 +67,7 @@ public class LocalRuntimeConfiguration extends ConfigurationModuleBuilder { public static final OptionalImpl<ConfigurationProvider> DRIVER_CONFIGURATION_PROVIDERS = new OptionalImpl<>(); /** - * The rack names that will be available in the local runtime + * The rack names that will be available in the local runtime. */ public static final OptionalParameter<String> RACK_NAMES = new OptionalParameter<>(); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java index 8cbcc5f..6aac8a5 100644 --- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java +++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/LocalDriverConfiguration.java @@ -53,7 +53,7 @@ public class LocalDriverConfiguration extends ConfigurationModuleBuilder { public static final OptionalParameter<Double> JVM_HEAP_SLACK = new OptionalParameter<>(); /** - * The rack names that will be available in the local runtime + * The rack names that will be available in the local runtime. */ public static final OptionalParameter<String> RACK_NAMES = new OptionalParameter<>(); http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/d8110995/lang/java/reef-utils/src/main/java/org/apache/reef/util/Optional.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/Optional.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/Optional.java index 46d321d..633cf74 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/Optional.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/Optional.java @@ -25,7 +25,7 @@ import java.io.Serializable; /** * Represents an optional value. Loosely based on - * <a href="http://download.java.net/jdk8/docs/api/java/util/Optional.html";></a>The Java 8 version</a>, but filtered for + * <a href="http://download.java.net/jdk8/docs/api/java/util/Optional.html";>The Java 8 version</a>, but filtered for * Java 7 compatibility. */ @Immutable
