Ver código fonte

HADOOP-916. Fix javadoc warnings in Abacus. Contributed by Nigel.

git-svn-id: https://svn.apache.org/repos/asf/lucene/hadoop/trunk@498759 13f79535-47bb-0310-9956-ffa450edef68
Doug Cutting 18 anos atrás
pai
commit
8d4080e250

+ 1 - 1
src/contrib/abacus/src/java/org/apache/hadoop/abacus/JobBase.java

@@ -103,7 +103,7 @@ public abstract class JobBase implements Mapper, Reducer {
    * 
    * @param name the counter name
    * @param inc the incremental value
-   * @return
+   * @return the updated value.
    */
   protected Double addDoubleValue(Object name, double inc) {
     Double val = this.doubleCounters.get(name);

+ 2 - 2
src/contrib/abacus/src/java/org/apache/hadoop/abacus/UserDefinedValueAggregatorDescriptor.java

@@ -81,8 +81,8 @@ public class UserDefinedValueAggregatorDescriptor implements
    *   
    * @param key
    *          input key
-   * @param valiput
-   *          value
+   * @param val
+   *          input value
    * @return a list of aggregation id/value pairs. An aggregation id encodes an
    *         aggregation type which is used to guide the way to aggregate the
    *         value in the reduce/combiner phrase of an Abacus based job.

+ 2 - 2
src/contrib/abacus/src/java/org/apache/hadoop/abacus/ValueAggregatorBaseDescriptor.java

@@ -106,8 +106,8 @@ public class ValueAggregatorBaseDescriptor implements ValueAggregatorDescriptor
    * 
    * @param key
    *          input key
-   * @param valiput
-   *          value
+   * @param val
+   *          input value
    * @return a list of aggregation id/value pairs. An aggregation id encodes an
    *         aggregation type which is used to guide the way to aggregate the
    *         value in the reduce/combiner phrase of an Abacus based job.

+ 1 - 1
src/contrib/abacus/src/java/org/apache/hadoop/abacus/ValueAggregatorCombiner.java

@@ -41,7 +41,7 @@ public class ValueAggregatorCombiner extends ValueAggregatorJobBase {
   }
 
   /** Combines values for a given key.  
-   * @param key: the key is expected to be a Text object, whose prefix indicates
+   * @param key the key is expected to be a Text object, whose prefix indicates
    * the type of aggregation to aggregate the values. 
    * @param values the values to combine
    * @param output to collect combined values

+ 2 - 2
src/contrib/abacus/src/java/org/apache/hadoop/abacus/ValueAggregatorDescriptor.java

@@ -48,8 +48,8 @@ public interface ValueAggregatorDescriptor {
    * 
    * @param key
    *          input key
-   * @param valiput
-   *          value
+   * @param val
+   *          input value
    * @return a list of aggregation id/value pairs. An aggregation id encodes an
    *         aggregation type which is used to guide the way to aggregate the
    *         value in the reduce/combiner phrase of an Abacus based job.

+ 1 - 1
src/contrib/abacus/src/java/org/apache/hadoop/abacus/ValueHistogram.java

@@ -42,7 +42,7 @@ public class ValueHistogram implements ValueAggregator {
   /**
    * add the given val to the aggregator.
    * 
-   * @param the value to be added. It is expected to be a string
+   * @param val the value to be added. It is expected to be a string
    * in the form of xxxx\tnum, meaning xxxx has num occurrences.
    */
   public void addNextValue(Object val) {