You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by ll...@apache.org on 2013/06/05 18:49:04 UTC
svn commit: r1489951 - in /hadoop/common/branches/branch-2: dev-support/
hadoop-tools/hadoop-extras/src/main/java/org/apache/hadoop/mapred/tools/
hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/
hadoop-tools/hadoop-rumen/src/main/...
Author: llu
Date: Wed Jun 5 16:49:04 2013
New Revision: 1489951
URL: http://svn.apache.org/r1489951
Log:
HADOOP-9616. Fix branch-2 javadoc warnings. (Junping Du via llu)
Modified:
hadoop/common/branches/branch-2/dev-support/test-patch.properties
hadoop/common/branches/branch-2/hadoop-tools/hadoop-extras/src/main/java/org/apache/hadoop/mapred/tools/package-info.java
hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/CurrentJHParser.java
hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/LoggedTaskAttempt.java
hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/datatypes/util/MapReduceJobPropertiesParser.java
hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/package-info.java
Modified: hadoop/common/branches/branch-2/dev-support/test-patch.properties
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-2/dev-support/test-patch.properties?rev=1489951&r1=1489950&r2=1489951&view=diff
==============================================================================
--- hadoop/common/branches/branch-2/dev-support/test-patch.properties (original)
+++ hadoop/common/branches/branch-2/dev-support/test-patch.properties Wed Jun 5 16:49:04 2013
@@ -18,4 +18,4 @@
OK_RELEASEAUDIT_WARNINGS=0
OK_FINDBUGS_WARNINGS=0
-OK_JAVADOC_WARNINGS=13
+OK_JAVADOC_WARNINGS=16
Modified: hadoop/common/branches/branch-2/hadoop-tools/hadoop-extras/src/main/java/org/apache/hadoop/mapred/tools/package-info.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-2/hadoop-tools/hadoop-extras/src/main/java/org/apache/hadoop/mapred/tools/package-info.java?rev=1489951&r1=1489950&r2=1489951&view=diff
==============================================================================
--- hadoop/common/branches/branch-2/hadoop-tools/hadoop-extras/src/main/java/org/apache/hadoop/mapred/tools/package-info.java (original)
+++ hadoop/common/branches/branch-2/hadoop-tools/hadoop-extras/src/main/java/org/apache/hadoop/mapred/tools/package-info.java Wed Jun 5 16:49:04 2013
@@ -17,7 +17,6 @@
*/
/**
- * Command-line tools associated with the {@link org.apache.hadoop.mapred}
- * package.
+ * Command-line tools associated with the org.apache.hadoop.mapred package.
*/
package org.apache.hadoop.mapred.tools;
Modified: hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/CurrentJHParser.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/CurrentJHParser.java?rev=1489951&r1=1489950&r2=1489951&view=diff
==============================================================================
--- hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/CurrentJHParser.java (original)
+++ hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/CurrentJHParser.java Wed Jun 5 16:49:04 2013
@@ -27,7 +27,7 @@ import org.apache.hadoop.mapreduce.v2.hs
/**
* {@link JobHistoryParser} that parses {@link JobHistory} files produced by
- * {@link org.apache.hadoop.mapreduce.jobhistory.JobHistory} in the same source
+ * {@link org.apache.hadoop.mapreduce.v2.hs.JobHistory} in the same source
* code tree as rumen.
*/
public class CurrentJHParser implements JobHistoryParser {
Modified: hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/LoggedTaskAttempt.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/LoggedTaskAttempt.java?rev=1489951&r1=1489950&r2=1489951&view=diff
==============================================================================
--- hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/LoggedTaskAttempt.java (original)
+++ hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/LoggedTaskAttempt.java Wed Jun 5 16:49:04 2013
@@ -170,7 +170,7 @@ public class LoggedTaskAttempt implement
/**
*
- * @returns a list of all splits vectors, ordered in enumeral order
+ * @return a list of all splits vectors, ordered in enumeral order
* within {@link SplitVectorKind} . Do NOT use hard-coded
* indices within the return for this with a hard-coded
* index to get individual values; use
Modified: hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/datatypes/util/MapReduceJobPropertiesParser.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/datatypes/util/MapReduceJobPropertiesParser.java?rev=1489951&r1=1489950&r2=1489951&view=diff
==============================================================================
--- hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/datatypes/util/MapReduceJobPropertiesParser.java (original)
+++ hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/datatypes/util/MapReduceJobPropertiesParser.java Wed Jun 5 16:49:04 2013
@@ -42,11 +42,12 @@ import org.apache.log4j.Logger;
* result of deprecation some keys change or are preferred over other keys,
* across versions. {@link MapReduceJobPropertiesParser} is a utility class that
* parses MapReduce job configuration properties and converts the value into a
- * well defined {@link DataType}. Users can use the
- * {@link MapReduceJobPropertiesParser#parseJobProperty()} API to process job
- * configuration parameters. This API will parse a job property represented as a
- * key-value pair and return the value wrapped inside a {@link DataType}.
- * Callers can then use the returned {@link DataType} for further processing.
+ * well defined {@link DataType}. Users can use the
+ * {@link MapReduceJobPropertiesParser#parseJobProperty(String, String)} API to
+ * process job configuration parameters. This API will parse a job property
+ * represented as a key-value pair and return the value wrapped inside a
+ * {@link DataType}. Callers can then use the returned {@link DataType} for
+ * further processing.
*
* {@link MapReduceJobPropertiesParser} thrives on the key name to decide which
* {@link DataType} to wrap the value with. Values for keys representing
@@ -61,14 +62,14 @@ import org.apache.log4j.Logger;
* {@link DefaultDataType}. Currently only '-Xmx' and '-Xms' settings are
* considered while the rest are ignored.
*
- * Note that the {@link MapReduceJobPropertiesParser#parseJobProperty()} API
- * maps the keys to a configuration parameter listed in
+ * Note that the {@link MapReduceJobPropertiesParser#parseJobProperty(String,
+ * String)} API maps the keys to a configuration parameter listed in
* {@link MRJobConfig}. This not only filters non-framework specific keys thus
- * ignoring user-specific and hard-to-parse keys but also provides a consistent
+ * ignoring user-specific and hard-to-parse keys but also provides a consistent
* view for all possible inputs. So if users invoke the
- * {@link MapReduceJobPropertiesParser#parseJobProperty()} API with either
- * <"mapreduce.job.user.name", "bob"> or <"user.name", "bob">, then the result
- * would be a {@link UserName} {@link DataType} wrapping the user-name "bob".
+ * {@link MapReduceJobPropertiesParser#parseJobProperty(String, String)} API
+ * with either <"mapreduce.job.user.name", "bob"> or <"user.name", "bob">, then
+ * the result would be a {@link UserName} {@link DataType} wrapping the user-name "bob".
*/
@SuppressWarnings("deprecation")
public class MapReduceJobPropertiesParser implements JobPropertyParser {
Modified: hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/package-info.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/package-info.java?rev=1489951&r1=1489950&r2=1489951&view=diff
==============================================================================
--- hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/package-info.java (original)
+++ hadoop/common/branches/branch-2/hadoop-tools/hadoop-rumen/src/main/java/org/apache/hadoop/tools/rumen/package-info.java Wed Jun 5 16:49:04 2013
@@ -181,8 +181,8 @@
* <li>
* {@link org.apache.hadoop.tools.rumen.JobBuilder}<br>
* Summarizes a job history file.
- * {@link org.apache.hadoop.tools.rumen.TraceBuilder} provides
- * {@link org.apache.hadoop.tools.rumen.TraceBuilder#extractJobID(String)}
+ * {@link org.apache.hadoop.tools.rumen.JobHistoryUtils} provides
+ * {@link org.apache.hadoop.tools.rumen.JobHistoryUtils#extractJobID(String)}
* API for extracting job id from job history or job configuration files
* which can be used for instantiating {@link org.apache.hadoop.tools.rumen.JobBuilder}.
* {@link org.apache.hadoop.tools.rumen.JobBuilder} generates a