tez-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hit...@apache.org
Subject git commit: TEZ-665. Fix javadoc warnings. (Jonathan Eagles via hitesh)
Date Mon, 27 Jan 2014 21:31:27 GMT
Updated Branches:
  refs/heads/master c9859f72a -> 055e419a8


TEZ-665. Fix javadoc warnings. (Jonathan Eagles via hitesh)


Project: http://git-wip-us.apache.org/repos/asf/incubator-tez/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tez/commit/055e419a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tez/tree/055e419a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tez/diff/055e419a

Branch: refs/heads/master
Commit: 055e419a8a205c0bac8a2c378c6647ce815115d0
Parents: c9859f7
Author: Hitesh Shah <hitesh@apache.org>
Authored: Mon Jan 27 13:30:56 2014 -0800
Committer: Hitesh Shah <hitesh@apache.org>
Committed: Mon Jan 27 13:30:56 2014 -0800

----------------------------------------------------------------------
 .../src/main/java/org/apache/tez/client/TezClientUtils.java  | 6 +++---
 .../src/main/java/org/apache/tez/common/TezJobConfig.java    | 3 +--
 .../src/main/java/org/apache/tez/dag/api/EdgeManager.java    | 4 ++--
 .../src/main/java/org/apache/tez/dag/api/EdgeProperty.java   | 8 ++------
 tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java     | 6 +++---
 tez-api/src/main/java/org/apache/tez/runtime/api/Input.java  | 8 ++++----
 .../java/org/apache/tez/runtime/api/LogicalIOProcessor.java  | 2 +-
 tez-api/src/main/java/org/apache/tez/runtime/api/Output.java | 8 ++++----
 .../src/main/java/org/apache/tez/runtime/api/Processor.java  | 2 +-
 .../main/java/org/apache/tez/runtime/api/TezTaskContext.java | 2 +-
 .../org/apache/tez/runtime/api/events/InputFailedEvent.java  | 1 -
 .../tez/runtime/common/objectregistry/ObjectRegistry.java    | 1 -
 .../src/main/java/org/apache/tez/dag/records/TezDAGID.java   | 2 +-
 .../src/main/java/org/apache/tez/dag/records/TezID.java      | 4 ++--
 .../java/org/apache/tez/dag/records/TezTaskAttemptID.java    | 4 ++--
 .../src/main/java/org/apache/tez/dag/records/TezTaskID.java  | 5 ++---
 .../main/java/org/apache/tez/dag/records/TezVertexID.java    | 5 ++---
 .../org/apache/tez/dag/app/TaskAttemptListenerImpTezDag.java | 8 +++-----
 tez-dag/src/main/java/org/apache/tez/dag/app/dag/Task.java   | 3 ++-
 .../tez/dag/app/rm/container/ContainerSignatureMatcher.java  | 8 ++++----
 .../java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java | 2 +-
 .../mapreduce/hadoop/MultiStageMRConfToTezTranslator.java    | 6 +++---
 .../main/java/org/apache/tez/mapreduce/processor/MRTask.java | 1 -
 .../org/apache/tez/runtime/library/api/KeyValueReader.java   | 3 ++-
 .../org/apache/tez/runtime/library/api/KeyValuesReader.java  | 4 ++--
 .../java/org/apache/tez/runtime/library/api/Partitioner.java | 2 +-
 .../apache/tez/runtime/library/common/combine/Combiner.java  | 2 +-
 .../runtime/library/common/security/SecureShuffleUtils.java  | 2 +-
 .../runtime/library/common/shuffle/impl/MergeManager.java    | 1 -
 .../apache/tez/runtime/library/common/sort/impl/IFile.java   | 2 --
 .../common/task/local/output/TezLocalTaskOutputFiles.java    | 2 +-
 .../library/common/task/local/output/TezTaskOutputFiles.java | 2 +-
 32 files changed, 53 insertions(+), 66 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/client/TezClientUtils.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/client/TezClientUtils.java b/tez-api/src/main/java/org/apache/tez/client/TezClientUtils.java
