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/17 20:16:44 UTC
incubator-reef git commit: [REEF-959] Add javadoc for 8 packages and
fix documentation errors in reef-tests
Repository: incubator-reef
Updated Branches:
refs/heads/master 03a2d5c22 -> 1e6cae80f
[REEF-959] Add javadoc for 8 packages and fix documentation errors in reef-tests
This PR resolves the following items in reef-tests.
* Add descriptions for 8 packages to remove all "TODO: Document"
* Remove unused variable
* Fix documentation errors
JIRA:
[REEF-959](https://issues.apache.org/jira/browse/REEF-959)
Pull request:
This closes #647
Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/1e6cae80
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/1e6cae80
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/1e6cae80
Branch: refs/heads/master
Commit: 1e6cae80fdf1e4c203a2afeff19d424806aac0f1
Parents: 03a2d5c
Author: Dongjoon Hyun <do...@apache.org>
Authored: Wed Nov 18 01:49:33 2015 +0900
Committer: Mariia Mykhailova <ma...@apache.org>
Committed: Tue Nov 17 11:15:36 2015 -0800
----------------------------------------------------------------------
.../java/org/apache/reef/tests/messaging/driver/package-info.java | 2 +-
.../java/org/apache/reef/tests/messaging/task/package-info.java | 2 +-
.../src/test/java/org/apache/reef/tests/FailureTest.java | 2 --
.../test/java/org/apache/reef/tests/close_eval/package-info.java | 2 +-
.../src/test/java/org/apache/reef/tests/driver/package-info.java | 2 +-
.../java/org/apache/reef/tests/evaluatorreuse/package-info.java | 2 +-
.../src/test/java/org/apache/reef/tests/fail/package-info.java | 2 +-
.../apache/reef/tests/multipleEventHandlerInstances/Client.java | 3 +--
.../reef/tests/multipleEventHandlerInstances/package-info.java | 2 +-
.../src/test/java/org/apache/reef/tests/package-info.java | 2 +-
10 files changed, 9 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/package-info.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/package-info.java
index 8274f26..5fb4d6a 100644
--- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/package-info.java
+++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/driver/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Tests the messaging channel between client and driver.
*/
package org.apache.reef.tests.messaging.driver;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/package-info.java b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/package-info.java
index 317e248..9df6f77 100644
--- a/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/package-info.java
+++ b/lang/java/reef-tests/src/main/java/org/apache/reef/tests/messaging/task/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Test message exchange between the Task and the Driver.
*/
package org.apache.reef.tests.messaging.task;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java
index ca22502..91ad776 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/FailureTest.java
@@ -29,8 +29,6 @@ import org.junit.Test;
public class FailureTest {
- private static final int JOB_TIMEOUT = 2 * 60 * 1000;
-
private final TestEnvironment testEnvironment = TestEnvironmentFactory.getNewTestEnvironment();
@Before
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/close_eval/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/close_eval/package-info.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/close_eval/package-info.java
index 29f8cbf..accce6f 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/close_eval/package-info.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/close_eval/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Tests for evaluator allocation by asking for allocations that it immediately closes.
*/
package org.apache.reef.tests.close_eval;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/driver/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/driver/package-info.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/driver/package-info.java
index 4e7b889..c7f6ae3 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/driver/package-info.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/driver/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Test for Driver start mechanism by launching noop driver.
*/
package org.apache.reef.tests.driver;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorreuse/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorreuse/package-info.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorreuse/package-info.java
index 6c5ec4a..8cfe180 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorreuse/package-info.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/evaluatorreuse/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Tests for Evaluator reusability across Tasks.
*/
package org.apache.reef.tests.evaluatorreuse;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/package-info.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/package-info.java
index 09aada0..9275ab0 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/package-info.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/fail/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Tests for failure handling mechanism.
*/
package org.apache.reef.tests.fail;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/Client.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/Client.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/Client.java
index d34052b..ede92c1 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/Client.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/Client.java
@@ -40,7 +40,7 @@ public class Client {
/**
* Number of milliseconds to wait for the job to complete.
*/
- private static final int JOB_TIMEOUT = 300000; // 10 sec.
+ private static final int JOB_TIMEOUT = 300000; // 300 sec.
public static LauncherStatus runReefJob(final Configuration runtimeConf, final int timeOut)
throws BindException, InjectionException {
@@ -61,7 +61,6 @@ public class Client {
}
/**
- * @param args command line parameters.
* @throws BindException configuration error.
* @throws InjectionException configuration error.
*/
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/package-info.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/package-info.java
index 1b169bc..a45d3a1 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/package-info.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/multipleEventHandlerInstances/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Tests for multiple event handler registration.
*/
package org.apache.reef.tests.multipleEventHandlerInstances;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/1e6cae80/lang/java/reef-tests/src/test/java/org/apache/reef/tests/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/package-info.java b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/package-info.java
index d9f1bdf..ceb3966 100644
--- a/lang/java/reef-tests/src/test/java/org/apache/reef/tests/package-info.java
+++ b/lang/java/reef-tests/src/test/java/org/apache/reef/tests/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Tests for REEF implementations.
*/
package org.apache.reef.tests;