commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1174852 - /commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java
Date Fri, 23 Sep 2011 15:57:51 GMT
Author: simonetripodi
Date: Fri Sep 23 15:57:51 2011
New Revision: 1174852

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

Modified:
    commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java

Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java?rev=1174852&r1=1174851&r2=1174852&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java
(original)
+++ commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java
Fri Sep 23 15:57:51 2011
@@ -43,12 +43,23 @@ public class FoldLeft<T> implements Unar
      * Helper procedure.
      */
     private static class FoldLeftHelper<T> implements UnaryProcedure<T> {
+        /**
+         * The wrapped function.
+         */
         private final BinaryFunction<? super T, ? super T, ? extends T> function;
+        /**
+         * The seed object.
+         */
         private T seed;
+        /**
+         * Flag to check the helper started or not.
+         */
         private boolean started;
 
         /**
          * Create a seedless FoldLeftHelper.
+         *
+         * @param function The wrapped function
          */
         public FoldLeftHelper(BinaryFunction<? super T, ? super T, ? extends T> function)
{
             this(null, function);
@@ -56,7 +67,9 @@ public class FoldLeft<T> implements Unar
 
         /**
          * Create a new FoldLeftHelper.
+         *
          * @param seed initial left-side argument
+         * @param function The wrapped function
          */
         FoldLeftHelper(T seed, BinaryFunction<? super T, ? super T, ? extends T> function)
{
             this.seed = seed;
@@ -86,6 +99,9 @@ public class FoldLeft<T> implements Unar
 
     }
 
+    /**
+     * {@link BinaryFunction} to apply to each (seed, next).
+     */
     private final BinaryFunction<? super T, ? super T, ? extends T> function;
 
     /**



Mime
View raw message