svn commit: r1129502 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java

[si...@apache.org]

Author: simonetripodi
Date: Tue May 31 05:48:31 2011
New Revision: 1129502

URL: http://svn.apache.org/viewvc?rev=1129502&view=rev
Log:
fixed javadoc violations

Modified:
    commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java?rev=1129502&r1=1129501&r2=1129502&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java (original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderSetProperties.java Tue May 31 05:48:31 2011
@@ -22,6 +22,7 @@ package org.apache.commons.digester3.plu
 import java.util.Properties;
 
 import org.apache.commons.digester3.Digester;
+import org.apache.commons.digester3.plugins.PluginException;
 import org.apache.commons.digester3.plugins.RuleFinder;
 import org.apache.commons.digester3.plugins.RuleLoader;
 
@@ -81,6 +82,13 @@ public class FinderSetProperties
      * <p>
      * The returned object (when non-null) will add a SetPropertiesRule to the digester whenever its addRules method is
      * invoked.
+     *
+     * @param d The digester instance where locating plugin classes
+     * @param pluginClass The plugin Java class
+     * @param p The properties object that holds any xml attributes the user may have specified on the plugin
+     *          declaration in order to indicate how to locate the plugin rules.
+     * @throws PluginException if the algorithm finds a source of rules, but there is something invalid
+     *         about that source.
      */
     @Override
     public RuleLoader findLoader( Digester d, Class<?> pluginClass, Properties p )