svn commit: r1160618 - /commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FindWithinGenerator.java

[simonetripodi]

Author: simonetripodi
Date: Tue Aug 23 10:56:41 2011
New Revision: 1160618

URL: http://svn.apache.org/viewvc?rev=1160618&view=rev
Log:
fixed checkstyle violation: Expected @param tag for 'pred'.

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

Modified: 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FindWithinGenerator.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FindWithinGenerator.java?rev=1160618&r1=1160617&r2=1160618&view=diff
==============================================================================
--- 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FindWithinGenerator.java
 (original)
+++ 
commons/sandbox/functor/trunk/src/main/java/org/apache/commons/functor/core/algorithm/FindWithinGenerator.java
 Tue Aug 23 10:56:41 2011
@@ -49,13 +49,22 @@ public final class FindWithinGenerator<E
      * @param <T> the argument type.
      */
     private static class FindProcedure<T> implements UnaryProcedure<T> {
+        /**
+         * The object found, if any.
+         */
         private T found;
+        /**
+         * Flag to mark an object has been found.
+         */
         private boolean wasFound;
+        /**
+         * The adapted predicate.
+         */
         private UnaryPredicate<? super T> pred;
 
         /**
          * Create a new FindProcedure.
-         * @pred test
+         * @param pred the adapted predicate.
          */
         public FindProcedure(UnaryPredicate<? super T> pred) {
             this.pred = pred;