[GitHub] jeongyooneo closed pull request #169: [NEMO-10] Handle Method Javadocs Requirements for Checkstyle Warnings

[GitBox]

jeongyooneo closed pull request #169: [NEMO-10] Handle Method Javadocs 
Requirements for Checkstyle Warnings
URL: https://github.com/apache/incubator-nemo/pull/169
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

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 4d1c9dafe..e912125f7 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 @@
 
   /**
    * 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 05254bc76..39dc6e036 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 @@
 
   /**
    * 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 c1e89929c..f0f4d8cbd 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>


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services