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

[si...@apache.org]

Author: simonetripodi
Date: Tue May 31 07:52:20 2011
New Revision: 1129531

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

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

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java?rev=1129531&r1=1129530&r2=1129531&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java (original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/plugins/strategies/FinderFromFile.java Tue May 31 07:52:20 2011
@@ -41,7 +41,8 @@ public class FinderFromFile
 {
 
     /**
-     * Xml attribute that needs to be present on a plugin declaration in order to specify the file to load rules from.
+     * The default XML attribute that needs to be present on a plugin declaration in order to specify the file to
+     * load rules from.
      */
     private static final String DFLT_FILENAME_ATTR = "file";
 
@@ -54,7 +55,12 @@ public class FinderFromFile
         this( DFLT_FILENAME_ATTR );
     }
 
-    /** See {@link #findLoader}. */
+    /**
+     * See {@link #findLoader}.
+     *
+     * @param filenameAttr the XML attribute that needs to be present on a plugin declaration in order to specify the
+     *        file to load rules from.
+     */
     public FinderFromFile( String filenameAttr )
     {
         this.filenameAttr = filenameAttr;
@@ -68,6 +74,13 @@ public class FinderFromFile
      * <p>
      * The returned object (when non-null) will add the selected rules 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 )