nemo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jeongy...@apache.org
Subject [incubator-nemo] branch master updated: [NEMO-10] Handle Method Javadocs Requirements for Checkstyle Warnings (#169)
Date Thu, 06 Dec 2018 07:55:35 GMT
This is an automated email from the ASF dual-hosted git repository.

jeongyoon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nemo.git


The following commit(s) were added to refs/heads/master by this push:
     new 99d4451  [NEMO-10] Handle Method Javadocs Requirements for Checkstyle Warnings (#169)
99d4451 is described below

commit 99d44513f4a0856fe70139d5e5376343eb228ce1
Author: Eunji Jeong <egjung49@gmail.com>
AuthorDate: Thu Dec 6 16:55:31 2018 +0900

    [NEMO-10] Handle Method Javadocs Requirements for Checkstyle Warnings (#169)
    
    JIRA: NEMO-10: Handle Method Javadocs Requirements for Checkstyle Warnings
    
    **Major changes:**
    Handle Method Javadocs Requirements for Checkstyle Warnings in common
    
    **Minor changes to note:**
    The severity of JavaDocMethod has been changed from 'warning' to 'error'.
    Modules that still have the methods without Javadocs are specified in suppressions.xml.
    
    **Tests for the changes:**
    maven checkstyle tests.
    
    **Other comments:**
    suppressions.xml file can be removed once all of the JavaDocMethod warnings have been
removed.
---
 .../nemo/common/ir/vertex/transform/AggregateMetricTransform.java     | 4 ++--
 .../nemo/common/ir/vertex/transform/MetricCollectTransform.java       | 4 ++--
 suppressions.xml                                                      | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/AggregateMetricTransform.java
b/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/AggregateMetricTransform.java
index 4d1c9da..e912125 100644
--- a/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/AggregateMetricTransform.java
+++ b/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/AggregateMetricTransform.java
@@ -39,8 +39,8 @@ public final class AggregateMetricTransform<I, O> extends NoWatermarkEmitTransfo
 
   /**
    * Default constructor.
-   * @param aggregatedDynOptData initial dynamic optimization data.
-   * @param dynOptDataAggregator aggregator for the dynamic optimization data.
+   * @param aggregatedDynOptData per-stage aggregated dynamic optimization data.
+   * @param dynOptDataAggregator aggregator to use.
    */
   public AggregateMetricTransform(final O aggregatedDynOptData,
                                   final BiFunction<Object, O, O> dynOptDataAggregator)
{
diff --git a/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/MetricCollectTransform.java
b/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/MetricCollectTransform.java
index 05254bc..39dc6e0 100644
--- a/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/MetricCollectTransform.java
+++ b/common/src/main/java/org/apache/nemo/common/ir/vertex/transform/MetricCollectTransform.java
@@ -41,8 +41,8 @@ public final class MetricCollectTransform<I, O> extends NoWatermarkEmitTransform
 
   /**
    * MetricCollectTransform constructor.
-   * @param dynOptData dynamic optimization data.
-   * @param dynOptDataCollector for the data.
+   * @param dynOptData per-task dynamic optimization data.
+   * @param dynOptDataCollector that collects the data.
    * @param closer callback function to be invoked when closing the transform.
    */
   public MetricCollectTransform(final O dynOptData,
diff --git a/suppressions.xml b/suppressions.xml
index c1e8992..f0f4d8c 100644
--- a/suppressions.xml
+++ b/suppressions.xml
@@ -24,5 +24,5 @@ under the License.
 
 <suppressions>
     <suppress checks="JavadocMethod"
-              files="[\\/]runtime[\\/]|.*Test.*\.java"/>
+              files="[\\/]runtime[\\/]|[\\/]compiler[\\/]|[\\/]client[\\/]|[\\/]examples[\\/]"/>
 </suppressions>


Mime
View raw message