You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by we...@apache.org on 2015/09/16 01:18:41 UTC
incubator-reef git commit: [REEF-526] Add missing Javadoc comments in
Java code: reef-poison
Repository: incubator-reef
Updated Branches:
refs/heads/master 78a02dba6 -> aea64d9fc
[REEF-526] Add missing Javadoc comments in Java code: reef-poison
This adds missing Javadoc comments in reef-poison project
and enforces more strict checkstyle rules.
JIRA:
[REEF-526](https://issues.apache.org/jira/browse/REEF-526)
Pull Request:
This closes #493
Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/aea64d9f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/aea64d9f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/aea64d9f
Branch: refs/heads/master
Commit: aea64d9fc56eca01605917373a79fd8b50ed4404
Parents: 78a02db
Author: Mariia Mykhailova <ma...@apache.org>
Authored: Tue Sep 15 15:43:24 2015 -0700
Committer: Markus Weimer <we...@apache.org>
Committed: Tue Sep 15 16:17:40 2015 -0700
----------------------------------------------------------------------
lang/java/reef-poison/pom.xml | 14 ++++++++++++++
.../poison/context/PoisonedContextStartHandler.java | 3 +++
.../org/apache/reef/poison/params/CrashTimeout.java | 3 +++
.../org/apache/reef/poison/params/package-info.java | 2 +-
.../reef/poison/task/PoisonedTaskStartHandler.java | 3 +++
5 files changed, 24 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/aea64d9f/lang/java/reef-poison/pom.xml
----------------------------------------------------------------------
diff --git a/lang/java/reef-poison/pom.xml b/lang/java/reef-poison/pom.xml
index 7a46788..f6a5727 100644
--- a/lang/java/reef-poison/pom.xml
+++ b/lang/java/reef-poison/pom.xml
@@ -31,6 +31,20 @@ under the License.
<name>REEF Poison</name>
<description>Fault injection for REEF</description>
+ <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>
+ </build>
+
<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/aea64d9f/lang/java/reef-poison/src/main/java/org/apache/reef/poison/context/PoisonedContextStartHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/context/PoisonedContextStartHandler.java b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/context/PoisonedContextStartHandler.java
index 1037217..b7b8c45 100644
--- a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/context/PoisonedContextStartHandler.java
+++ b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/context/PoisonedContextStartHandler.java
@@ -32,6 +32,9 @@ import java.util.Random;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Fault-injected handler for ContextStart.
+ */
public final class PoisonedContextStartHandler implements EventHandler<ContextStart> {
private static final Logger LOG = Logger.getLogger(PoisonedContextStartHandler.class.getName());
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/aea64d9f/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/CrashTimeout.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/CrashTimeout.java b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/CrashTimeout.java
index 1602db0..9e4825c 100644
--- a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/CrashTimeout.java
+++ b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/CrashTimeout.java
@@ -21,6 +21,9 @@ package org.apache.reef.poison.params;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
+/**
+ * The time window after ContextStart in which the crash will occur.
+ */
@NamedParameter(doc = "The time window (in seconds) after ContextStart in which the crash will occur",
default_value = "" + CrashTimeout.DEFAULT_VALUE)
public final class CrashTimeout implements Name<Integer> {
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/aea64d9f/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/package-info.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/package-info.java b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/package-info.java
index 0eb9890..8165270 100644
--- a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/package-info.java
+++ b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/params/package-info.java
@@ -17,6 +17,6 @@
* under the License.
*/
/**
- * TODO: Document.
+ * Parameters of fault injections.
*/
package org.apache.reef.poison.params;
http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/aea64d9f/lang/java/reef-poison/src/main/java/org/apache/reef/poison/task/PoisonedTaskStartHandler.java
----------------------------------------------------------------------
diff --git a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/task/PoisonedTaskStartHandler.java b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/task/PoisonedTaskStartHandler.java
index 7b31ae8..8fc4272 100644
--- a/lang/java/reef-poison/src/main/java/org/apache/reef/poison/task/PoisonedTaskStartHandler.java
+++ b/lang/java/reef-poison/src/main/java/org/apache/reef/poison/task/PoisonedTaskStartHandler.java
@@ -32,6 +32,9 @@ import java.util.Random;
import java.util.logging.Level;
import java.util.logging.Logger;
+/**
+ * Fault-injected handler for TaskStart.
+ */
public final class PoisonedTaskStartHandler implements EventHandler<TaskStart> {
private static final Logger LOG = Logger.getLogger(PoisonedTaskStartHandler.class.getName());