diff Validator.inc @ 94:2370f4450983

Document functions and move a few functions to more appropriate places.
author Tom Fredrik Blenning Klaussen <bfg@blenning.no>
date Thu, 18 Oct 2012 17:33:34 +0200
parents 8aadd7a23b68
children
line wrap: on
line diff
--- a/Validator.inc	Thu Oct 18 16:44:48 2012 +0200
+++ b/Validator.inc	Thu Oct 18 17:33:34 2012 +0200
@@ -6,8 +6,16 @@
 $cache = ScriptIncludeCache::instance(__FILE__);
 /// @endcond
 
-
-abstract class Validator {
+/**
+ * This is the base class for all validators
+ */
+abstract class Validator
+{
+  /**
+   * Performs the check if input is valid
+   *
+   * @return bool if the check went through
+   */
   abstract function check();
 }
 ?>
\ No newline at end of file