svn commit: r1163185 - in /commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm: FoldLeft.java FoldRight.java

[mbenson]

Author: mbenson
Date: Tue Aug 30 12:37:00 2011
New Revision: 1163185

URL: http://svn.apache.org/viewvc?rev=1163185&view=rev
Log:
clean up javadoc

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

Modified: 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java?rev=1163185&r1=1163184&r2=1163185&view=diff
==============================================================================
--- 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java
 (original)
+++ 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldLeft.java
 Tue Aug 30 12:37:00 2011
@@ -56,7 +56,7 @@ public class FoldLeft<T> implements Unar
 
         /**
          * Create a new FoldLeftHelper.
-         * @param seed initial left argument
+         * @param seed initial left-side argument
          */
         FoldLeftHelper(T seed, BinaryFunction<? super T, ? super T, ? extends 
T> function) {
             this.seed = seed;
@@ -109,7 +109,7 @@ public class FoldLeft<T> implements Unar
     /**
      * {@inheritDoc}
      * @param left {@link Generator} to transform
-     * @param right seed object
+     * @param right initial left-side seed object
      */
     public T evaluate(Generator<T> left, T right) {
         FoldLeftHelper<T> helper = new FoldLeftHelper<T>(right, function);

Modified: 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldRight.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldRight.java?rev=1163185&r1=1163184&r2=1163185&view=diff
==============================================================================
--- 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldRight.java
 (original)
+++ 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FoldRight.java
 Tue Aug 30 12:37:00 2011
@@ -56,7 +56,7 @@ public class FoldRight<T> implements Una
 
         /**
          * Create a new FoldRightHelper.
-         * @param seed initial left argument
+         * @param seed initial right-side argument
          */
         FoldRightHelper(T seed, BinaryFunction<? super T, ? super T, ? extends 
T> function) {
             this.seed = seed;
@@ -115,7 +115,7 @@ public class FoldRight<T> implements Una
     /**
      * {@inheritDoc}
      * @param left {@link Generator} to transform
-     * @param right seed object
+     * @param right initial right-side seed object
      */
     public T evaluate(Generator<T> left, T right) {
         FoldRightHelper<T> helper = new FoldRightHelper<T>(right, function);