Repository: incubator-reef Updated Branches: refs/heads/master c09150067 -> dd9be45b9
[REEF-533] Add missing Javadoc comments in Java code: reef-utils JIRA: [REEF-533](https://issues.apache.org/jira/browse/REEF-533) Pull Request: Closes #509 Project: http://git-wip-us.apache.org/repos/asf/incubator-reef/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-reef/commit/dd9be45b Tree: http://git-wip-us.apache.org/repos/asf/incubator-reef/tree/dd9be45b Diff: http://git-wip-us.apache.org/repos/asf/incubator-reef/diff/dd9be45b Branch: refs/heads/master Commit: dd9be45b9ecb6883bc769fc6d5fb6a51350406f2 Parents: c091500 Author: Mariia Mykhailova <[email protected]> Authored: Mon Sep 21 14:09:45 2015 -0700 Committer: Brian Cho <[email protected]> Committed: Wed Sep 23 10:40:28 2015 +0900 ---------------------------------------------------------------------- lang/java/reef-utils/pom.xml | 14 ++++++++++++++ .../java/org/apache/reef/util/cache/package-info.java | 2 +- .../main/java/org/apache/reef/util/package-info.java | 2 +- .../org/apache/reef/util/cache/WrappedValueTest.java | 3 +++ .../java/org/apache/reef/util/cache/package-info.java | 2 +- .../test/java/org/apache/reef/util/package-info.java | 2 +- 6 files changed, 21 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/dd9be45b/lang/java/reef-utils/pom.xml ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/pom.xml b/lang/java/reef-utils/pom.xml index 058a269..0256012 100644 --- a/lang/java/reef-utils/pom.xml +++ b/lang/java/reef-utils/pom.xml @@ -31,6 +31,20 @@ under the License. <name>REEF Utils</name> <description>Utilities used across REEF modules.</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> + <!-- This module shouldn't have many dependencies to make sure it is broadly usable across reef subprojects --> <dependencies> <dependency> http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/dd9be45b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/package-info.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/package-info.java index b1dcd37..d8a79c0 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/package-info.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/cache/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * TODO: Document. + * Cache utilities. */ package org.apache.reef.util.cache; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/dd9be45b/lang/java/reef-utils/src/main/java/org/apache/reef/util/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/main/java/org/apache/reef/util/package-info.java b/lang/java/reef-utils/src/main/java/org/apache/reef/util/package-info.java index 7375fe0..2e6c797 100644 --- a/lang/java/reef-utils/src/main/java/org/apache/reef/util/package-info.java +++ b/lang/java/reef-utils/src/main/java/org/apache/reef/util/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * Utilities used across reef modules. Subpackages are structred following the java.utils package. + * Utilities used across reef modules. */ package org.apache.reef.util; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/dd9be45b/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/WrappedValueTest.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/WrappedValueTest.java b/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/WrappedValueTest.java index e2f2ac5..18aa11d 100644 --- a/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/WrappedValueTest.java +++ b/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/WrappedValueTest.java @@ -27,6 +27,9 @@ import java.util.concurrent.Future; import static org.junit.Assert.*; +/** + * Test for WrappedValue. + */ public final class WrappedValueTest { private static final CurrentTime SYSTEM_TIME = new SystemTime(); private static final int NUM_THREADS = 10; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/dd9be45b/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/package-info.java b/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/package-info.java index b1dcd37..667570b 100644 --- a/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/package-info.java +++ b/lang/java/reef-utils/src/test/java/org/apache/reef/util/cache/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * TODO: Document. + * Tests for cache utilities. */ package org.apache.reef.util.cache; http://git-wip-us.apache.org/repos/asf/incubator-reef/blob/dd9be45b/lang/java/reef-utils/src/test/java/org/apache/reef/util/package-info.java ---------------------------------------------------------------------- diff --git a/lang/java/reef-utils/src/test/java/org/apache/reef/util/package-info.java b/lang/java/reef-utils/src/test/java/org/apache/reef/util/package-info.java index 9c0bc9e..c9f552e 100644 --- a/lang/java/reef-utils/src/test/java/org/apache/reef/util/package-info.java +++ b/lang/java/reef-utils/src/test/java/org/apache/reef/util/package-info.java @@ -17,6 +17,6 @@ * under the License. */ /** - * TODO: Document. + * Tests for org.apache.reef.util package. */ package org.apache.reef.util;
