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

[si...@apache.org]

Author: simonetripodi
Date: Fri Oct  7 20:33:34 2011
New Revision: 1180207

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

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

Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedFunction.java
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedFunction.java?rev=1180207&r1=1180206&r2=1180207&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedFunction.java (original)
+++ commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/composite/TransformedFunction.java Fri Oct  7 20:33:34 2011
@@ -23,6 +23,8 @@ import org.apache.commons.functor.UnaryF
 
 /**
  * A Function whose result is then run through a UnaryFunction.
+ *
+ * @param <T> the returned value type.
  * @version $Revision$ $Date$
  * @author Matt Benson
  */
@@ -33,15 +35,22 @@ public class TransformedFunction<T> impl
     private static final long serialVersionUID = 1201423110871342081L;
 
     /**
-     * Type-remembering helper
-     * @param <X>
+     * Type-remembering helper.
+     *
+     * @param <X> the adapted function argument type
      */
     private static final class Helper<X, T> implements Function<T>, Serializable {
         /**
          * serialVersionUID declaration.
          */
         private static final long serialVersionUID = -7177784125292465809L;
+        /**
+         * The preceding function.
+         */
         private Function<? extends X> preceding;
+        /**
+         * The following function.
+         */
         private UnaryFunction<? super X, ? extends T> following;
 
         /**
@@ -62,11 +71,14 @@ public class TransformedFunction<T> impl
         }
     }
 
+    /**
+     * The adapted helper.
+     */
     private final Helper<?, T> helper;
 
     /**
      * Create a new TransformedFunction.
-     * @param <X>
+     * @param <X> the preceding function argument type.
      * @param preceding Function
      * @param following UnaryFunction
      */