index d156866..512d494 100644
--- a/tez-api/src/main/java/org/apache/tez/client/TezClientUtils.java
+++ b/tez-api/src/main/java/org/apache/tez/client/TezClientUtils.java
@@ -171,7 +171,7 @@ public class TezClientUtils {
   /**
    * Verify or create the Staging area directory on the configured Filesystem
    * @param stagingArea Staging area directory path
-   * @return
+   * @return the FileSytem for the staging area directory
    * @throws IOException
    */
   public static FileSystem ensureStagingDirExists(Configuration conf,
@@ -213,7 +213,7 @@ public class TezClientUtils {
    * @param amName Name for the application
    * @param amConfig AM Configuration
    * @param tezJarResources Resources to be used by the AM
-   * @return
+   * @return an ApplicationSubmissionContext to launch a Tez AM
    * @throws IOException
    * @throws YarnException
    */
@@ -539,7 +539,7 @@ public class TezClientUtils {
    * @param fs FileSystem object
    * @param p Path of resource to localize
    * @param type LocalResource Type
-   * @return
+   * @return a YARN LocalResource for the given Path
    * @throws IOException
    */
   static LocalResource createLocalResource(FileSystem fs, Path p,

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/common/TezJobConfig.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/common/TezJobConfig.java b/tez-api/src/main/java/org/apache/tez/common/TezJobConfig.java
index 6cd919b..8be255d 100644
--- a/tez-api/src/main/java/org/apache/tez/common/TezJobConfig.java
+++ b/tez-api/src/main/java/org/apache/tez/common/TezJobConfig.java
@@ -22,8 +22,7 @@ import org.apache.hadoop.classification.InterfaceStability.Evolving;
 
 
 /**
- * Meant for user configurable job properties. For others look at {@link Constants}
- *
+ * Meant for user configurable job properties.
  */
 
 // TODO EVENTUALLY A description for each property.

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/dag/api/EdgeManager.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/EdgeManager.java b/tez-api/src/main/java/org/apache/tez/dag/api/EdgeManager.java
index 48c911f..d855f6c 100644
--- a/tez-api/src/main/java/org/apache/tez/dag/api/EdgeManager.java
+++ b/tez-api/src/main/java/org/apache/tez/dag/api/EdgeManager.java
@@ -94,8 +94,8 @@ public interface EdgeManager {
 
   /**
    * Get the number of destination tasks that consume data from the source task
-   * @sourceTaskIndex Source task index
-   * @numDestinationTasks Total number of destination tasks
+   * @param sourceTaskIndex Source task index
+   * @param numDestinationTasks Total number of destination tasks
    */
   public int getDestinationConsumerTaskNumber(int sourceTaskIndex, int numDestinationTasks);
   

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/dag/api/EdgeProperty.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/EdgeProperty.java b/tez-api/src/main/java/org/apache/tez/dag/api/EdgeProperty.java
index eb012c6..6f0c66d 100644
--- a/tez-api/src/main/java/org/apache/tez/dag/api/EdgeProperty.java
+++ b/tez-api/src/main/java/org/apache/tez/dag/api/EdgeProperty.java
@@ -161,18 +161,14 @@ public class EdgeProperty {
   }
   
   /**
-   * Returns the {@link InputDescriptor} which will consume data from the edge.
-   * 
-   * @return
+   * @return the {@link InputDescriptor} which will consume data from the edge.
    */
   public InputDescriptor getEdgeDestination() {
     return inputDescriptor;
   }
   
   /**
-   * Returns the {@link OutputDescriptor} which produces data on the edge.
-   * 
-   * @return
+   * @return the {@link OutputDescriptor} which produces data on the edge.
    */
   public OutputDescriptor getEdgeSource() {
     return outputDescriptor;

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java b/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
index 7f1226b..a58fa3a 100644
--- a/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
+++ b/tez-api/src/main/java/org/apache/tez/dag/api/Vertex.java
@@ -150,7 +150,7 @@ public class Vertex {
    *          each of it's tasks. </p> If a {@link TezRootInputInitializer} is
    *          meant to determine the parallelism of the vertex, the initial
    *          vertex parallelism should be set to -1.
-   * @return
+   * @return this Vertex
    */
   public Vertex addInput(String inputName, InputDescriptor inputDescriptor,
       Class<? extends TezRootInputInitializer> inputInitializer) {
@@ -180,7 +180,7 @@ public class Vertex {
    * @param outputDescriptor
    * @param outputCommitterClazz Class to be used for the OutputCommitter.
    *                             Can be null.
-   * @return
+   * @return this Vertex
    */
   public Vertex addOutput(String outputName, OutputDescriptor outputDescriptor,
       Class<? extends OutputCommitter> outputCommitterClazz) {
@@ -199,7 +199,7 @@ public class Vertex {
    * user defined code embedded in the plugin
    * 
    * @param vertexManagerPluginDescriptor
-   * @return Vertex
+   * @return this Vertex
    */
   public Vertex setVertexManagerPlugin(
       VertexManagerPluginDescriptor vertexManagerPluginDescriptor) {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/runtime/api/Input.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/Input.java b/tez-api/src/main/java/org/apache/tez/runtime/api/Input.java
index 7cb5482..c064367 100644
--- a/tez-api/src/main/java/org/apache/tez/runtime/api/Input.java
+++ b/tez-api/src/main/java/org/apache/tez/runtime/api/Input.java
@@ -35,7 +35,7 @@ public interface Input {
    *
    * @param inputContext
    *          the {@link TezInputContext}
-   * @return
+   * @return list of events that were generated during initialization
    * @throws Exception
    *           if an error occurs
    */
@@ -45,14 +45,14 @@ public interface Input {
   /**
    * Gets an instance of the {@link Reader} for this <code>Output</code>
    *
-   * @return
+   * @return Gets an instance of the {@link Reader} for this <code>Output</code>
    * @throws Exception
    *           if an error occurs
    */
   public Reader getReader() throws Exception;
 
   /**
-   * Handles user and system generated {@link Events}s, which typically carry
+   * Handles user and system generated {@link Event}s, which typically carry
    * information such as an output being available on the previous vertex.
    *
    * @param inputEvents
@@ -63,7 +63,7 @@ public interface Input {
   /**
    * Closes the <code>Input</code>
    *
-   * @return
+   * @return list of events that were generated during close
    * @throws Exception
    *           if an error occurs
    */

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/runtime/api/LogicalIOProcessor.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/LogicalIOProcessor.java b/tez-api/src/main/java/org/apache/tez/runtime/api/LogicalIOProcessor.java
index 9372c70..859c2f7 100644
--- a/tez-api/src/main/java/org/apache/tez/runtime/api/LogicalIOProcessor.java
+++ b/tez-api/src/main/java/org/apache/tez/runtime/api/LogicalIOProcessor.java
@@ -27,7 +27,7 @@ import java.util.Map;
 public interface LogicalIOProcessor extends Processor {
 
   /**
-   * Runs the {@link LogicalProcessor}
+   * Runs the {@link Processor}
    * 
    * @param inputs
    *          a map of the source vertex name to {@link LogicalInput} - one per

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/runtime/api/Output.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/Output.java b/tez-api/src/main/java/org/apache/tez/runtime/api/Output.java
index 22f8d66..f61e5b3 100644
--- a/tez-api/src/main/java/org/apache/tez/runtime/api/Output.java
+++ b/tez-api/src/main/java/org/apache/tez/runtime/api/Output.java
@@ -35,7 +35,7 @@ public interface Output {
    *
    * @param outputContext
    *          the {@link TezOutputContext}
-   * @return
+   * @return list of events that were generated during initialization
    * @throws Exception
    *           if an error occurs
    */
@@ -45,14 +45,14 @@ public interface Output {
   /**
    * Gets an instance of the {@link Writer} in an <code>Output</code>
    *
-   * @return
+   * @return Gets an instance of the {@link Writer} in an <code>Output</code>
    * @throws Exception
    *           if an error occurs
    */
   public Writer getWriter() throws Exception;
 
   /**
-   * Handles user and system generated {@link Events}s, which typically carry
+   * Handles user and system generated {@link Event}s, which typically carry
    * information such as a downstream vertex being ready to consume input.
    *
    * @param outputEvents
@@ -63,7 +63,7 @@ public interface Output {
   /**
    * Closes the <code>Output</code>
    *
-   * @return
+   * @return list of events that were generated during close
    * @throws Exception
    *           if an error occurs
    */

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/runtime/api/Processor.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/Processor.java b/tez-api/src/main/java/org/apache/tez/runtime/api/Processor.java
index 17c2d05..6ae58a8 100644
--- a/tez-api/src/main/java/org/apache/tez/runtime/api/Processor.java
+++ b/tez-api/src/main/java/org/apache/tez/runtime/api/Processor.java
@@ -38,7 +38,7 @@ public interface Processor {
       throws Exception;
 
   /**
-   * Handles user and system generated {@link Events}s.
+   * Handles user and system generated {@link Event}s.
    *
    * @param processorEvents
    *          the list of {@link Event}s

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/runtime/api/TezTaskContext.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/TezTaskContext.java b/tez-api/src/main/java/org/apache/tez/runtime/api/TezTaskContext.java
index 4221cde..f26316a 100644
--- a/tez-api/src/main/java/org/apache/tez/runtime/api/TezTaskContext.java
+++ b/tez-api/src/main/java/org/apache/tez/runtime/api/TezTaskContext.java
@@ -102,7 +102,7 @@ public interface TezTaskContext {
    * Returns an identifier which is unique to the specific Input, Processor or
    * Output
    *
-   * @return
+   * @return a unique identifier
    */
   public String getUniqueIdentifier();
 

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/runtime/api/events/InputFailedEvent.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/runtime/api/events/InputFailedEvent.java
b/tez-api/src/main/java/org/apache/tez/runtime/api/events/InputFailedEvent.java
index dedc8d9..8469bb8 100644
--- a/tez-api/src/main/java/org/apache/tez/runtime/api/events/InputFailedEvent.java
+++ b/tez-api/src/main/java/org/apache/tez/runtime/api/events/InputFailedEvent.java
@@ -50,7 +50,6 @@ public class InputFailedEvent extends Event{
    * User Event constructor
    * @param sourceIndex Index to identify the physical edge of the input/output
    * that generated the event
-   * @param userPayload User Payload of the User Event
    */
   public InputFailedEvent(int sourceIndex) {
     this.sourceIndex = sourceIndex;

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-api/src/main/java/org/apache/tez/runtime/common/objectregistry/ObjectRegistry.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/runtime/common/objectregistry/ObjectRegistry.java
b/tez-api/src/main/java/org/apache/tez/runtime/common/objectregistry/ObjectRegistry.java
index 03f0424..e748c27 100644
--- a/tez-api/src/main/java/org/apache/tez/runtime/common/objectregistry/ObjectRegistry.java
+++ b/tez-api/src/main/java/org/apache/tez/runtime/common/objectregistry/ObjectRegistry.java
@@ -47,7 +47,6 @@ public interface ObjectRegistry {
 
   /**
    * Delete the object associated with the provided key
-   * @param lifeCycle What life-cycle is the Object valid for
    * @param key Key to find object
    * @return True if an object was found and removed
    */

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-common/src/main/java/org/apache/tez/dag/records/TezDAGID.java
----------------------------------------------------------------------
diff --git a/tez-common/src/main/java/org/apache/tez/dag/records/TezDAGID.java b/tez-common/src/main/java/org/apache/tez/dag/records/TezDAGID.java
index 54ca8b0..95bd4fe 100644
--- a/tez-common/src/main/java/org/apache/tez/dag/records/TezDAGID.java
+++ b/tez-common/src/main/java/org/apache/tez/dag/records/TezDAGID.java
@@ -70,7 +70,7 @@ public class TezDAGID extends TezID {
   /**
    * Get a DAGID object from given parts.
    * @param yarnRMIdentifier YARN RM identifier
-   * @param applicationId application number
+   * @param appId application number
    * @param id the dag number
    */
   public static TezDAGID getInstance(String yarnRMIdentifier, int appId, int id) {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-common/src/main/java/org/apache/tez/dag/records/TezID.java
----------------------------------------------------------------------
diff --git a/tez-common/src/main/java/org/apache/tez/dag/records/TezID.java b/tez-common/src/main/java/org/apache/tez/dag/records/TezID.java
index 4cb37ac..fcb8ba3 100644
--- a/tez-common/src/main/java/org/apache/tez/dag/records/TezID.java
+++ b/tez-common/src/main/java/org/apache/tez/dag/records/TezID.java
@@ -30,8 +30,8 @@ import org.apache.tez.dag.records.TezTaskID;
 
 /**
  * A general identifier, which internally stores the id
- * as an integer. This is the super class of {@link TezJobID}, 
- * {@link TezTaskID} and {@link TezTaskAttemptID}.
+ * as an integer. This is the super class of {@link TezDAGID}, 
+ * {@link TezVertexID}, {@link TezTaskID}, and {@link TezTaskAttemptID}.
  * 
  * @see TezTaskID
  * @see TezTaskAttemptID

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskAttemptID.java
----------------------------------------------------------------------
diff --git a/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskAttemptID.java b/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskAttemptID.java
index 022d6a2..07f8155 100644
--- a/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskAttemptID.java
+++ b/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskAttemptID.java
@@ -40,7 +40,7 @@ import com.google.common.cache.LoadingCache;
  * Second part is the task attempt number. <br>
  * <p>
  * Applications should never construct or parse TaskAttemptID strings
- * , but rather use appropriate constructors or {@link #forName(String)}
+ * , but rather use appropriate constructors or {@link Class#forName(String)}
  * method.
  *
  * @see TezTaskID
@@ -67,7 +67,7 @@ public class TezTaskAttemptID extends TezID {
   
   /**
    * Constructs a TaskAttemptID object from given {@link TezTaskID}.  
-   * @param taskId TaskID that this task belongs to  
+   * @param taskID TaskID that this task belongs to  
    * @param id the task attempt number
    */
   public static TezTaskAttemptID getInstance(TezTaskID taskID, int id) {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskID.java
----------------------------------------------------------------------
diff --git a/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskID.java b/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskID.java
index 1223ec1..282421a 100644
--- a/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskID.java
+++ b/tez-common/src/main/java/org/apache/tez/dag/records/TezTaskID.java
@@ -73,9 +73,8 @@ public class TezTaskID extends TezID {
   }
 
   /**
-   * Constructs a TaskID object from given {@link MRxApplicationID}.
-   * @param jobId JobID that this tip belongs to
-   * @param type the {@link TezTaskType} of the task
+   * Constructs a TezTaskID object from given {@link TezVertexID}.
+   * @param vertexID the vertexID object for this TezTaskID
    * @param id the tip number
    */
   public static TezTaskID getInstance(TezVertexID vertexID, int id) {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-common/src/main/java/org/apache/tez/dag/records/TezVertexID.java
----------------------------------------------------------------------
diff --git a/tez-common/src/main/java/org/apache/tez/dag/records/TezVertexID.java b/tez-common/src/main/java/org/apache/tez/dag/records/TezVertexID.java
index 66d022c..b3930cf 100644
--- a/tez-common/src/main/java/org/apache/tez/dag/records/TezVertexID.java
+++ b/tez-common/src/main/java/org/apache/tez/dag/records/TezVertexID.java
@@ -74,9 +74,8 @@ public class TezVertexID extends TezID {
   }
 
   /**
-   * Constructs a TaskID object from given {@link TezDAGID}.
-   * @param applicationId JobID that this tip belongs to
-   * @param type the {@link TezTaskType} of the task
+   * Constructs a TezVertexID object from given {@link TezDAGID}.
+   * @param dagId TezDAGID object for this TezVertexID
    * @param id the tip number
    */
   public static TezVertexID getInstance(TezDAGID dagId, int id) {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-dag/src/main/java/org/apache/tez/dag/app/TaskAttemptListenerImpTezDag.java
----------------------------------------------------------------------
diff --git a/tez-dag/src/main/java/org/apache/tez/dag/app/TaskAttemptListenerImpTezDag.java
b/tez-dag/src/main/java/org/apache/tez/dag/app/TaskAttemptListenerImpTezDag.java
index 787e5bf..73133a0 100644
--- a/tez-dag/src/main/java/org/apache/tez/dag/app/TaskAttemptListenerImpTezDag.java
+++ b/tez-dag/src/main/java/org/apache/tez/dag/app/TaskAttemptListenerImpTezDag.java
@@ -329,11 +329,9 @@ public class TaskAttemptListenerImpTezDag extends AbstractService implements
    * Child checking whether it can commit.
    *
    * <br/>
-   * Commit is a two-phased protocol. First the attempt informs the
-   * ApplicationMaster that it is
-   * {@link #commitPending(TaskAttemptID, TaskStatus)}. Then it repeatedly polls
-   * the ApplicationMaster whether it {@link #canCommit(TaskAttemptID)} This is
-   * a legacy from the centralized commit protocol handling by the JobTracker.
+   * Repeatedly polls the ApplicationMaster whether it
+   * {@link Task#canCommit(TezTaskAttemptID)} This is * a legacy from the
+   * centralized commit protocol handling by the JobTracker.
    */
   @Override
   public boolean canCommit(TezTaskAttemptID taskAttemptId) throws IOException {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-dag/src/main/java/org/apache/tez/dag/app/dag/Task.java
----------------------------------------------------------------------
diff --git a/tez-dag/src/main/java/org/apache/tez/dag/app/dag/Task.java b/tez-dag/src/main/java/org/apache/tez/dag/app/dag/Task.java
index f7861cb..1d25930 100644
--- a/tez-dag/src/main/java/org/apache/tez/dag/app/dag/Task.java
+++ b/tez-dag/src/main/java/org/apache/tez/dag/app/dag/Task.java
@@ -68,7 +68,8 @@ public interface Task {
    * Get the attempt id which has reported in as output ready. null if not
    * applicable.
    * 
-   * @return
+   * @return the attempt id which has reported in as output ready. null if not
+   * applicable.
    */
   TezTaskAttemptID getOutputConsumableAttempt();
   

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-dag/src/main/java/org/apache/tez/dag/app/rm/container/ContainerSignatureMatcher.java
----------------------------------------------------------------------
diff --git a/tez-dag/src/main/java/org/apache/tez/dag/app/rm/container/ContainerSignatureMatcher.java
b/tez-dag/src/main/java/org/apache/tez/dag/app/rm/container/ContainerSignatureMatcher.java
index 4d65c23..df17564 100644
--- a/tez-dag/src/main/java/org/apache/tez/dag/app/rm/container/ContainerSignatureMatcher.java
+++ b/tez-dag/src/main/java/org/apache/tez/dag/app/rm/container/ContainerSignatureMatcher.java
@@ -39,10 +39,10 @@ public interface ContainerSignatureMatcher {
   /**
    * Gets additional resources specified in lr2, which are not present for lr1
    * 
-   * @param lr11
-   * @param lr22
-   * @return
+   * @param lr1
+   * @param lr2
+   * @return additional resources specified in lr2, which are not present for lr1
    */
   public Map<String, LocalResource> getAdditionalResources(Map<String, LocalResource>
lr1,
       Map<String, LocalResource> lr2);
-}
\ No newline at end of file
+}

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java
----------------------------------------------------------------------
diff --git a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java
b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java
index 355c30f..e84a863 100644
--- a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java
+++ b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/InputSplitInfo.java
@@ -76,7 +76,7 @@ public interface InputSplitInfo {
   
   /**
    * Get {@link Credentials} which may be required to access the splits.
-   * @return
+   * @return {@link Credentials} which may be required to access the splits.
    */
   public abstract Credentials getCredentials();
 }

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MultiStageMRConfToTezTranslator.java
----------------------------------------------------------------------
diff --git a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MultiStageMRConfToTezTranslator.java
b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MultiStageMRConfToTezTranslator.java
index 9f1a2c5..903b3e5 100644
--- a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MultiStageMRConfToTezTranslator.java
+++ b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/hadoop/MultiStageMRConfToTezTranslator.java
@@ -136,7 +136,7 @@ public class MultiStageMRConfToTezTranslator {
    *          The tez configuration for the source vertex.
    * @param destVertex
    *          The tez configuration for the destination vertex.
-   * @return
+   * @return the output Configuration object for the edge
    */
   @LimitedPrivate("Hive, Pig")
   @Unstable
@@ -156,7 +156,7 @@ public class MultiStageMRConfToTezTranslator {
    *          The tez configuration for the source vertex.
    * @param destVertex
    *          The tez configuration for the destination vertex.
-   * @return
+   * @return the input Configuration object for the edge
    */
   @LimitedPrivate("Hive, Pig")
   @Unstable
@@ -210,7 +210,7 @@ public class MultiStageMRConfToTezTranslator {
    * configurations.
    * 
    * @param conf
-   * @return
+   * @return list of complete stage configurations given Conifiguration
    */
   @Private
   public static Configuration[] getStageConfs(Configuration conf) {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/processor/MRTask.java
----------------------------------------------------------------------
diff --git a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/processor/MRTask.java b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/processor/MRTask.java
index d97ff46..b59c3e3 100644
--- a/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/processor/MRTask.java
+++ b/tez-mapreduce/src/main/java/org/apache/tez/mapreduce/processor/MRTask.java
@@ -445,7 +445,6 @@ public abstract class MRTask {
 
   /**
    * Send a status update to the task tracker
-   * @param umbilical
    * @throws IOException
    */
   public void statusUpdate() throws IOException, InterruptedException {

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValueReader.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValueReader.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValueReader.java
index ad327b4..762d8df 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValueReader.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValueReader.java
@@ -47,12 +47,13 @@ public interface KeyValueReader extends Reader {
   
   /**
    * Returns the current key
-   * @return
+   * @return the current key
    */
   public Object getCurrentKey() throws IOException;
   
   
   /**
+   * Returns the current value
    * @return the current value
    * @throws IOException
    */

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValuesReader.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValuesReader.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValuesReader.java
index f300e2a..7861b75 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValuesReader.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/KeyValuesReader.java
@@ -47,13 +47,13 @@ public interface KeyValuesReader extends Reader {
   
   /**
    * Returns the current key
-   * @return
+   * @return the current key
    */
   public Object getCurrentKey() throws IOException;
   
   /**
    * Returns an Iterable view of the values associated with the current key
-   * @return
+   * @return an Iterable view of the values associated with the current key
    */
   public Iterable<Object> getCurrentValues() throws IOException;
 }

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/Partitioner.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/Partitioner.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/Partitioner.java
index 680c9b8..0647262 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/Partitioner.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/api/Partitioner.java
@@ -45,7 +45,7 @@ public interface Partitioner {
    * @param key key
    * @param value value
    * @param numPartitions number of partitions
-   * @return
+   * @return partition for the given key/value
    */
   int getPartition(Object key, Object value, int numPartitions);
   

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/combine/Combiner.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/combine/Combiner.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/combine/Combiner.java
index 5b10590..df7ed76 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/combine/Combiner.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/combine/Combiner.java
@@ -31,7 +31,7 @@ import org.apache.tez.runtime.library.common.sort.impl.IFile.Writer;
  * using the TEZ_RUNTIME_COMBINER_CLASS attribute in {@link TezJobConfig}
  * 
  * 
- * Partitioners need to provide a single argument ({@link TezTaskContext})
+ * Partitioners need to provide a single argument ({@link TezRawKeyValueIterator})
  * constructor.
  */
 @Unstable

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/security/SecureShuffleUtils.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/security/SecureShuffleUtils.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/security/SecureShuffleUtils.java
index b2d382c..299305a 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/security/SecureShuffleUtils.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/security/SecureShuffleUtils.java
@@ -53,7 +53,7 @@ public class SecureShuffleUtils {
   /**
    * calculate hash of msg
    * @param msg
-   * @return
+   * @return byte array containing computed hash of message
    */
   private static byte[] generateByteHash(byte[] msg, SecretKey key) {
     return JobTokenSecretManager.computeHash(msg, key);

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/shuffle/impl/MergeManager.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/shuffle/impl/MergeManager.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/shuffle/impl/MergeManager.java
index d959c02..dfee47b 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/shuffle/impl/MergeManager.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/shuffle/impl/MergeManager.java
@@ -287,7 +287,6 @@ public class MergeManager {
   
   /**
    * Unconditional Reserve is used by the Memory-to-Memory thread
-   * @return
    */
   private synchronized MapOutput unconditionalReserve(
       InputAttemptIdentifier srcAttemptIdentifier, long requestedSize, boolean primaryMapOutput)
{

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java
index 324e87e..bdafdd0 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/IFile.java
@@ -370,7 +370,6 @@ public class IFile {
     /**
      * Construct an IFile Reader.
      * 
-     * @param conf Configuration File 
      * @param fs  FileSystem
      * @param file Path of the file to be opened. This file should have
      *             checksum bytes for the data at the end of the file.
@@ -390,7 +389,6 @@ public class IFile {
     /**
      * Construct an IFile Reader.
      * 
-     * @param conf Configuration File 
      * @param in   The input stream
      * @param length Length of the data in the stream, including the checksum
      *               bytes.

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezLocalTaskOutputFiles.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezLocalTaskOutputFiles.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezLocalTaskOutputFiles.java
index 30d28f0..7b61b98 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezLocalTaskOutputFiles.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezLocalTaskOutputFiles.java
@@ -213,7 +213,7 @@ public class TezLocalTaskOutputFiles extends TezTaskOutput {
   /**
    * Create a local reduce input file name.
    *
-   * @param mapId a map task id
+   * @param taskId a task id
    * @param size the size of the file
    * @return path
    * @throws IOException

http://git-wip-us.apache.org/repos/asf/incubator-tez/blob/055e419a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezTaskOutputFiles.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezTaskOutputFiles.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezTaskOutputFiles.java
index 5111eef..0361c41 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezTaskOutputFiles.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/task/local/output/TezTaskOutputFiles.java
@@ -227,7 +227,7 @@ public class TezTaskOutputFiles extends TezTaskOutput {
   /**
    * Create a local reduce input file name.
    *
-   * @param attemptIdentifier an identifier for a task. The attempt information is ignored.
+   * @param srcTaskId an identifier for a task
    * @param size the size of the file
    * @return path
    * @throws IOException


Mime
View raw message