You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by ma...@apache.org on 2015/11/06 21:50:01 UTC
[3/4] incubator-reef git commit: [REEF-912] Make Javadoc-generation
work with Java 8
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
index c627d19..65f113e 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/Exceptions.java
@@ -28,8 +28,8 @@ public final class Exceptions {
/**
* Walks the .getCause() chain till it hits the leaf node.
*
- * @param throwable
- * @return
+ * @param throwable a throwable object
+ * @return the most inner cause
*/
public static Throwable getUltimateCause(final Throwable throwable) {
if (throwable.getCause() == null) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/ThreadLogFormatter.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/ThreadLogFormatter.java b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/ThreadLogFormatter.java
index 59c88bf..c6f8ab0 100644
--- a/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/ThreadLogFormatter.java
+++ b/lang/java/reef-common/src/main/java/org/apache/reef/util/logging/ThreadLogFormatter.java
@@ -30,9 +30,9 @@ import java.util.logging.LogRecord;
/**
* A denser logging format for REEF that is similar to the standard SimpleFormatter.
- * <p/>
+ * <p>
* The following config properties are available:
- * <p/>
+ * <p>
* * `org.apache.reef.util.logging.ThreadLogFormatter.format`
* is a format string for String.format() that takes same arguments and in
* the same order as the standard SimpleFormatter, plus the thread name:
@@ -43,7 +43,7 @@ import java.util.logging.LogRecord;
* 5. message
* 6. stack trace
* 7. thread name
- * <p/>
+ * <p>
* * `org.apache.reef.util.logging.ThreadLogFormatter.dropPrefix`
* contains a comma-separated list of package name prefixes that should be
* removed from the class name for logging. e.g. value `com.microsoft.,org.apache.`
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/package-info.java
index 7986423..91940de 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/package-info.java
@@ -17,6 +17,8 @@
* under the License.
*/
/**
- * TODO: Document.
+ * A line counter example using data loading service.
+ *
+ * Data loading service easily loads data either from HDFS or the local file system
*/
package org.apache.reef.examples.data.loading;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
index 6f5af66..24aa838 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDClient.java
@@ -67,7 +67,6 @@ public class BGDClient {
*
* @param runtimeConfiguration the runtime to run on.
* @param jobName the name of the job on the runtime.
- * @return
*/
public void submit(final Configuration runtimeConfiguration, final String jobName) throws Exception {
final Configuration driverConfiguration = getDriverConfiguration(jobName);
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/Example.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/Example.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/Example.java
index 2725db1..67caf45 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/Example.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/Example.java
@@ -36,7 +36,7 @@ public interface Example extends Serializable {
/**
* Computes the prediction for this Example, given the model w.
- * <p/>
+ * <p>
* w.dot(this.getFeatures())
*
* @param w the model
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/package-info.java
index c9ce7fb..8987915 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Interface for example data instance for linear models.
*/
package org.apache.reef.examples.group.bgd.data;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/package-info.java
index cf007a0..d817bae 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/data/parser/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * A parser interface and implementation for SVMLight records.
*/
package org.apache.reef.examples.group.bgd.data.parser;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/package-info.java
index 916fa2f..ae3206c 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Loss Functions for BGD.
*/
package org.apache.reef.examples.group.bgd.loss;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/package-info.java
index 6f1c04d..c40c249 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Runs BGD on the given runtime.
*/
package org.apache.reef.examples.group.bgd;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/package-info.java
index 2df45b7..f9d2c02 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Parameters for BGD.
*/
package org.apache.reef.examples.group.bgd.parameters;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/package-info.java
index 44d6736..b4ce1af 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Utility functions for BGD.
*/
package org.apache.reef.examples.group.bgd.utils;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/package-info.java
index fd10d6f..0bd7cbe 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Broadcast Group Communication example.
*/
package org.apache.reef.examples.group.broadcast;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/package-info.java
index 9c763b5..087b9d4 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Parameters for Broadcast group communication.
*/
package org.apache.reef.examples.group.broadcast.parameters;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractVector.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractVector.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractVector.java
index c93cf63..8dfe158 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractVector.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/AbstractVector.java
@@ -20,7 +20,7 @@ package org.apache.reef.examples.group.utils.math;
/**
* Abstract base class for {@link Vector} implementations.
- * <p/>
+ * <p>
* The only methods to be implemented by subclasses are get, set and size.
*/
public abstract class AbstractVector extends AbstractImmutableVector implements Vector {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Window.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Window.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Window.java
index b17639d..5370b0a 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Window.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/Window.java
@@ -23,7 +23,9 @@ import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
-// TODO: Document
+/**
+ * Maintaining a fixed-size queue for sliding window operation.
+ */
public class Window {
private final int maxSize;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/package-info.java
index 394863f..b6ffe87 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/math/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Math utilities for Group Communication.
*/
package org.apache.reef.examples.group.utils.math;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/package-info.java
index 7cb901d..4d7e5ee 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Timer for Group Communication.
*/
package org.apache.reef.examples.group.utils.timer;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/package-info.java
index cd2b79b..0db710d 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/library/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * A library for distributed shell example.
*/
package org.apache.reef.examples.library;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClient.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClient.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClient.java
index 75b5b36..6891917 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClient.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClient.java
@@ -130,7 +130,7 @@ public class SuspendClient {
/**
* Receive notification from the driver that the job had failed.
- * <p/>
+ * <p>
* FailedJob is a proxy for the failed job driver
* (contains job ID and exception thrown from the driver).
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-examples/src/main/java/org/apache/reef/examples/utils/wake/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/utils/wake/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/utils/wake/package-info.java
index fd332a4..0f24bf4 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/utils/wake/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/utils/wake/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Logging and Blocking event handlers.
*/
package org.apache.reef.examples.utils.wake;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataLoader.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataLoader.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataLoader.java
index 8fd71df..34dbbd7 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataLoader.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataLoader.java
@@ -55,7 +55,7 @@ import java.util.logging.Logger;
* the ones that need data loading have a context stacked
* that enables a task to get access to Data via the
* {@link DataSet}.
- * <p/>
+ * <p>
* TODO: Add timeouts
*/
@DriverSide
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataSet.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataSet.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataSet.java
index 413363b..f640f59 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataSet.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/DataSet.java
@@ -25,12 +25,12 @@ import org.apache.reef.io.network.util.Pair;
* A view of the data set to be loaded
* at an evaluator as an iterable of
* key value pairs.
- * <p/>
+ * <p>
* Implementations need not materialize
* and clients should not assume that the
* data is materialized. Any such thing
* is left as a post-processing step.
- * <p/>
+ * <p>
* Client also can't assume that the iterator
* returned here can be restarted
*
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/EvaluatorToPartitionStrategy.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/EvaluatorToPartitionStrategy.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/EvaluatorToPartitionStrategy.java
index d10b4d4..713ed65 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/EvaluatorToPartitionStrategy.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/EvaluatorToPartitionStrategy.java
@@ -25,7 +25,7 @@ import org.apache.reef.driver.catalog.NodeDescriptor;
import org.apache.reef.io.data.loading.impl.NumberedSplit;
/**
- * Interface that tracks the mapping between evaluators & the data partitions
+ * Interface that tracks the mapping between evaluators and the data partitions
* assigned to those evaluators. Its part of the implementation of a
* {@link org.apache.reef.io.data.loading.api.DataLoadingService} that uses the
* Hadoop {@link org.apache.hadoop.mapred.InputFormat} to partition the data and
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/package-info.java
index bfaf449..8d4c9f5 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/api/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Data Loading Service API.
*/
package org.apache.reef.io.data.loading.api;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/AbstractEvaluatorToPartitionStrategy.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/AbstractEvaluatorToPartitionStrategy.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/AbstractEvaluatorToPartitionStrategy.java
index 68bf65a..77f9216 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/AbstractEvaluatorToPartitionStrategy.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/AbstractEvaluatorToPartitionStrategy.java
@@ -161,7 +161,7 @@ public abstract class AbstractEvaluatorToPartitionStrategy implements EvaluatorT
/**
* Get an input split to be assigned to this evaluator.
- * <p/>
+ * <p>
* Allocates one if its not already allocated
*
* @param evaluatorId
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatDataSet.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatDataSet.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatDataSet.java
index aadf09f..6e6e8dd 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatDataSet.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatDataSet.java
@@ -33,7 +33,7 @@ import java.util.Iterator;
/**
* An implementation of {@link DataSet} that reads records using a RecordReader
* encoded inside an InputSplit.
- * <p/>
+ * <p>
* The input split is injected through an external constructor by deserializing
* the input split assigned to this evaluator.
*
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatLoadingService.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatLoadingService.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatLoadingService.java
index 6136d96..430951f 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatLoadingService.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/InputFormatLoadingService.java
@@ -43,10 +43,10 @@ import java.util.logging.Logger;
/**
* An implementation of {@link DataLoadingService}
* that uses the Hadoop {@link org.apache.hadoop.mapred.InputFormat} to find
- * partitions of data & request resources.
- * <p/>
+ * partitions of data and request resources.
+ * <p>
* The InputFormat is taken from the job configurations
- * <p/>
+ * <p>
* The {@link EvaluatorToPartitionStrategy} is injected via Tang,
* in order to support different ways to map evaluators to data
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java
index a9594aa..cfbcfe1 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/NumberedSplit.java
@@ -22,7 +22,7 @@ import org.apache.commons.lang.Validate;
/**
* A tuple of an object of type E and an integer index.
- * Used inside {@link EvaluatorToPartitionStrategy} implementations to
+ * Used inside {@link org.apache.reef.io.data.loading.api.EvaluatorToPartitionStrategy} implementations to
* mark the partitions associated with each {@link org.apache.hadoop.mapred.InputSplit}
*
* @param <E>
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/WritableSerializer.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/WritableSerializer.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/WritableSerializer.java
index d0dd07a..579cffd 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/WritableSerializer.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/WritableSerializer.java
@@ -29,7 +29,7 @@ import java.io.*;
/**
* A serializer class that serializes {@link Writable}s
* into String using the below {@link Codec} that
- * encodes & decodes {@link Writable}s
+ * encodes and decodes {@link Writable}s
* By default this stores the class name in the serialized
* form so that the specific type can be instantiated on
* de-serialization. However, this also needs the jobconf
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/package-info.java
index 627f2f8..bf83fa2 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/data/loading/impl/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Implementations of Data Loading Service.
*/
package org.apache.reef.io.data.loading.impl;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/NetworkConnectionService.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/NetworkConnectionService.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/NetworkConnectionService.java
index bfa88b8..be67bb1 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/NetworkConnectionService.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/NetworkConnectionService.java
@@ -28,21 +28,23 @@ import org.apache.reef.wake.remote.transport.LinkListener;
/**
* NetworkConnectionService.
- *
+ * <p>
* NetworkConnectionService is a service which is designed for communicating messages with each other.
* It creates multiple ConnectionFactories, which create multiple connections.
- *
+ * <p>
* Flow of message transfer:
- * [Downstream]: connection.write(message) -> ConnectionFactory
- * -> src NetworkConnectionService (encode) -> dest NetworkConnectionService.
- * [Upstream]: message -> dest NetworkConnectionService (decode) -> ConnectionFactory -> EventHandler.
- *
+ * <ul>
+ * <li>[Downstream]: {@code connection.write(message) -> ConnectionFactory
+ * -> src NetworkConnectionService (encode) -> dest NetworkConnectionService}.</li>
+ * <li>[Upstream]: {@code message -> dest NetworkConnectionService (decode) -> ConnectionFactory -> EventHandler}.</li>
+ * </ul>
+ * <p>
* Users can register a ConnectionFactory by registering their Codec, EventHandler, LinkListener and end point id.
* When users send messages via connections created by the ConnectionFactory,
- *
+ * <p>
* NetworkConnectionService encodes the messages according to the Codec
* registered in the ConnectionFactory and sends them to the destination NetworkConnectionService.
- *
+ * <p>
* Also, it receives the messages by decoding the messages and forwarding them
* to the corresponding EventHandler registered in the ConnectionFactory.
*/
@@ -58,8 +60,8 @@ public interface NetworkConnectionService extends AutoCloseable {
* is the contact point, which is registered to NameServer through this method.
*
* @param connectionFactoryId a connection factory id
- * @param codec a codec for type <T>
- * @param eventHandler an event handler for type <T>
+ * @param codec a codec for type T
+ * @param eventHandler an event handler for type T
* @param linkListener a link listener
* @param localEndPointId a local end point id
* @return the registered connection factory
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/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 67081d6..8503fb5 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
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Network service exceptions.
*/
package org.apache.reef.io.network.exception;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/OperatorSpec.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/OperatorSpec.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/OperatorSpec.java
index f590fc8..550723b 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/OperatorSpec.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/OperatorSpec.java
@@ -31,7 +31,7 @@ import org.apache.reef.io.serialization.Codec;
public interface OperatorSpec {
/**
- * @return The codec class to be used to serialize & deserialize data
+ * @return The codec class to be used to serialize and deserialize data
* in the group communication operators.
*/
Class<? extends Codec> getDataCodecClass();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java
index 75d0aa4..98f807d 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/CommunicationGroupDriver.java
@@ -30,7 +30,7 @@ import org.apache.reef.tang.annotations.Name;
/**
* The driver side interface of a Communication Group
- * Lets one add opertaors and tasks.
+ * Lets one add operators and tasks.
* Main function is to extract the configuration related
* to the Group Communication for a task in the comm group
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java
index ef72d3f..7c025d2 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/TaskNodeStatus.java
@@ -50,7 +50,7 @@ public interface TaskNodeStatus {
* To be called before sending a ctrl msg to the task
* represented by this node. All ctrl msgs sent to this
* node need to be ACKed.
- * Ctrl msgs will be sent from a src &
+ * Ctrl msgs will be sent from a src and
* ACK sent from the task will be for a src.
* As this is called from the TaskNodeImpl use srcId of msg
* In TaskNodeImpl while processMsg use dstId of msg
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/AllGather.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/AllGather.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/AllGather.java
index 7d1120b..e1e88d9 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/AllGather.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/AllGather.java
@@ -25,7 +25,7 @@ import java.util.List;
/**
* MPI AllGather Operator.
- * <p/>
+ * <p>
* Each task applies this operator on an element of type T. The result will be
* a list of elements constructed using the elements all-gathered at each
* task.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java
index 6054c23..07a8ed6 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Broadcast.java
@@ -25,9 +25,9 @@ import org.apache.reef.tang.annotations.DefaultImplementation;
/**
* MPI Broadcast operator.
- * <p/>
+ * <p>
* The sender or root send's an element that is received by all the receivers or other tasks.
- * <p/>
+ * <p>
* This is an asymmetric operation and hence the differentiation b/w Sender and Receiver.
*/
public interface Broadcast {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java
index bd55629..4ffe90e 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Gather.java
@@ -28,7 +28,7 @@ import java.util.List;
/**
* MPI Gather Operator.
- * <p/>
+ * <p>
* This is an operator where the root is a receiver and there are multiple senders.
* The root or receiver gathers all the elements sent by the senders in a List.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java
index 76688eb..dda628a 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Reduce.java
@@ -28,7 +28,7 @@ import java.util.List;
/**
* MPI Reduce operator.
- * <p/>
+ * <p>
* This is another operator with root being receiver All senders send an element
* to the receiver. These elements are passed through a reduce function and its
* result is made available at the root
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java
index f84bef9..21ced68 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/ReduceScatter.java
@@ -25,7 +25,7 @@ import java.util.List;
/**
* MPI Reduce Scatter operator.
- * <p/>
+ * <p>
* Each task has a list of elements. Assume that each task reduces
* each element in the list to form a list of reduced elements at a dummy root.
* The dummy root then keeps the portion of the list assigned to it and
@@ -36,7 +36,7 @@ public interface ReduceScatter<T> extends GroupCommOperator {
/**
* Apply this operation on elements where counts specify the distribution of
* elements to each task. Ordering is assumed to be default.
- * <p/>
+ * <p>
* Here counts is of the same size as the entire group not just children.
*
* @return List of values that result from applying reduce function on
@@ -48,7 +48,7 @@ public interface ReduceScatter<T> extends GroupCommOperator {
/**
* Apply this operation on elements where counts specify the distribution of
* elements to each task. Ordering is specified using order
- * <p/>
+ * <p>
* Here counts is of the same size as the entire group not just children
*
* @return List of values that result from applying reduce function on
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Scatter.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Scatter.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Scatter.java
index 5ded0a0..60593cf 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Scatter.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/Scatter.java
@@ -28,7 +28,7 @@ import java.util.List;
/**
* MPI Scatter operator
- * <p/>
+ * <p>
* Scatter a list of elements to the receivers The receivers will receive a
* sub-list of elements targeted for them. Supports non-uniform distribution
* through the specification of counts
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/package-info.java
index 39f3f49..b66aef0 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/operators/package-info.java
@@ -23,9 +23,9 @@
* for symmetric operations unlike MPI which provides symmetric operations
* for all operations.
*
- * The interface is asymmetric in the sense that Senders & Receivers are
+ * The interface is asymmetric in the sense that Senders and Receivers are
* separated out for operations like Scatter and Gather. All participants
- * do not execute the same function. A sender sends & a receiver receives.
+ * do not execute the same function. A sender sends and a receiver receives.
*
* The interface only concentrates on the data part because we are on the
* data-plane of things in REEF. The control information is embedded in the
@@ -39,7 +39,7 @@
* One thing implicit in MPI operations is the ordering of processors based
* on their ranks which determines the order of operations. For ex., if we
* scatter an array of 10 elements into 10 processors, then which processor
- * gets the 1st entry & so on is based on the rank.
+ * gets the 1st entry and so on is based on the rank.
*
* In our case we do not have any ranks associated with tasks. Instead,
* by default we use the lexicographic order of the task ids. These can
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/package-info.java
index ae78d55..ae35b7c 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Elastic Group Communications API.
*/
package org.apache.reef.io.network.group.api;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java
index 9ea056b..49a20ef 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/GroupCommClient.java
@@ -34,7 +34,7 @@ import org.apache.reef.tang.annotations.Name;
public interface GroupCommClient {
/**
- * @param string
+ * @param groupName a group name
* @return The communication group client with the given name that gives access
* to the operators configured on it that will be used to do group communication
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/NodeStruct.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/NodeStruct.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/NodeStruct.java
index 0cc48c4..7a3ff80 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/NodeStruct.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/NodeStruct.java
@@ -23,10 +23,10 @@ import org.apache.reef.io.network.group.impl.GroupCommunicationMessage;
/**
* The actual node that is part of the operator topology
*
- * Receives data from the handlers & provides them to the
+ * Receives data from the handlers and provides them to the
* operators/OperatorTopologyStruct when they need it.
*
- * This implementation decouples the send & receive.
+ * This implementation decouples the send and receive.
*/
public interface NodeStruct {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopology.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopology.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopology.java
index 7bc181b..391b167 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopology.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopology.java
@@ -28,18 +28,18 @@ import java.util.Map;
/**
* Represents the local topology of tasks for an operator. It
- * provides methods to send/rcv from parents & children
- * <p/>
- * Every operator is an EventHandler<GroupCommunicationMessage>
+ * provides methods to send/rcv from parents and children
+ * <p>
+ * Every operator is an {@code EventHandler<GroupCommunicationMessage>}
* and it will use an instance of this type to delegate the
* handling of the message and also uses it to communicate
* with its parents and children
- * <p/>
+ * <p>
* This is an operator facing interface. The actual topology is
* maintained in OperatorTopologyStruct. Current strategy is to
* maintain two versions of the topology and current operations
* are always delegated to effectiveTopology and the baseTopology
- * is updated while initialization & when user calls updateTopology.
+ * is updated while initialization and when user calls updateTopology.
* So this is only a wrapper around the two versions of topologies
* and manages when to create/update them based on the messages from
* the driver.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopologyStruct.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopologyStruct.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopologyStruct.java
index 4d659a3..443e6b7 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopologyStruct.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/OperatorTopologyStruct.java
@@ -33,7 +33,7 @@ import java.util.Set;
* The actual local topology maintaining the
* children and parent that reacts to update
* and data msgs. The actual nodes are represented
- * by NodeStruct and it handles receiving &
+ * by NodeStruct and it handles receiving and
* providing data
*/
public interface OperatorTopologyStruct {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CommunicationGroupDriverImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CommunicationGroupDriverImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CommunicationGroupDriverImpl.java
index 8312920..6efa128 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CommunicationGroupDriverImpl.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/CommunicationGroupDriverImpl.java
@@ -87,7 +87,7 @@ public class CommunicationGroupDriverImpl implements CommunicationGroupDriver {
private final Class<? extends Topology> topologyClass;
/**
- * @Deprecated in 0.14. Use Tang to obtain an instance of this instead.
+ * @deprecated in 0.14. Use Tang to obtain an instance of this instead.
*/
@Deprecated
public CommunicationGroupDriverImpl(final Class<? extends Name<String>> groupName,
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java
index cb6b3ca..479cae2 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/GroupCommDriverImpl.java
@@ -71,8 +71,8 @@ import java.util.logging.Logger;
/**
* Sets up various stages to handle REEF events and adds the per communication
* group stages to them whenever a new communication group is created.
- * <p/>
- * Also starts the NameService & the NetworkService on the driver
+ * <p>
+ * Also starts the NameService and the NetworkService on the driver
*/
public class GroupCommDriverImpl implements GroupCommServiceDriver {
private static final Logger LOG = Logger.getLogger(GroupCommDriverImpl.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java
index 574a326..a2f9f6b 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/TaskNodeStatusImpl.java
@@ -110,7 +110,7 @@ public class TaskNodeStatusImpl implements TaskNodeStatus {
/**
* This needs to happen in line rather than in a stage because we need to note.
* the messages we send to the tasks before we start processing msgs from the
- * nodes.(Acks & Topology msgs)
+ * nodes.(Acks and Topology msgs)
*/
@Override
public void expectAckFor(final Type msgType, final String srcId) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/package-info.java
index a1491f6..899dcbf 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/driver/package-info.java
@@ -27,7 +27,7 @@
* specified.
*
* After the GroupCommDriver is configured the driver would want to submit
- * tasks with the Communication Groups & their operators configured. To do
+ * tasks with the Communication Groups and their operators configured. To do
* that the user has to create a partial task configuration containing his
* set of configurations and add it to the relevant communication group.
* Based on whether the given task is a Master/Slave different roles for
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/package-info.java
index 0e9b6d8..85d3296 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Implementations for Elastic Group Communications.
*/
package org.apache.reef.io.network.group.impl;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java
index 8b5ba52..86e6f55 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyImpl.java
@@ -103,18 +103,18 @@ public class OperatorTopologyImpl implements OperatorTopology {
* received TopologySetup but not yet created the effectiveTopology.
* Most times the msgs in the deletionDeltas will be discarded as stale
* msgs
- * <p/>
+ * <p>
* No synchronization is needed while handling *Dead messages.
- * There 2 states: UpdatingTopo & NotUpdatingTopo
+ * There 2 states: UpdatingTopo and NotUpdatingTopo
* If UpdatingTopo, deltas.put still takes care of adding this msg to effTop through baseTopo changes.
* If not, we add to effTopo. So we are good.
- * <p/>
+ * <p>
* However, for data msgs synchronization is needed. Look at doc of
* DataHandlingStage
- * <p/>
+ * <p>
* Adding to deletionDeltas should be outside
* effTopo!=null block. There is a rare possibility that during initialization
- * just after baseTopo is created(so deltas will be ignored) & just before
+ * just after baseTopo is created(so deltas will be ignored) and just before
* effTopo is created(so effTopo will be null) where we can miss a deletion
* msg if not added to deletionDelta because this method is synchronized
*/
@@ -296,7 +296,7 @@ public class OperatorTopologyImpl implements OperatorTopology {
/**
* Blocking method that waits till the base topology is updated Unblocks when.
* we receive a TopologySetup msg from driver
- * <p/>
+ * <p>
* Will also update the effective topology when the base topology is updated
* so that creation of effective topology is limited to just this method and
* refresh will only refresh the effective topology with deletion msgs from
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyStructImpl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyStructImpl.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyStructImpl.java
index 18afeed..ff2f45c 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyStructImpl.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/OperatorTopologyStructImpl.java
@@ -450,7 +450,7 @@ public class OperatorTopologyStructImpl implements OperatorTopologyStruct {
* Updates the topology structure with the received
* message. Does not make assumptions about msg order
* Tries to handle OOS msgs
- * <p/>
+ * <p>
* Expects only control messages
*/
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java
index 902ccf7..b04de32 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/ConcurrentCountingMap.java
@@ -28,7 +28,7 @@ import java.util.logging.Logger;
/**
* Utility map class that wraps a CountingMap.
* in a ConcurrentMap
- * Equivalent to Map<K,Map<V,Integer>>
+ * Equivalent to {@code Map<K,Map<V,Integer>>}
*/
public class ConcurrentCountingMap<K, V> {
private static final Logger LOG = Logger.getLogger(ConcurrentCountingMap.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java
index 0a21674..da64a52 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/SetMap.java
@@ -23,7 +23,7 @@ import org.apache.reef.io.network.group.impl.driver.MsgKey;
import java.util.*;
/**
- * Map from K to Set<V>.
+ * Map from K to {@code Set<V>}.
*/
public class SetMap<K, V> {
private final Map<K, Set<V>> map = new HashMap<>();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/package-info.java
index 98e25e6..42ae25d 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/local/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Implementations for local filesystem-based storage service.
*/
package org.apache.reef.io.storage.local;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/package-info.java
index b5207f3..3a28861 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * APIs for Storage Service.
*/
package org.apache.reef.io.storage;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/RamSpool.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/RamSpool.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/RamSpool.java
index 8534195..9f4eb62 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/RamSpool.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/RamSpool.java
@@ -29,7 +29,7 @@ import java.util.List;
/**
* A SpoolFile implementation that is backed by RAM.
- * <p/>
+ * <p>
* It uses an ArrayList to store the objects in.
*/
public final class RamSpool<T> implements Spool<T> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/package-info.java
index 79f5c3b..1db331b 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/ram/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Implementations for RAM-based storage service.
*/
package org.apache.reef.io.storage.ram;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/util/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/util/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/util/package-info.java
index 1e173f5..aba3f0b 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/util/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/storage/util/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Utilities for storage services.
*/
package org.apache.reef.io.storage.util;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightDriverConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightDriverConfiguration.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightDriverConfiguration.java
index 72ec88b..f14c15e 100644
--- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightDriverConfiguration.java
+++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/HDInsightDriverConfiguration.java
@@ -51,16 +51,16 @@ import org.apache.reef.tang.formats.RequiredParameter;
public final class HDInsightDriverConfiguration extends ConfigurationModuleBuilder {
/**
- * @see org.apache.reef.runtime.yarn.driver.parameters.JobSubmissionDirectory
+ * @see org.apache.reef.driver.parameters.JobSubmissionDirectory
*/
public static final RequiredParameter<String> JOB_SUBMISSION_DIRECTORY = new RequiredParameter<>();
/**
- * @see org.apache.reef.runtime.yarn.driver.parameters.YarnHeartbeatPeriod.class
+ * @see org.apache.reef.runtime.yarn.driver.parameters.YarnHeartbeatPeriod
*/
public static final OptionalParameter<Integer> YARN_HEARTBEAT_INTERVAL = new OptionalParameter<>();
/**
- * @see JobIdentifier.class
+ * @see JobIdentifier
*/
public static final RequiredParameter<String> JOB_IDENTIFIER = new RequiredParameter<>();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfiguration.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfiguration.java
index 61434b1..f1b8ee9 100644
--- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfiguration.java
+++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/UnsafeHDInsightRuntimeConfiguration.java
@@ -88,7 +88,7 @@ public final class UnsafeHDInsightRuntimeConfiguration extends ConfigurationModu
* @return the RuntimeConfiguration that is stored in a file refered to by the environment
* variable HDInsightRuntimeConfiguration.HDINSIGHT_CONFIGURATION_FILE_ENVIRONMENT_VARIABLE.
* @throws IOException
- * @see HDInsightRuntimeConfiguration.HDINSIGHT_CONFIGURATION_FILE_ENVIRONMENT_VARIABLE
+ * @see HDInsightRuntimeConfiguration#HDINSIGHT_CONFIGURATION_FILE_ENVIRONMENT_VARIABLE
*/
public static Configuration fromEnvironment() throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/sslhacks/UnsafeTrustManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/sslhacks/UnsafeTrustManager.java b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/sslhacks/UnsafeTrustManager.java
index b1bd56f..7956478 100644
--- a/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/sslhacks/UnsafeTrustManager.java
+++ b/lang/java/reef-runtime-hdinsight/src/main/java/org/apache/reef/runtime/hdinsight/client/sslhacks/UnsafeTrustManager.java
@@ -25,7 +25,7 @@ import java.security.cert.X509Certificate;
/**
* A TrustManager that trusts all certificates. Basically the "GOTO FAIL" bug implemented in Java.
- * <p/>
+ * <p>
* Hence: DO NOT USE THIS CLASS UNLESS DEBUGGING.
*/
final class UnsafeTrustManager implements X509TrustManager {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-hdinsight/src/test/java/org/apache/reef/runtime/hdinsight/TestHDInsightRESTJsonSerialization.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-hdinsight/src/test/java/org/apache/reef/runtime/hdinsight/TestHDInsightRESTJsonSerialization.java b/lang/java/reef-runtime-hdinsight/src/test/java/org/apache/reef/runtime/hdinsight/TestHDInsightRESTJsonSerialization.java
index 3bd776d..0dbe4c5 100644
--- a/lang/java/reef-runtime-hdinsight/src/test/java/org/apache/reef/runtime/hdinsight/TestHDInsightRESTJsonSerialization.java
+++ b/lang/java/reef-runtime-hdinsight/src/test/java/org/apache/reef/runtime/hdinsight/TestHDInsightRESTJsonSerialization.java
@@ -6,9 +6,9 @@
* 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
- * <p/>
+ * <p>
* http://www.apache.org/licenses/LICENSE-2.0
- * <p/>
+ * <p>
* 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
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/LocalClasspathProvider.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/LocalClasspathProvider.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/LocalClasspathProvider.java
index bec299e..abc031d 100644
--- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/LocalClasspathProvider.java
+++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/LocalClasspathProvider.java
@@ -31,7 +31,7 @@ import java.util.List;
/**
* RuntimeClasspathProvider for the local runtime.
- * <p/>
+ * <p>
* The prefix for the local runtime is empty, the suffix is the classpath of the current JVM. That classpath is filtered
* to not contain subfolders of JAVA_HOME. Also, duplicates are removed.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverFiles.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverFiles.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverFiles.java
index 9ddf685..6e0e9d1 100644
--- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverFiles.java
+++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/DriverFiles.java
@@ -32,7 +32,7 @@ import java.util.logging.Logger;
/**
* Represents the files added to a driver.
- * <p/>
+ * <p>
* This class is constructed via the from() method that instantiates it based on a JobSubmissionProto
*/
final class DriverFiles {
@@ -120,7 +120,7 @@ final class DriverFiles {
/**
* Copies this set of files to the destination folder given.
- * <p/>
+ * <p>
* Will attempt to create symbolic links for the files to the destination
* folder. If the filesystem does not support symbolic links or the user
* does not have appropriate permissions, the entire file will be copied instead.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/FileSet.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/FileSet.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/FileSet.java
index f80fb04..8d3dce0 100644
--- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/FileSet.java
+++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/FileSet.java
@@ -39,9 +39,9 @@ final class FileSet {
/**
* Add a file to the FileSet.
- * <p/>
+ * <p>
* If the file is a directory, it is turned into a JAR and the resulting JAR is added.
- * <p/>
+ * <p>
* Files already added will be ignored.
*
* @param file the file to be added.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/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 33e3c4a..fbf299c 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
@@ -51,7 +51,7 @@ public class LocalRuntimeConfiguration extends ConfigurationModuleBuilder {
* The folder in which the sub-folders, one per Node, will be created. Those will contain one folder per
* Evaluator instantiated on the virtual node. Those inner folders will be named by the time when the Evaluator was
* launched.
- * <p/>
+ * <p>
* If none is given, a folder "REEF_LOCAL_RUNTIME" will be created in the local directory.
*/
public static final OptionalParameter<String> RUNTIME_ROOT_FOLDER = new OptionalParameter<>();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java
index 99317b8..a4ecdb5 100644
--- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java
+++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/client/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * client-side event handlers for the local resourcemanager.
+ * Client-side event handlers for the local resourcemanager.
*/
package org.apache.reef.runtime.local.client;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/Container.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/Container.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/Container.java
index ac36d1e..11a5ae8 100644
--- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/Container.java
+++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/Container.java
@@ -25,7 +25,7 @@ import java.util.List;
/**
* Represents a Container: A slice of a machine.
- * <p/>
+ * <p>
* In the case of the local resourcemanager, this slice is always the one of the machine where the job was submitted.
*/
@Private
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ResourceManager.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ResourceManager.java b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ResourceManager.java
index b1f0097..fb51de0 100644
--- a/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ResourceManager.java
+++ b/lang/java/reef-runtime-local/src/main/java/org/apache/reef/runtime/local/driver/ResourceManager.java
@@ -112,7 +112,7 @@ public final class ResourceManager {
/**
* Receives a resource request.
- * <p/>
+ * <p>
* If the request can be met, it will also be satisfied immediately.
*
* @param resourceRequest the resource request to be handled.
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/package-info.java
index eab89dd..687d6b6 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Client-side event handlers for Mesos resourcemanager.
*/
package org.apache.reef.runtime.mesos.client;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/package-info.java
index 3661d66..5f09881 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/client/parameters/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Client-side parameters for Mesos job submission.
*/
package org.apache.reef.runtime.mesos.client.parameters;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java
index eadfe98..6034b45 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/MesosDriverConfiguration.java
@@ -45,7 +45,7 @@ import org.apache.reef.wake.impl.SingleThreadStage;
*/
public final class MesosDriverConfiguration extends ConfigurationModuleBuilder {
/**
- * @see JobIdentifier.class
+ * @see JobIdentifier
*/
public static final RequiredParameter<String> JOB_IDENTIFIER = new RequiredParameter<>();
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/package-info.java
index 396b53a..c262096 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Driver-side event handlers for Mesos resourcemanager.
*/
package org.apache.reef.runtime.mesos.driver;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/package-info.java
index f45460b..a885c2d 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/driver/parameters/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Driver-side parameters for Mesos job submission.
*/
package org.apache.reef.runtime.mesos.driver.parameters;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/package-info.java
index 5e520e5..7d7a8e0 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Evaluator-side event handlers for Mesos resourcemanager.
*/
package org.apache.reef.runtime.mesos.evaluator;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/package-info.java
index e8a5f53..4274720 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/evaluator/parameters/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Evaluator-side parameters for Mesos job.
*/
package org.apache.reef.runtime.mesos.evaluator.parameters;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/package-info.java
index ff5cb56..60cb38c 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * An YARN implementation of REEF that uses Mesos slaves for execution.
*/
package org.apache.reef.runtime.mesos;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/package-info.java b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/package-info.java
index a9c9905..253ccd7 100644
--- a/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/package-info.java
+++ b/lang/java/reef-runtime-mesos/src/main/java/org/apache/reef/runtime/mesos/util/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Utility for Mesos runtime.
*/
package org.apache.reef.runtime.mesos.util;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java
index 743120b..72f14f5 100644
--- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java
+++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/ClassPathBuilder.java
@@ -28,7 +28,7 @@ import java.util.List;
/**
* A helper class to assemble a class path.
- * <p/>
+ * <p>
* It uses a TreeSet internally for both a prefix and a suffix of the classpath. This makes sure that duplicate entries
* are avoided.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/YarnSubmissionHelper.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/YarnSubmissionHelper.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/YarnSubmissionHelper.java
index e21d81b..2fa8602 100644
--- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/YarnSubmissionHelper.java
+++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/YarnSubmissionHelper.java
@@ -6,9 +6,9 @@
* 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
- * <p/>
+ * <p>
* http://www.apache.org/licenses/LICENSE-2.0
- * <p/>
+ * <p>
* 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
@@ -232,7 +232,7 @@ public final class YarnSubmissionHelper implements Closeable{
/**
* Extract the desired driver memory from jobSubmissionProto.
- * <p/>
+ * <p>
* returns maxMemory if that desired amount is more than maxMemory
*/
private int getMemory(final int requestedMemory) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/package-info.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/package-info.java
index 368033a..3f95bdf 100644
--- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/package-info.java
+++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Client-side event handlers for YARN resourcemanager.
*/
package org.apache.reef.runtime.yarn.client;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/0a5c90cd/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/parameters/JobPriority.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/parameters/JobPriority.java b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/parameters/JobPriority.java
index f5ba0f7..bc594bf 100644
--- a/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/parameters/JobPriority.java
+++ b/lang/java/reef-runtime-yarn/src/main/java/org/apache/reef/runtime/yarn/client/parameters/JobPriority.java
@@ -22,7 +22,7 @@ import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
/**
- * The prioroty of the submitted job.
+ * The priority of the submitted job.
*/
@NamedParameter(doc = "The job priority.", default_value = "0", short_name = "yarn_priority")
public final class JobPriority implements Name<Integer> {