svn commit: r1183700 - /commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/generator/GenerateWhile.java

[si...@apache.org]

Author: simonetripodi
Date: Sat Oct 15 20:57:11 2011
New Revision: 1183700

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

Modified:
    commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/generator/GenerateWhile.java

Modified: commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/generator/GenerateWhile.java
URL: http://svn.apache.org/viewvc/commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/generator/GenerateWhile.java?rev=1183700&r1=1183699&r2=1183700&view=diff
==============================================================================
--- commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/generator/GenerateWhile.java (original)
+++ commons/proper/functor/trunk/src/main/java/org/apache/commons/functor/generator/GenerateWhile.java Sat Oct 15 20:57:11 2011
@@ -23,9 +23,14 @@ import org.apache.commons.functor.UnaryP
  * Wrap another {@link Generator} such that {@link #run(UnaryProcedure)} continues
  * as long as a condition is true (test after).
  *
+ * @param <E> the type of elements held in this generator.
  * @version $Revision$ $Date$
  */
 public class GenerateWhile<E> extends BaseGenerator<E> {
+
+    /**
+     * The condition has to verified in order to execute the generation.
+     */
     private final UnaryPredicate<? super E> test;
 
     /**