Mailing-List: contact commits-help@pig.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@pig.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1419207 - in /pig/trunk: ./ src/org/apache/pig/
 src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/
 src/org/apache/pig/builtin/mock/ src/org/apache/pig/data/
 src/org/apache/pig/impl/ src/org/apache/pig/impl...
Date: Mon, 10 Dec 2012 06:18:58 -0000
To: commits@pig.apache.org
From: cheolsoo@apache.org
Message-Id: <20121210061900.742A0238890B@eris.apache.org>

Author: cheolsoo
Date: Mon Dec 10 06:18:56 2012
New Revision: 1419207

URL: http://svn.apache.org/viewvc?rev=1419207&view=rev
Log:
PIG-3033: test-patch failed with javadoc warnings (fang fang chen via cheolsoo)

Modified:
    pig/trunk/CHANGES.txt
    pig/trunk/src/org/apache/pig/ExecType.java
    pig/trunk/src/org/apache/pig/StoreFuncWrapper.java
    pig/trunk/src/org/apache/pig/TerminatingAccumulator.java
    pig/trunk/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/PORank.java
    pig/trunk/src/org/apache/pig/builtin/mock/Storage.java
    pig/trunk/src/org/apache/pig/data/SchemaTuple.java
    pig/trunk/src/org/apache/pig/data/SchemaTupleClassGenerator.java
    pig/trunk/src/org/apache/pig/data/SchemaTupleFactory.java
    pig/trunk/src/org/apache/pig/impl/PigContext.java
    pig/trunk/src/org/apache/pig/impl/util/UDFContext.java
    pig/trunk/src/org/apache/pig/scripting/groovy/GroovyUtils.java
    pig/trunk/src/org/apache/pig/scripting/jruby/PigJrubyLibrary.java
    pig/trunk/src/org/apache/pig/scripting/jruby/RubyDataBag.java
    pig/trunk/src/org/apache/pig/scripting/jruby/RubySchema.java
    pig/trunk/src/org/apache/pig/tools/pigstats/PigStats.java

Modified: pig/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/pig/trunk/CHANGES.txt?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/CHANGES.txt (original)
+++ pig/trunk/CHANGES.txt Mon Dec 10 06:18:56 2012
@@ -386,6 +386,8 @@ OPTIMIZATIONS
 
 BUG FIXES
 
+PIG-3033: test-patch failed with javadoc warnings (fang fang chen via cheolsoo)
+
 PIG-3058: Upgrade junit to at least 4.8 (fang fang chen via cheolsoo)
 
 PIG-2978: TestLoadStoreFuncLifeCycle fails with hadoop-2.0.x (cheolsoo)

