Update of /cvsroot/phpweather/phpweather/config
In directory usw-pr-cvs1:/tmp/cvs-serv17789/config
Modified Files:
pw_validator.php
Log Message:
Added documentation.
Index: pw_validator.php
===================================================================
RCS file: /cvsroot/phpweather/phpweather/config/pw_validator.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- pw_validator.php 12 Apr 2002 22:07:51 -0000 1.3
+++ pw_validator.php 13 Apr 2002 13:11:53 -0000 1.4
@@ -1,6 +1,13 @@
<?php
-/** Abstract baseclass for all validators. */
+/**
+ * This is the baseclass for all validators.
+ *
+ * @author Martin Geisler <gim...@gi...>
+ * @version $Id$
+ * @package PHP Weather Configurator
+ * @abstract
+ */
class pw_validator {
/**
@@ -60,6 +67,9 @@
/**
* Returns code for the keyup event in input fields.
*
+ * @param string $id The name that should be passed to the
+ * Javascript as an ID. The ID is used by the Javascript to change
+ * the right paragraph at runtime.
* @return string A string suitable for the keyup event on an text
* input field.
*/
|
