tez-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jeag...@apache.org
Subject tez git commit: TEZ-1907. Fix javadoc warnings in tez codebase (jeagles)
Date Tue, 06 Jan 2015 19:24:48 GMT
Repository: tez
Updated Branches:
  refs/heads/master d54c48add -> 9f6e76d0b


TEZ-1907. Fix javadoc warnings in tez codebase (jeagles)


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

Branch: refs/heads/master
Commit: 9f6e76d0b813f3fae52067cbf546a37a8635b5c5
Parents: d54c48a
Author: Jonathan Eagles <jeagles@gmail.com>
Authored: Tue Jan 6 13:24:35 2015 -0600
Committer: Jonathan Eagles <jeagles@gmail.com>
Committed: Tue Jan 6 13:24:35 2015 -0600

----------------------------------------------------------------------
 CHANGES.txt                                                  | 1 +
 .../main/java/org/apache/tez/dag/api/TaskLocationHint.java   | 2 +-
 .../main/java/org/apache/tez/common/TezUtilsInternal.java    | 2 +-
 .../library/common/sort/impl/TezRawKeyValueIterator.java     | 2 +-
 .../org/apache/tez/mapreduce/examples/TezExampleBase.java    | 8 ++++----
 5 files changed, 8 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tez/blob/9f6e76d0/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index 046abb4..ffc7e57 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -20,6 +20,7 @@ Release 0.6.0: Unreleased
 INCOMPATIBLE CHANGES
 
 ALL CHANGES:
+  TEZ-1907. Fix javadoc warnings in tez codebase
   TEZ-1891. Incorrect number of Javadoc warnings reported
   TEZ-1762. Lots of unit tests do not have timeout parameter set.
   TEZ-1886. remove deprecation warnings for tez-ui on the console.

http://git-wip-us.apache.org/repos/asf/tez/blob/9f6e76d0/tez-api/src/main/java/org/apache/tez/dag/api/TaskLocationHint.java
----------------------------------------------------------------------
diff --git a/tez-api/src/main/java/org/apache/tez/dag/api/TaskLocationHint.java b/tez-api/src/main/java/org/apache/tez/dag/api/TaskLocationHint.java
index 926b8fd..fef99f3 100644
--- a/tez-api/src/main/java/org/apache/tez/dag/api/TaskLocationHint.java
+++ b/tez-api/src/main/java/org/apache/tez/dag/api/TaskLocationHint.java
@@ -93,7 +93,7 @@ public class TaskLocationHint {
    * and not in while creating the dag using the DAG API.
    * @param vertexName
    * @param taskIndex
-   * @return
+   * @return the task location hint for the vertex name and task index
    */
   public static TaskLocationHint createTaskLocationHint(String vertexName, int taskIndex)
{
     return new TaskLocationHint(vertexName, taskIndex);

http://git-wip-us.apache.org/repos/asf/tez/blob/9f6e76d0/tez-common/src/main/java/org/apache/tez/common/TezUtilsInternal.java
----------------------------------------------------------------------
diff --git a/tez-common/src/main/java/org/apache/tez/common/TezUtilsInternal.java b/tez-common/src/main/java/org/apache/tez/common/TezUtilsInternal.java
index ad4648e..30401cb 100644
--- a/tez-common/src/main/java/org/apache/tez/common/TezUtilsInternal.java
+++ b/tez-common/src/main/java/org/apache/tez/common/TezUtilsInternal.java
@@ -219,7 +219,7 @@ public class TezUtilsInternal {
    * Convert DAGPlan to text. Skip sensitive informations like credentials.
    *
    * @param dagPlan
-   * @return
+   * @return a string representation of the dag plan with sensitive information removed
    */
   public static String convertDagPlanToString(DAGProtos.DAGPlan dagPlan) throws IOException
{
     StringBuilder sb = new StringBuilder();

http://git-wip-us.apache.org/repos/asf/tez/blob/9f6e76d0/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/TezRawKeyValueIterator.java
----------------------------------------------------------------------
diff --git a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/TezRawKeyValueIterator.java
b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/TezRawKeyValueIterator.java
index 2ae07cb..4e2ce3a 100644
--- a/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/TezRawKeyValueIterator.java
+++ b/tez-runtime-library/src/main/java/org/apache/tez/runtime/library/common/sort/impl/TezRawKeyValueIterator.java
@@ -71,7 +71,7 @@ public interface TezRawKeyValueIterator {
   /**
    * Whether the current key is same as the previous key
    *
-   * @return
+   * @return true if key is the same as the previous key
    * @throws IOException
    */
   boolean isSameKey() throws IOException;

http://git-wip-us.apache.org/repos/asf/tez/blob/9f6e76d0/tez-tests/src/main/java/org/apache/tez/mapreduce/examples/TezExampleBase.java
----------------------------------------------------------------------
diff --git a/tez-tests/src/main/java/org/apache/tez/mapreduce/examples/TezExampleBase.java
b/tez-tests/src/main/java/org/apache/tez/mapreduce/examples/TezExampleBase.java
index 84a450c..912de6f 100644
--- a/tez-tests/src/main/java/org/apache/tez/mapreduce/examples/TezExampleBase.java
+++ b/tez-tests/src/main/java/org/apache/tez/mapreduce/examples/TezExampleBase.java
@@ -57,7 +57,7 @@ public abstract class TezExampleBase extends Configured implements Tool
{
    * @param tezClient an existing running {@link org.apache.tez.client.TezClient} instance
if one
    *                  exists. If no TezClient is specified (null), one will be created based
on the
    *                  provided configuration
-   * @return
+   * @return Zero indicates success, non-zero indicates failure
    * @throws IOException
    * @throws TezException
    */
@@ -73,7 +73,7 @@ public abstract class TezExampleBase extends Configured implements Tool
{
    * @param dag           the dag to execute
    * @param printCounters whether to print counters or not
    * @param logger        the logger to use while printing diagnostics
-   * @return
+   * @return Zero indicates success, non-zero indicates failure
    * @throws TezException
    * @throws InterruptedException
    * @throws IOException
@@ -147,7 +147,7 @@ public abstract class TezExampleBase extends Configured implements Tool
{
    * Validate the arguments
    *
    * @param otherArgs arguments, if any
-   * @return
+   * @return Zero indicates success, non-zero indicates failure
    */
   protected abstract int validateArgs(String[] otherArgs);
 
@@ -159,7 +159,7 @@ public abstract class TezExampleBase extends Configured implements Tool
{
    * @param tezClient the tez client instance to use to run the DAG if any custom monitoring
is
    *                  required. Otherwise the utility method {@link #runDag(org.apache.tez.dag.api.DAG,
    *                  boolean, org.apache.commons.logging.Log)} should be used
-   * @return
+   * @return Zero indicates success, non-zero indicates failure
    * @throws IOException
    * @throws TezException
    */


Mime
View raw message