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

[si...@apache.org]

Author: simonetripodi
Date: Tue May 31 05:55:25 2011
New Revision: 1129508

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

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

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java?rev=1129508&r1=1129507&r2=1129508&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java (original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromMethod.java Tue May 31 05:55:25 2011
@@ -37,7 +37,8 @@ public class FinderFromMethod
 {
 
     /**
-     * Xml attribute that needs to be present on a plugin declaration in order to specify the method to load rules from.
+     * Default XML attribute that needs to be present on a plugin declaration in order to specify the method
+     * to load rules from.
      */
     public static String DFLT_METHOD_ATTR = "method";
 
@@ -50,7 +51,12 @@ public class FinderFromMethod
         this( DFLT_METHOD_ATTR );
     }
 
-    /** See {@link #findLoader}. */
+    /**
+     * See {@link #findLoader}.
+     *
+     * @param methodAttr The XML attribute that needs to be present on a plugin declaration in order to specify the
+     *        method to load rules from.
+     */
     public FinderFromMethod( String methodAttr )
     {
         this.methodAttr = methodAttr;
@@ -65,6 +71,13 @@ public class FinderFromMethod
      * The returned object (when non-null) will invoke the target method on the plugin class whenever its addRules
      * method is invoked. The target method is expected to have the following prototype:
      * <code> public static void xxxxx(Digester d, String patternPrefix); </code>
+     *
+     * @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 )