[pLog-svn] r1557 - plog/trunk/class/data/forms

[oscar at devel.plogworld.net]

Author: oscar
Date: 2005-03-20 16:10:26 +0000 (Sun, 20 Mar 2005)
New Revision: 1557

Modified:
   plog/trunk/class/data/forms/formvalidator.class.php
Log:
added some documentation stuff

Modified: plog/trunk/class/data/forms/formvalidator.class.php
===================================================================
--- plog/trunk/class/data/forms/formvalidator.class.php	2005-03-20 16:08:55 UTC (rev 1556)
+++ plog/trunk/class/data/forms/formvalidator.class.php	2005-03-20 16:10:26 UTC (rev 1557)
@@ -1,12 +1,20 @@
 <?php
 
+    /**
+	 * \defgroup Forms
+	 *
+	 * The Form class helps in data validation.
+	 */
+
 	include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
 	include_once( PLOG_CLASS_PATH."class/data/validator/emptyvalidator.class.php" );
 	
 	/**
-	 * helps in validating forms
+	 * \ingroup Forms
 	 *
-	 * @package forms
+	 * This the class used for form validation. It works helped by the Validator classes to perform data validation,
+	 * as well as in conjunction with the Action and View classes. It is fact internally used by the Action class and it is
+	 * capable of reporting to the view class which fields of a given form genrated an error.
 	 */
 	class FormValidator extends Object
 	{