svn commit: r1129041 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/binder/AbstractRulesModule.java

[si...@apache.org]

Author: simonetripodi
Date: Mon May 30 08:15:23 2011
New Revision: 1129041

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

Modified:
    commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/binder/AbstractRulesModule.java

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/binder/AbstractRulesModule.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/binder/AbstractRulesModule.java?rev=1129041&r1=1129040&r2=1129041&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/binder/AbstractRulesModule.java (original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/binder/AbstractRulesModule.java Mon May 30 08:15:23 2011
@@ -57,6 +57,13 @@ public abstract class AbstractRulesModul
     protected abstract void configure();
 
     /**
+     * Records an error message which will be presented to the user at a later time.
+     *
+     * Uses {@link java.lang.String#format(String, Object...)} to insert the arguments into the message.
+     *
+     * @param messagePattern A
+     *        <a href="http://download.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax">format string</a>
+     * @param arguments Arguments referenced by the format specifiers in the format string
      * @see RulesBinder#addError(String, Object...)
      */
     protected void addError( String messagePattern, Object... arguments )
@@ -65,6 +72,10 @@ public abstract class AbstractRulesModul
     }
 
     /**
+     * Records an exception, the full details of which will be logged, and the message of which will be presented to
+     * the user at a later time.
+     *
+     * @param t The exception has to be recorded
      * @see RulesBinder#addError(Throwable)
      */
     protected void addError( Throwable t )
@@ -73,6 +84,9 @@ public abstract class AbstractRulesModul
     }
 
     /**
+     * Uses the given module to configure more bindings.
+     *
+     * @param rulesModule The module used to configure more bindings
      * @see RulesBinder#install(RulesModule)
      */
     protected void install( RulesModule rulesModule )
@@ -81,6 +95,10 @@ public abstract class AbstractRulesModul
     }
 
     /**
+     * Allows user binding one or more Digester rules to the input pattern.
+     *
+     * @param pattern The pattern used to bind rules
+     * @return The Digester rules builder
      * @see RulesBinder#forPattern(String)
      */
     protected LinkedRuleBuilder forPattern( String pattern )