Commits

Anonymous committed 0d282c7

added javadoc to methods, refine class level javadoc

git-svn-id: http://svn.opensymphony.com/svn/xwork/branches/xwork_1-2/src@1584e221344d-f017-0410-9bd5-d282ab1896d7

Comments (0)

Files changed (1)

java/com/opensymphony/xwork/validator/ValidatorFileParser.java

 
 
 /**
- * Parse the validation file. (eg. MyAction-validation.xml, MyAction-actionAlias-validation.xml)
+ * This class serves 2 purpose :-
+ * <ul>
+ * <li>
+ * Parse the validation config file. (eg. MyAction-validation.xml, MyAction-actionAlias-validation.xml)
  * to return a List of ValidatorConfig encapsulating the validator information.
+ * </li>
+ * <li>
+ * Parse the validator definition file, (eg. validators.xml) that defines the {@link Validator}s
+ * registered with XWork.
+ * </li>
+ * </ul>
  *
  * @author Jason Carreira
  * @author James House
- * @author tm_jee ( tm_jee (at) yahoo.co.uk )
+ * @author tm_jee 
  * @author Rob Harrop
  * @author Rene Gielen
  *
  * @see com.opensymphony.xwork.validator.ValidatorConfig
+ *
+ * @version $Date$ $Id$
  */
 public class ValidatorFileParser {
 
     static final String MULTI_TEXTVALUE_SEPARATOR = " ";
 
     /**
-     * Parse resource for a list of ValidatorConfig objects.
+     * Parse resource for a list of ValidatorConfig objects (configuring which validator(s) are
+     * being applied to a particular field etc.)
      *
      * @param is input stream to the resource
      * @param resourceName file name of the resource
     
     
     /**
-     * Parses validator definitions
+     * Parses validator definitions (register various validators with XWork).
      *
      * @since 1.2
      * @param is The input stream