Modified: pig/trunk/src/org/apache/pig/ExecType.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/ExecType.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/ExecType.java (original)
+++ pig/trunk/src/org/apache/pig/ExecType.java Mon Dec 10 06:18:56 2012
@@ -35,7 +35,7 @@ public enum ExecType implements Serializ
 
     /**
      * Given a string, determine the exec type.
-     * @param str accepted values are 'local', 'mapreduce', and 'mapred'
+     * @param execString accepted values are 'local', 'mapreduce', and 'mapred'
      * @return exectype as ExecType
      */
     public static ExecType fromString(String execString) throws PigException {

Modified: pig/trunk/src/org/apache/pig/StoreFuncWrapper.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/StoreFuncWrapper.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/StoreFuncWrapper.java (original)
+++ pig/trunk/src/org/apache/pig/StoreFuncWrapper.java Mon Dec 10 06:18:56 2012
@@ -106,7 +106,7 @@ public class StoreFuncWrapper implements
      * Returns a method in the call stack at the given depth. Depth 0 will return the method that
      * called this getMethodName, depth 1 the method that called it, etc...
      * @param depth
-     * @return
+     * @return method name as String
      */
     protected String getMethodName(final int depth) {
         final StackTraceElement[] ste = Thread.currentThread().getStackTrace();

Modified: pig/trunk/src/org/apache/pig/TerminatingAccumulator.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/TerminatingAccumulator.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/TerminatingAccumulator.java (original)
+++ pig/trunk/src/org/apache/pig/TerminatingAccumulator.java Mon Dec 10 06:18:56 2012
@@ -21,7 +21,7 @@ package org.apache.pig;
  * This is an interface which, if implemented, allows an Accumulator
  * function to signal that it can terminate early. Certain classes of
  * UDF to do not need access to an entire set of data in order to
- * finish processing. A model example is {@link IsEmpty}. IsEmpty
+ * finish processing. A model example is {org.apache.pig.builtin.IsEmpty}. IsEmpty
  * can be Accumulative as if it receives even one line, it knows that
  * it is not empty. Another example might be a UDF which does streaming
  * analysis, and once a given stream matches a criteria, can terminate

Modified: pig/trunk/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/PORank.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/PORank.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/PORank.java (original)
+++ pig/trunk/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/PORank.java Mon Dec 10 06:18:56 2012
@@ -142,7 +142,7 @@ public class PORank extends PhysicalOper
      * Here is read the task identifier in order to get the corresponding cumulative sum,
      * and the local counter at the tuple. These values are summed and prepended to the tuple.
      * @param input processed by POCounter
-     * @result tuple with the prepend rank value.
+     * @return input as Result. The input.result tuple owns the prepend rank value 
      **/
     public Result addRank(Result input) throws ExecException {
         int i = 1;

Modified: pig/trunk/src/org/apache/pig/builtin/mock/Storage.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/builtin/mock/Storage.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/builtin/mock/Storage.java (original)
+++ pig/trunk/src/org/apache/pig/builtin/mock/Storage.java Mon Dec 10 06:18:56 2012
@@ -128,7 +128,7 @@ public class Storage extends LoadFunc im
   /**
    * reset the store and get the Data object to access it
    * @param pigServer
-   * @return
+   * @return Data
    */
   public static Data resetData(PigServer pigServer) {
     return resetData(pigServer.getPigContext());
@@ -137,7 +137,7 @@ public class Storage extends LoadFunc im
   /**
    * reset the store and get the Data object to access it
    * @param context
-   * @return
+   * @return data as Data
    */
   public static Data resetData(PigContext context) {
     Properties properties = context.getProperties();

Modified: pig/trunk/src/org/apache/pig/data/SchemaTuple.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/data/SchemaTuple.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/data/SchemaTuple.java (original)
+++ pig/trunk/src/org/apache/pig/data/SchemaTuple.java Mon Dec 10 06:18:56 2012
@@ -79,7 +79,7 @@ public abstract class SchemaTuple<T exte
      * was generated with. This is useful because when the classes
      * are resolved generically, this let's us know the identifier, which
      * is used when serlializing and deserializing tuples.
-     * @return
+     * @return the identifire as Int.
      */
     public abstract int getSchemaTupleIdentifier();
     protected abstract int schemaSize();

Modified: pig/trunk/src/org/apache/pig/data/SchemaTupleClassGenerator.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/data/SchemaTupleClassGenerator.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/data/SchemaTupleClassGenerator.java (original)
+++ pig/trunk/src/org/apache/pig/data/SchemaTupleClassGenerator.java Mon Dec 10 06:18:56 2012
@@ -130,7 +130,7 @@ public class SchemaTupleClassGenerator {
          * Checks the generated class to see if the annotation
          * associated with this enum is present.
          * @param clazz
-         * @return
+         * @return boolean type value
          */
         @SuppressWarnings({ "unchecked", "rawtypes" })
         public boolean shouldGenerate(Class clazz) {
@@ -141,7 +141,7 @@ public class SchemaTupleClassGenerator {
          * Given a job configuration file, this checks to see
          * if the default value has been overriden.
          * @param conf
-         * @return
+         * @return boolean type value
          */
         public boolean shouldGenerate(Configuration conf) {
             String shouldString = conf.get(key);
@@ -165,10 +165,10 @@ public class SchemaTupleClassGenerator {
 
     /**
      * This class actually generates the code for a given Schema.
-     * @param   schema
-     * @param   true or false depending on whether it should be appendable
-     * @param   identifier
-     * @param   a list of contexts in which the SchemaTuple is intended to be instantiated
+     * @param   s as Schema
+     * @param   appendable as boolean, true or false depending on whether it should be appendable
+     * @param   id as int, id means identifier
+     * @param   contexts which are a list of contexts in which the SchemaTuple is intended to be instantiated
      */
     protected static void generateSchemaTuple(Schema s, boolean appendable, int id, File codeDir, GenContext... contexts) {
         StringBuilder contextAnnotations = new StringBuilder();

Modified: pig/trunk/src/org/apache/pig/data/SchemaTupleFactory.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/data/SchemaTupleFactory.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/data/SchemaTupleFactory.java (original)
+++ pig/trunk/src/org/apache/pig/data/SchemaTupleFactory.java Mon Dec 10 06:18:56 2012
@@ -48,8 +48,8 @@ public class SchemaTupleFactory implemen
      * not a SchemaTuple implementation can be generated
      * for the types present. Currently, bags and maps
      * are not supported.
-     * @param   schema
-     * @return  true if it is generatable
+     * @param   s as Schema
+     * @return  boolean type value, true if it is generatable
      */
     public static boolean isGeneratable(Schema s) {
         if (s == null || s.size() == 0) {
@@ -94,8 +94,8 @@ public class SchemaTupleFactory implemen
      * which will generate the SchemaTuple associated with the given identifier. This method
      * is primarily for internal use in cases where the problem SchemaTuple is known
      * based on the identifier associated with it (such as when deserializing).
-     * @param   identifier
-     * @return  a SchemaTupleFactory which will return SchemaTuple's of the given identifier
+     * @param   id as int, means identifier
+     * @return  SchemaTupleFactory which will return SchemaTuple's of the given identifier
      */
     protected static SchemaTupleFactory getInstance(int id) {
         return SchemaTupleBackend.newSchemaTupleFactory(id);
@@ -110,10 +110,10 @@ public class SchemaTupleFactory implemen
      * of SchemaTuple can be controlled -- it is possible that someone wants a
      * factory that generates code in the context of joins, but wants to disable such
      * use for udfs.
-     * @param   schema          the Schema generated
+     * @param   s          the Schema generated
      * @param   isAppendable    whether or not the SchemaTuple should be appendable
      * @param   context         the context in which we want a SchemaTupleFactory
-     * @return  a SchemaTupleFactory which will return SchemaTuple's of the desired Schema
+     * @return  SchemaTupleFactory which will return SchemaTuple's of the desired Schema
      */
     public static SchemaTupleFactory getInstance(Schema s, boolean isAppendable, GenContext context) {
         return SchemaTupleBackend.newSchemaTupleFactory(s, isAppendable, context);

Modified: pig/trunk/src/org/apache/pig/impl/PigContext.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/impl/PigContext.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/impl/PigContext.java (original)
+++ pig/trunk/src/org/apache/pig/impl/PigContext.java Mon Dec 10 06:18:56 2012
@@ -539,7 +539,7 @@ public class PigContext implements Seria
      * @param classParamKey the property used to identify the class
      * @param argParamKey the property used to identify the class args
      * @param clazz The class that is expected
-     * @return
+     * @return <T> T
      */
     public static <T> T instantiateObjectFromParams(Configuration conf,
                                                     String classParamKey,

Modified: pig/trunk/src/org/apache/pig/impl/util/UDFContext.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/impl/util/UDFContext.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/impl/util/UDFContext.java (original)
+++ pig/trunk/src/org/apache/pig/impl/util/UDFContext.java Mon Dec 10 06:18:56 2012
@@ -208,7 +208,7 @@ public class UDFContext {
 
     /**
      * Convenience method for UDF code to check where it runs (see PIG-2576)
-     * @return
+     * @return boolean type value
      */
     public boolean isFrontend() {
         // mapred.task.id is for MR1

Modified: pig/trunk/src/org/apache/pig/scripting/groovy/GroovyUtils.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/scripting/groovy/GroovyUtils.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/scripting/groovy/GroovyUtils.java (original)
+++ pig/trunk/src/org/apache/pig/scripting/groovy/GroovyUtils.java Mon Dec 10 06:18:56 2012
@@ -209,7 +209,7 @@ public class GroovyUtils {
    * anything else raises an exception
    *
    * @param pigObject
-   * @return
+   * @return Object
    * @throws ExecException
    */
   public static Object pigToGroovy(Object pigObject) throws ExecException {

Modified: pig/trunk/src/org/apache/pig/scripting/jruby/PigJrubyLibrary.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/scripting/jruby/PigJrubyLibrary.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/scripting/jruby/PigJrubyLibrary.java (original)
+++ pig/trunk/src/org/apache/pig/scripting/jruby/PigJrubyLibrary.java Mon Dec 10 06:18:56 2012
@@ -307,8 +307,7 @@ public class PigJrubyLibrary implements 
      * @param  ruby          the Ruby runtime to create objects in
      * @param  object        object to convert
      * @return               analogous Ruby type
-     * @throws ExecException object contained an object that
-     *                       {@link #pigToRuby(Object)} could not convert
+     * @throws ExecException object contained an object that could not convert
      */
     public static RubyArray pigToRuby(Ruby ruby, Tuple object) throws ExecException{
         RubyArray rubyArray = ruby.newArray();

Modified: pig/trunk/src/org/apache/pig/scripting/jruby/RubyDataBag.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/scripting/jruby/RubyDataBag.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/scripting/jruby/RubyDataBag.java (original)
+++ pig/trunk/src/org/apache/pig/scripting/jruby/RubyDataBag.java Mon Dec 10 06:18:56 2012
@@ -133,7 +133,7 @@ public class RubyDataBag extends RubyObj
      *
      * @param ruby an instance of the ruby runtime
      * @param rc   an instance of the class object with meatadata
-     * @Param db   a DataBag to encapsulate
+     * @param db   a DataBag to encapsulate
      */
     protected RubyDataBag(final Ruby ruby, RubyClass rc, DataBag db) {
         super(ruby,rc);
@@ -224,7 +224,6 @@ public class RubyDataBag extends RubyObj
                       contents will be copied; a RubyArray, which will be treated as a
                       Tuple, or another object which will be converted over per
                       {@link PigJrubyLibrary#rubyToPig}.
-     * @return        true if it the encapsulated is sorted, false otherwise
      */
     @JRubyMethod(required = 1, rest = true)
     public void add(ThreadContext context, IRubyObject[] args) throws ExecException {

Modified: pig/trunk/src/org/apache/pig/scripting/jruby/RubySchema.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/scripting/jruby/RubySchema.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/scripting/jruby/RubySchema.java (original)
+++ pig/trunk/src/org/apache/pig/scripting/jruby/RubySchema.java Mon Dec 10 06:18:56 2012
@@ -932,7 +932,7 @@ public class RubySchema extends RubyObje
      * Schema. This method only works if the Schema has one FieldSchema.
      *
      * @param context the context the method is being executed in
-     * @Return        the name of the Schema
+     * @return        the name of the Schema
      */
     @JRubyMethod(name = "name")
     public RubyString getName(ThreadContext context) {

Modified: pig/trunk/src/org/apache/pig/tools/pigstats/PigStats.java
URL: http://svn.apache.org/viewvc/pig/trunk/src/org/apache/pig/tools/pigstats/PigStats.java?rev=1419207&r1=1419206&r2=1419207&view=diff
==============================================================================
--- pig/trunk/src/org/apache/pig/tools/pigstats/PigStats.java (original)
+++ pig/trunk/src/org/apache/pig/tools/pigstats/PigStats.java Mon Dec 10 06:18:56 2012
@@ -221,7 +221,7 @@ public abstract class PigStats {
          * Returns a List representation of the Job graph. Returned list is an
          * ArrayList
          * 
-         * @return
+         * @return List<JobStats>
          */
         @SuppressWarnings("unchecked")
         public List<JobStats> getJobList() {