You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by bg...@apache.org on 2015/11/07 15:46:58 UTC
incubator-reef git commit: [REEF-524] Add missing Javadoc
comments/triage TODO comments in reef-examples*
Repository: incubator-reef
Updated Branches:
refs/heads/master 9ea4d6a74 -> 06356322a
[REEF-524] Add missing Javadoc comments/triage TODO comments in reef-examples*
JIRA:
[REEF-524](https://issues.apache.org/jira/browse/REEF-524)
Pull request:
This closes #619
Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/06356322
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/06356322
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/06356322
Branch: refs/heads/master
Commit: 06356322a729d5de6a363cda79dde56483d38f91
Parents: 9ea4d6a
Author: Mariia Mykhailova <ma...@apache.org>
Authored: Thu Nov 5 15:45:11 2015 -0800
Committer: Byung-Gon Chun <bg...@apache.org>
Committed: Sat Nov 7 23:46:02 2015 +0900
----------------------------------------------------------------------
lang/java/reef-examples-clr/pom.xml | 11 +++++++++++
.../org/apache/reef/examples/helloCLR/HelloCLR.java | 2 +-
.../org/apache/reef/examples/helloCLR/HelloDriver.java | 4 ++--
lang/java/reef-examples-hdinsight/pom.xml | 11 +++++++++++
.../org/apache/reef/examples/hello/package-info.java | 2 +-
lang/java/reef-examples/pom.xml | 11 +++++++++++
.../reef/examples/data/loading/DataLoadingREEF.java | 6 ++++++
.../apache/reef/examples/data/loading/LineCounter.java | 6 ++++++
.../org/apache/reef/examples/group/bgd/BGDDriver.java | 3 +++
.../apache/reef/examples/group/bgd/ControlMessages.java | 3 +++
.../org/apache/reef/examples/group/bgd/ExampleList.java | 2 +-
.../examples/group/bgd/LineSearchReduceFunction.java | 3 +++
.../group/bgd/LossAndGradientReduceFunction.java | 3 +++
.../org/apache/reef/examples/group/bgd/MasterTask.java | 3 +++
.../org/apache/reef/examples/group/bgd/SlaveTask.java | 3 +++
.../examples/group/bgd/loss/LogisticLossFunction.java | 3 +++
.../group/bgd/loss/WeightedLogisticLossFunction.java | 7 +++++--
.../group/bgd/operatornames/MinEtaBroadcaster.java | 3 +++
.../group/bgd/parameters/AllCommunicationGroup.java | 3 +++
.../group/bgd/parameters/BGDControlParameters.java | 3 +++
.../reef/examples/group/bgd/parameters/BGDLossType.java | 3 +++
.../reef/examples/group/bgd/parameters/NumSplits.java | 3 +--
.../reef/examples/group/bgd/parameters/Timeout.java | 5 +++--
.../apache/reef/examples/group/bgd/utils/StepSizes.java | 4 +++-
.../reef/examples/group/bgd/utils/SubConfiguration.java | 3 +++
.../reef/examples/group/broadcast/BroadcastDriver.java | 12 ++++++++++++
.../reef/examples/group/broadcast/BroadcastREEF.java | 12 +++++++++---
.../reef/examples/group/broadcast/ControlMessages.java | 3 +++
.../reef/examples/group/broadcast/MasterTask.java | 3 +++
.../group/broadcast/ModelReceiveAckReduceFunction.java | 2 +-
.../apache/reef/examples/group/broadcast/SlaveTask.java | 2 +-
.../broadcast/parameters/AllCommunicationGroup.java | 2 +-
.../broadcast/parameters/ControlMessageBroadcaster.java | 3 +++
.../group/broadcast/parameters/ModelBroadcaster.java | 3 +++
.../broadcast/parameters/ModelReceiveAckReducer.java | 3 +++
.../apache/reef/examples/group/utils/timer/Timer.java | 3 +++
.../org/apache/reef/examples/hello/HelloREEFMesos.java | 3 +++
.../java/org/apache/reef/examples/suspend/Control.java | 9 +++++++++
.../java/org/apache/reef/examples/suspend/Launch.java | 1 -
.../org/apache/reef/examples/suspend/SuspendClient.java | 3 +++
.../reef/examples/suspend/SuspendClientControl.java | 3 +++
.../org/apache/reef/examples/suspend/SuspendDriver.java | 2 +-
.../apache/reef/examples/suspend/SuspendTestTask.java | 3 +++
.../org/apache/reef/examples/suspend/package-info.java | 2 +-
.../org/apache/reef/examples/hello/HelloHttpTest.java | 3 +++
.../org/apache/reef/examples/hello/package-info.java | 2 +-
.../reef/examples/suspend/ObjectWritableCodecTest.java | 3 +++
.../org/apache/reef/examples/suspend/package-info.java | 2 +-
.../reef/tang/formats/TestConfigurationModule.java | 2 +-
49 files changed, 172 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples-clr/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples-clr/pom.xml b/lang/java/reef-examples-clr/pom.xml
index 8a8aee4..004583e 100644
--- a/lang/java/reef-examples-clr/pom.xml
+++ b/lang/java/reef-examples-clr/pom.xml
@@ -83,6 +83,17 @@ under the License.
<build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <configuration>
+ <configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloCLR.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloCLR.java b/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloCLR.java
index d97b44a..983235a 100644
--- a/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloCLR.java
+++ b/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloCLR.java
@@ -40,8 +40,8 @@ public final class HelloCLR {
/**
* The name of the class hierarchy file.
+ * TODO[JIRA REEF-919] delete this constant
*/
- // TODO: Make this a config option
public static final String CLASS_HIERARCHY_FILENAME = "HelloTask.bin";
private static final Logger LOG = Logger.getLogger(HelloCLR.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java b/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
index 1bfd348..fdb18d9 100644
--- a/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
+++ b/lang/java/reef-examples-clr/src/main/java/org/apache/reef/examples/helloCLR/HelloDriver.java
@@ -95,9 +95,9 @@ public final class HelloDriver {
* @return
*/
private static ClassHierarchy loadClassHierarchy() {
- // TODO The file should be created by AvroClassHierarchySerializer
+ // TODO[JIRA REEF-400] The file should be created by AvroClassHierarchySerializer
try (final InputStream chin = new FileInputStream(HelloCLR.CLASS_HIERARCHY_FILENAME)) {
- // TODO Use AvroClassHierarchySerializer instead
+ // TODO[JIRA REEF-400] Use AvroClassHierarchySerializer instead
final ClassHierarchyProto.Node root = ClassHierarchyProto.Node.parseFrom(chin); // A
final ClassHierarchy ch = new ProtocolBufferClassHierarchy(root);
return ch;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples-hdinsight/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples-hdinsight/pom.xml b/lang/java/reef-examples-hdinsight/pom.xml
index 3d19af7..73a9990 100644
--- a/lang/java/reef-examples-hdinsight/pom.xml
+++ b/lang/java/reef-examples-hdinsight/pom.xml
@@ -84,6 +84,17 @@ under the License.
<build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <configuration>
+ <configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/package-info.java b/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/package-info.java
index d2fe07b..769ae26 100644
--- a/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/package-info.java
+++ b/lang/java/reef-examples-hdinsight/src/main/java/org/apache/reef/examples/hello/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * The Hello REEF example for the HDInsight.
*/
package org.apache.reef.examples.hello;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/pom.xml b/lang/java/reef-examples/pom.xml
index d3b8277..428e243 100644
--- a/lang/java/reef-examples/pom.xml
+++ b/lang/java/reef-examples/pom.xml
@@ -103,6 +103,17 @@ under the License.
<build>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <configuration>
+ <configLocation>lang/java/reef-common/src/main/resources/checkstyle-strict.xml</configLocation>
+ </configuration>
+ </plugin>
+ </plugins>
+ </pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
index e054688..86189a3 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/DataLoadingREEF.java
@@ -126,11 +126,17 @@ public final class DataLoadingREEF {
public static final class Local implements Name<Boolean> {
}
+ /**
+ * Number of minutes before timeout.
+ */
@NamedParameter(doc = "Number of minutes before timeout",
short_name = "timeout", default_value = "2")
public static final class TimeOut implements Name<Integer> {
}
+ /**
+ * Input path.
+ */
@NamedParameter(short_name = "input")
public static final class InputDir implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/LineCounter.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/LineCounter.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/LineCounter.java
index 6690fe0..0a567d7 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/LineCounter.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/data/loading/LineCounter.java
@@ -58,6 +58,9 @@ public class LineCounter {
this.completedDataTasks.set(dataLoadingService.getNumberOfPartitions());
}
+ /**
+ * Handler for ActiveContext.
+ */
public class ContextActiveHandler implements EventHandler<ActiveContext> {
@Override
@@ -103,6 +106,9 @@ public class LineCounter {
}
}
+ /**
+ * Completed task handler.
+ */
public class TaskCompletedHandler implements EventHandler<CompletedTask> {
@Override
public void onNext(final CompletedTask completedTask) {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDDriver.java
index 8b382fc..1277e46 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDDriver.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/BGDDriver.java
@@ -60,6 +60,9 @@ import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Driver for BGD example.
+ */
@DriverSide
@Unit
public class BGDDriver {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ControlMessages.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ControlMessages.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ControlMessages.java
index 277c9e8..6e49647 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ControlMessages.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ControlMessages.java
@@ -20,6 +20,9 @@ package org.apache.reef.examples.group.bgd;
import java.io.Serializable;
+/**
+ * Control messages used in BGD example.
+ */
public enum ControlMessages implements Serializable {
ComputeGradientWithModel,
ComputeGradientWithMinEta,
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ExampleList.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ExampleList.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ExampleList.java
index 9a3b7d4..088de71 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ExampleList.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/ExampleList.java
@@ -32,7 +32,7 @@ import java.util.logging.Level;
import java.util.logging.Logger;
/**
- *
+ * The list of BGD examples.
*/
public class ExampleList {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LineSearchReduceFunction.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LineSearchReduceFunction.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LineSearchReduceFunction.java
index ae2ea81..c05aaa5 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LineSearchReduceFunction.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LineSearchReduceFunction.java
@@ -25,6 +25,9 @@ import org.apache.reef.io.network.util.Pair;
import javax.inject.Inject;
+/**
+ * Reduce function implementing line search.
+ */
public class LineSearchReduceFunction implements Reduce.ReduceFunction<Pair<Vector, Integer>> {
@Inject
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LossAndGradientReduceFunction.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LossAndGradientReduceFunction.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LossAndGradientReduceFunction.java
index 2cc6d54..4867ba6 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LossAndGradientReduceFunction.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/LossAndGradientReduceFunction.java
@@ -25,6 +25,9 @@ import org.apache.reef.io.network.util.Pair;
import javax.inject.Inject;
+/**
+ * Loss and gradient reduce function.
+ */
public class LossAndGradientReduceFunction
implements ReduceFunction<Pair<Pair<Double, Integer>, Vector>> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/MasterTask.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/MasterTask.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/MasterTask.java
index 0db38e5..490201a 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/MasterTask.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/MasterTask.java
@@ -42,6 +42,9 @@ import java.util.ArrayList;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Master task for BGD example.
+ */
public class MasterTask implements Task {
public static final String TASK_ID = "MasterTask";
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/SlaveTask.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/SlaveTask.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/SlaveTask.java
index 5420468..02d6853 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/SlaveTask.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/SlaveTask.java
@@ -38,6 +38,9 @@ import javax.inject.Inject;
import java.util.List;
import java.util.logging.Logger;
+/**
+ * Slave task for BGD example.
+ */
public class SlaveTask implements Task {
private static final Logger LOG = Logger.getLogger(SlaveTask.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/LogisticLossFunction.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/LogisticLossFunction.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/LogisticLossFunction.java
index 8b74058..bfcaa91 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/LogisticLossFunction.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/LogisticLossFunction.java
@@ -20,6 +20,9 @@ package org.apache.reef.examples.group.bgd.loss;
import javax.inject.Inject;
+/**
+ * Logistic {@link LossFunction}.
+ */
public final class LogisticLossFunction implements LossFunction {
/**
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/WeightedLogisticLossFunction.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/WeightedLogisticLossFunction.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/WeightedLogisticLossFunction.java
index 5cb65f4..4e72661 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/WeightedLogisticLossFunction.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/loss/WeightedLogisticLossFunction.java
@@ -20,6 +20,9 @@ package org.apache.reef.examples.group.bgd.loss;
import javax.inject.Inject;
+/**
+ * Weighted logistic {@link LossFunction}.
+ */
public final class WeightedLogisticLossFunction implements LossFunction {
private static final double POS = 0.0025;
@@ -33,8 +36,8 @@ public final class WeightedLogisticLossFunction implements LossFunction {
*/
@Inject
public WeightedLogisticLossFunction() {
- this.posWeight = (this.POS + this.NEG) / (2 * this.POS);
- this.negWeight = (this.POS + this.NEG) / (2 * this.NEG);
+ this.posWeight = (POS + NEG) / (2 * POS);
+ this.negWeight = (POS + NEG) / (2 * NEG);
}
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/operatornames/MinEtaBroadcaster.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/operatornames/MinEtaBroadcaster.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/operatornames/MinEtaBroadcaster.java
index 9a2a967..7c1cce4 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/operatornames/MinEtaBroadcaster.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/operatornames/MinEtaBroadcaster.java
@@ -21,6 +21,9 @@ package org.apache.reef.examples.group.bgd.operatornames;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * The name of the MinEta broadcast operator.
+ */
@NamedParameter()
public final class MinEtaBroadcaster implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/AllCommunicationGroup.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/AllCommunicationGroup.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/AllCommunicationGroup.java
index dc914ef..29a1fc6 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/AllCommunicationGroup.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/AllCommunicationGroup.java
@@ -21,6 +21,9 @@ package org.apache.reef.examples.group.bgd.parameters;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * Communication group name.
+ */
@NamedParameter()
public final class AllCommunicationGroup implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDControlParameters.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDControlParameters.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDControlParameters.java
index 1a6d495..872b88f 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDControlParameters.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDControlParameters.java
@@ -26,6 +26,9 @@ import org.apache.reef.tang.formats.CommandLine;
import javax.inject.Inject;
+/**
+ * Control parameters for BGD example.
+ */
public final class BGDControlParameters {
private final int dimensions;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDLossType.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDLossType.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDLossType.java
index 3f56ac7..3c3463a 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDLossType.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/BGDLossType.java
@@ -28,6 +28,9 @@ import javax.inject.Inject;
import java.util.HashMap;
import java.util.Map;
+/**
+ * Type of loss function used in example.
+ */
public class BGDLossType {
private static final Map<String, Class<? extends LossFunction>> LOSS_FUNCTIONS =
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/NumSplits.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/NumSplits.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/NumSplits.java
index b5bf63a..9ba75a3 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/NumSplits.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/NumSplits.java
@@ -22,9 +22,8 @@ import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
/**
- *
+ * Number of splits.
*/
-// TODO: Document
@NamedParameter(short_name = "splits", default_value = "5")
public final class NumSplits implements Name<Integer> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Timeout.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Timeout.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Timeout.java
index d8589c9..234540a 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Timeout.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/parameters/Timeout.java
@@ -21,8 +21,9 @@ package org.apache.reef.examples.group.bgd.parameters;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
-
-// TODO: Document
+/**
+ * Timeout.
+ */
@NamedParameter(short_name = "timeout", default_value = "2")
public final class Timeout implements Name<Integer> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/StepSizes.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/StepSizes.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/StepSizes.java
index afc0235..a8ef530 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/StepSizes.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/StepSizes.java
@@ -23,6 +23,9 @@ import java.util.Arrays;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Step sizes array.
+ */
public class StepSizes {
private static final Logger LOG = Logger.getLogger(StepSizes.class.getName());
@@ -52,7 +55,6 @@ public class StepSizes {
}
public static void main(final String[] args) {
- // TODO Auto-generated method stub
final StepSizes t = new StepSizes();
LOG.log(Level.INFO, "OUT: {0}", Arrays.toString(t.getT()));
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/SubConfiguration.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/SubConfiguration.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/SubConfiguration.java
index 6c97b37..dff4dc3 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/SubConfiguration.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/bgd/utils/SubConfiguration.java
@@ -33,6 +33,9 @@ import org.apache.reef.tang.formats.ConfigurationSerializer;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Subconfiguration: limit given configuration to a given list of classes.
+ */
public final class SubConfiguration {
private static final Logger LOG = Logger.getLogger(SubConfiguration.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
index 4908baf..eabda77 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastDriver.java
@@ -56,6 +56,9 @@ import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Driver for broadcast example.
+ */
@DriverSide
@Unit
public class BroadcastDriver {
@@ -148,6 +151,9 @@ public class BroadcastDriver {
}
}
+ /**
+ * FailedTask handler.
+ */
public class FailedTaskHandler implements EventHandler<FailedTask> {
@Override
@@ -179,6 +185,9 @@ public class BroadcastDriver {
}
}
+ /**
+ * ActiveContext handler.
+ */
public class ContextActiveHandler implements EventHandler<ActiveContext> {
private final AtomicBoolean storeMasterId = new AtomicBoolean(false);
@@ -270,6 +279,9 @@ public class BroadcastDriver {
}
}
+ /**
+ * ClosedContext handler.
+ */
public class ContextCloseHandler implements EventHandler<ClosedContext> {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
index 4b63771..3b25bdb 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/BroadcastREEF.java
@@ -42,6 +42,9 @@ import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Client for broadcast example.
+ */
@ClientSide
public final class BroadcastREEF {
private static final Logger LOG = Logger.getLogger(BroadcastREEF.class.getName());
@@ -60,6 +63,9 @@ public final class BroadcastREEF {
public static final class Local implements Name<Boolean> {
}
+ /**
+ * Input path.
+ */
@NamedParameter(short_name = "input")
public static final class InputDir implements Name<String> {
}
@@ -146,9 +152,9 @@ public final class BroadcastREEF {
LOG.log(Level.INFO, "REEF job completed: {0}", state);
}
- /**
- * Empty private constructor to prohibit instantiation of utility class.
- */
+ /**
+ * Empty private constructor to prohibit instantiation of utility class.
+ */
private BroadcastREEF() {
}
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ControlMessages.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ControlMessages.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ControlMessages.java
index 8c2b8f2..de343a9 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ControlMessages.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ControlMessages.java
@@ -20,6 +20,9 @@ package org.apache.reef.examples.group.broadcast;
import java.io.Serializable;
+/**
+ * Control messages used in broadcast example.
+ */
public enum ControlMessages implements Serializable {
ReceiveModel,
Stop
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/MasterTask.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/MasterTask.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/MasterTask.java
index 279321a..ddf7323 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/MasterTask.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/MasterTask.java
@@ -38,6 +38,9 @@ import javax.inject.Inject;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Slave task for broadcast example.
+ */
public class MasterTask implements Task {
public static final String TASK_ID = "MasterTask";
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ModelReceiveAckReduceFunction.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ModelReceiveAckReduceFunction.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ModelReceiveAckReduceFunction.java
index 39b3bb2..e782ca7 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ModelReceiveAckReduceFunction.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/ModelReceiveAckReduceFunction.java
@@ -23,7 +23,7 @@ import org.apache.reef.io.network.group.api.operators.Reduce.ReduceFunction;
import javax.inject.Inject;
/**
- *
+ * Reduce function for model receive acknowledgement.
*/
public class ModelReceiveAckReduceFunction implements ReduceFunction<Boolean> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/SlaveTask.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/SlaveTask.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/SlaveTask.java
index dd3f1ec..4593ddd 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/SlaveTask.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/SlaveTask.java
@@ -32,7 +32,7 @@ import org.apache.reef.task.Task;
import javax.inject.Inject;
/**
- *
+ * Slave task for broadcast example.
*/
public class SlaveTask implements Task {
private final CommunicationGroupClient communicationGroupClient;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/AllCommunicationGroup.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/AllCommunicationGroup.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/AllCommunicationGroup.java
index 3363c2e..d273d4d 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/AllCommunicationGroup.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/AllCommunicationGroup.java
@@ -22,7 +22,7 @@ import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
/**
- *
+ * Communication group name.
*/
@NamedParameter()
public final class AllCommunicationGroup implements Name<String> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ControlMessageBroadcaster.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ControlMessageBroadcaster.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ControlMessageBroadcaster.java
index 652e4c2..b713a5e 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ControlMessageBroadcaster.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ControlMessageBroadcaster.java
@@ -21,6 +21,9 @@ package org.apache.reef.examples.group.broadcast.parameters;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * Control messages broadcaster.
+ */
@NamedParameter()
public final class ControlMessageBroadcaster implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelBroadcaster.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelBroadcaster.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelBroadcaster.java
index 0659eab..f0cf601 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelBroadcaster.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelBroadcaster.java
@@ -21,6 +21,9 @@ package org.apache.reef.examples.group.broadcast.parameters;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * Model broadcaster.
+ */
@NamedParameter()
public final class ModelBroadcaster implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelReceiveAckReducer.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelReceiveAckReducer.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelReceiveAckReducer.java
index f5165c6..e48da38 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelReceiveAckReducer.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/broadcast/parameters/ModelReceiveAckReducer.java
@@ -21,6 +21,9 @@ package org.apache.reef.examples.group.broadcast.parameters;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * Reduce operator name for model receive acknowledgement.
+ */
@NamedParameter()
public final class ModelReceiveAckReducer implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/Timer.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/Timer.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/Timer.java
index 9439598..45070b4 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/Timer.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/group/utils/timer/Timer.java
@@ -21,6 +21,9 @@ package org.apache.reef.examples.group.utils.timer;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Timer.
+ */
public class Timer implements AutoCloseable {
private static final Logger LOG = Logger.getLogger(Timer.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEFMesos.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEFMesos.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEFMesos.java
index 5e7a3f0..47cb213 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEFMesos.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/hello/HelloREEFMesos.java
@@ -29,6 +29,9 @@ import org.apache.reef.tang.exceptions.InjectionException;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * The Client for running HelloREEF on Mesos.
+ */
public final class HelloREEFMesos {
private static final Logger LOG = Logger.getLogger(HelloREEFMesos.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Control.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Control.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Control.java
index 42644c9..aa6e20c 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Control.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Control.java
@@ -43,6 +43,9 @@ import java.net.InetSocketAddress;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Control process which sends suspend/resume commands.
+ */
public final class Control {
private static final Logger LOG = Logger.getLogger(Control.class.getName());
@@ -96,10 +99,16 @@ public final class Control {
}
}
+ /**
+ * Task id.
+ */
@NamedParameter(doc = "Task id", short_name = "task")
public static final class TaskId implements Name<String> {
}
+ /**
+ * Command: 'suspend' or 'resume'.
+ */
@NamedParameter(doc = "Command: 'suspend' or 'resume'", short_name = "cmd")
public static final class Command implements Name<String> {
}
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java
index 5aa1a8a..d05aa17 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/Launch.java
@@ -104,7 +104,6 @@ public final class Launch {
.set(ClientConfiguration.ON_RUNTIME_ERROR, SuspendClient.RuntimeErrorHandler.class)
.build();
- // TODO: Remove the injector, have stuff injected.
final Injector commandLineInjector = Tang.Factory.getTang().newInjector(commandLineConf);
final boolean isLocal = commandLineInjector.getNamedInstance(Local.class);
final Configuration runtimeConfiguration;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/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 6891917..9ffc622 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
@@ -33,6 +33,9 @@ import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Client for suspend example.
+ */
@Unit
public class SuspendClient {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClientControl.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClientControl.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClientControl.java
index 28f0b0d..6e78368 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClientControl.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendClientControl.java
@@ -73,6 +73,9 @@ public class SuspendClientControl implements AutoCloseable {
this.transport.close();
}
+ /**
+ * Port for suspend/resume control commands.
+ */
@NamedParameter(doc = "Port for suspend/resume control commands",
short_name = "port", default_value = "7008")
public static final class Port implements Name<Integer> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java
index c10bd7d..1ed2f39 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendDriver.java
@@ -48,7 +48,7 @@ import java.util.logging.Logger;
/**
* Suspend/resume example job driver. Execute a simple task in all evaluators,
- * and sendEvaluatorControlMessage suspend/resume events properly.
+ * and send EvaluatorControlMessage suspend/resume events properly.
*/
@Unit
public class SuspendDriver {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendTestTask.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendTestTask.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendTestTask.java
index 5b21b4d..db588ca 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendTestTask.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/SuspendTestTask.java
@@ -165,6 +165,9 @@ public class SuspendTestTask implements Task, TaskMessageSource {
this.checkpointService.delete(checkpointId);
}
+ /**
+ * Handler for suspend event.
+ */
public class SuspendHandler implements EventHandler<SuspendEvent> {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/package-info.java b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/package-info.java
index bfc0071..bedfa6a 100644
--- a/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/package-info.java
+++ b/lang/java/reef-examples/src/main/java/org/apache/reef/examples/suspend/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * suspend/resume demo.
+ * Suspend/resume demo.
*/
package org.apache.reef.examples.suspend;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/HelloHttpTest.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/HelloHttpTest.java b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/HelloHttpTest.java
index e620e66..409c801 100644
--- a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/HelloHttpTest.java
+++ b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/HelloHttpTest.java
@@ -27,6 +27,9 @@ import org.apache.reef.tang.exceptions.InjectionException;
import org.junit.Assert;
import org.junit.Test;
+/**
+ * Test for HelloREEFHttp.
+ */
public class HelloHttpTest {
@Test
public void testHttpServer() throws BindException, InjectionException {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/package-info.java b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/package-info.java
index d2fe07b..4b8b9c7 100644
--- a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/package-info.java
+++ b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/hello/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Test for Hello REEF example.
*/
package org.apache.reef.examples.hello;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/ObjectWritableCodecTest.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/ObjectWritableCodecTest.java b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/ObjectWritableCodecTest.java
index 477f2f0..a592b3f 100644
--- a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/ObjectWritableCodecTest.java
+++ b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/ObjectWritableCodecTest.java
@@ -25,6 +25,9 @@ import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
+/**
+ * Test for ObjectWritableCodec.
+ */
public class ObjectWritableCodecTest {
private static ObjectWritableCodec<CheckpointID> codec;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/package-info.java b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/package-info.java
index e7524c0..4ccd364 100644
--- a/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/package-info.java
+++ b/lang/java/reef-examples/src/test/java/org/apache/reef/examples/suspend/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Test for suspend/review demo.
*/
package org.apache.reef.examples.suspend;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/06356322/lang/java/reef-tang/tang/src/test/java/org/apache/reef/tang/formats/TestConfigurationModule.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tang/tang/src/test/java/org/apache/reef/tang/formats/TestConfigurationModule.java b/lang/java/reef-tang/tang/src/test/java/org/apache/reef/tang/formats/TestConfigurationModule.java
index 015e49e..59c92a0 100644
--- a/lang/java/reef-tang/tang/src/test/java/org/apache/reef/tang/formats/TestConfigurationModule.java
+++ b/lang/java/reef-tang/tang/src/test/java/org/apache/reef/tang/formats/TestConfigurationModule.java
@@ -72,7 +72,7 @@ import java.util.Set;
* a compiler error. It used to be that you'd get a cryptic NPE from the
* classloader. Also, note that adding methods to ConfigurationModule() won't
* work. The bind calls implement immutability by using a secret final clone
- * method called deepCopy() that strips your subclass off, and uses an anonomyous
+ * method called deepCopy() that strips your subclass off, and uses an anonymous
* inner class instead.
*
*