svn commit: r1180194 - /commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedBinaryProcedure.java

[si...@apache.org]

Author: simonetripodi
Date: Fri Oct  7 20:06:19 2011
New Revision: 1180194

URL: http://svn.apache.org/viewvc?rev=1180194&view=rev
Log:
added missing javadoc comments

Modified:
    commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedBinaryProcedure.java

Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedBinaryProcedure.java
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedBinaryProcedure.java?rev=1180194&r1=1180193&r2=1180194&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedBinaryProcedure.java (original)
+++ commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedBinaryProcedure.java Fri Oct  7 20:06:19 2011
@@ -24,6 +24,9 @@ import org.apache.commons.functor.UnaryP
 
 /**
  * A BinaryProcedure composed of a BinaryFunction whose result is then run through a UnaryProcedure.
+ *
+ * @param <L> the left argument type.
+ * @param <R> the right argument type.
  * @version $Revision$ $Date$
  * @author Matt Benson
  */
@@ -34,15 +37,22 @@ public class TransformedBinaryProcedure<
     private static final long serialVersionUID = -7559182250073101798L;
 
     /**
-     * Type-remembering helper
-     * @param <X>
+     * Type-remembering helper.
+     *
+     * @param <X> the wrapped procedure argument.
      */
     private static final class Helper<X, L, R> implements BinaryProcedure<L, R>, Serializable {
         /**
          * serialVersionUID declaration.
          */
         private static final long serialVersionUID = -4229496007094829301L;
+        /**
+         * The wrapped function.
+         */
         private BinaryFunction<? super L, ? super R, ? extends X> function;
+        /**
+         * The wrapped procedure.
+         */
         private UnaryProcedure<? super X> procedure;
 
         /**
@@ -64,11 +74,14 @@ public class TransformedBinaryProcedure<
         }
     }
 
+    /**
+     * The adapted helper.
+     */
     private final Helper<?, L, R> helper;
 
     /**
      * Create a new TransformedBinaryProcedure.
-     * @param <X>
+     * @param <X> the wrapped procedure argument.
      * @param function BinaryFunction
      * @param procedure UnaryProcedure
      */