You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by af...@apache.org on 2015/11/23 21:17:15 UTC
incubator-reef git commit: [REEF-1012] Add package docs and fix typos
for Group Com. module
Repository: incubator-reef
Updated Branches:
refs/heads/master af421231a -> fdc84ebd5
[REEF-1012] Add package docs and fix typos for Group Com. module
JIRA:
[REEF-1012](https://issues.apache.org/jira/browse/REEF-1012)
Pull Request:
This closes #678
Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/fdc84ebd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/fdc84ebd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/fdc84ebd
Branch: refs/heads/master
Commit: fdc84ebd56bcde9b9e4ef0bbdd134359ecec63e2
Parents: af42123
Author: Dongjoon Hyun <do...@apache.org>
Authored: Tue Nov 24 03:18:44 2015 +0900
Committer: Andrew Chung <af...@gmail.com>
Committed: Mon Nov 23 12:16:30 2015 -0800
----------------------------------------------------------------------
.../apache/reef/io/network/group/api/config/package-info.java | 3 ++-
.../apache/reef/io/network/group/api/driver/package-info.java | 3 ++-
.../java/org/apache/reef/io/network/group/api/package-info.java | 1 +
.../reef/io/network/group/api/task/CommunicationGroupClient.java | 4 ++--
.../org/apache/reef/io/network/group/api/task/package-info.java | 3 ++-
.../reef/io/network/group/impl/GroupCommunicationMessage.java | 2 +-
.../apache/reef/io/network/group/impl/config/package-info.java | 3 ++-
.../io/network/group/impl/config/parameters/OperatorName.java | 3 +++
.../group/impl/config/parameters/ReduceFunctionParam.java | 3 +++
.../group/impl/config/parameters/SerializedOperConfigs.java | 3 +++
.../network/group/impl/config/parameters/TreeTopologyFanOut.java | 3 +++
.../io/network/group/impl/config/parameters/package-info.java | 3 ++-
.../reef/io/network/group/impl/operators/package-info.java | 3 ++-
.../java/org/apache/reef/io/network/group/impl/package-info.java | 1 +
.../org/apache/reef/io/network/group/impl/task/package-info.java | 3 ++-
.../java/org/apache/reef/io/network/group/impl/utils/Utils.java | 3 ++-
.../apache/reef/io/network/group/impl/utils/package-info.java | 3 ++-
17 files changed, 35 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/package-info.java
index 1cbe08c..55d10c5 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/config/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * The operator configurations used by users.
*/
package org.apache.reef.io.network.group.api.config;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/package-info.java
index 3c02dda..6868cef 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/driver/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * Elastic Group Communications Driver-side API Interfaces.
*/
package org.apache.reef.io.network.group.api.driver;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/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 ae35b7c..30c8fc1 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
@@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
* Elastic Group Communications API.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java
index 4aa5217..1acfc4f 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/CommunicationGroupClient.java
@@ -67,7 +67,7 @@ public interface CommunicationGroupClient {
/**
* The reduce receiver configured on this communication group.
- * with the given oepratorName
+ * with the given operatorName
*
* @param operatorName
* @return
@@ -76,7 +76,7 @@ public interface CommunicationGroupClient {
/**
* The reduce sender configured on this communication group.
- * with the given oepratorName
+ * with the given operatorName
*
* @param operatorName
* @return
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/package-info.java
index 4ce6666..cc4bc3f 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/api/task/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * Elastic Group Communications Task-side API Interfaces.
*/
package org.apache.reef.io.network.group.api.task;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessage.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessage.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessage.java
index 29c5cef..6917c12 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessage.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/GroupCommunicationMessage.java
@@ -24,7 +24,7 @@ import org.apache.reef.io.network.proto.ReefNetworkGroupCommProtos;
import java.util.Arrays;
/**
- *
+ * Group Communication Message.
*/
public class GroupCommunicationMessage {
private final String groupName;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/package-info.java
index 699563e..5de5776 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * Group Communication Operator Specifications.
*/
package org.apache.reef.io.network.group.impl.config;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/OperatorName.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/OperatorName.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/OperatorName.java
index e16a654..26ffca4 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/OperatorName.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/OperatorName.java
@@ -21,6 +21,9 @@ package org.apache.reef.io.network.group.impl.config.parameters;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * Name of the operator.
+ */
@NamedParameter(doc = "Name of the operator")
public final class OperatorName implements Name<String> {
private OperatorName() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/ReduceFunctionParam.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/ReduceFunctionParam.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/ReduceFunctionParam.java
index 597b16f..982181b 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/ReduceFunctionParam.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/ReduceFunctionParam.java
@@ -22,6 +22,9 @@ import org.apache.reef.io.network.group.api.operators.Reduce.ReduceFunction;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * The reduce function class that is associated with a reduce operator.
+ */
@NamedParameter(doc = "The reduce function class that is associated with a reduce operator")
public final class ReduceFunctionParam implements Name<ReduceFunction> {
private ReduceFunctionParam() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/SerializedOperConfigs.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/SerializedOperConfigs.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/SerializedOperConfigs.java
index ad9f190..9a9db40 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/SerializedOperConfigs.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/SerializedOperConfigs.java
@@ -23,6 +23,9 @@ import org.apache.reef.tang.annotations.NamedParameter;
import java.util.Set;
+/**
+ * Serialized operator configurations.
+ */
@NamedParameter(doc = "Serialized operator configurations")
public final class SerializedOperConfigs implements Name<Set<String>> {
private SerializedOperConfigs() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/TreeTopologyFanOut.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/TreeTopologyFanOut.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/TreeTopologyFanOut.java
index 7442977..a51e14e 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/TreeTopologyFanOut.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/TreeTopologyFanOut.java
@@ -21,6 +21,9 @@ package org.apache.reef.io.network.group.impl.config.parameters;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * The fan out for the tree topology.
+ */
@NamedParameter(doc = "The fan out for the tree topology", default_value = "2", short_name = "fanout")
public final class TreeTopologyFanOut implements Name<Integer> {
private TreeTopologyFanOut() {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/package-info.java
index 55dda67..f11887a 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/config/parameters/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * Parameters for Elastic Group Communications.
*/
package org.apache.reef.io.network.group.impl.config.parameters;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/operators/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/operators/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/operators/package-info.java
index 0dccc18..746af22 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/operators/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/operators/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * Implementations for Group Communication Operators.
*/
package org.apache.reef.io.network.group.impl.operators;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/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 85d3296..4cfd3e8 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
@@ -16,6 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
* Implementations for Elastic Group Communications.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/package-info.java
index 488220b..59ef1ed 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/task/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * Implementations for Elastic Group Communications Task-side API.
*/
package org.apache.reef.io.network.group.impl.task;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/Utils.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/Utils.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/Utils.java
index 5614d0c..25fdb77 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/Utils.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/Utils.java
@@ -26,7 +26,7 @@ import org.apache.reef.tang.annotations.Name;
import java.util.Iterator;
/**
- *
+ * Utility class for group communications.
*/
public final class Utils {
@@ -64,6 +64,7 @@ public final class Utils {
}
/**
+ * Extract a group communication message object from a message.
* @param msg
* @return
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/fdc84ebd/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/package-info.java b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/package-info.java
index b052636..3e9a3e7 100644
--- a/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/package-info.java
+++ b/lang/java/reef-io/src/main/java/org/apache/reef/io/network/group/impl/utils/package-info.java
@@ -16,7 +16,8 @@
* specific language governing permissions and limitations
* under the License.
*/
+
/**
- * TODO: Document.
+ * Utilities for group communication.
*/
package org.apache.reef.io.network.group.impl.utils;