Changeset 20431 for extensions/Piwecard/js/piwecard.js

Timestamp:

Jan 27, 2013, 9:56:07 PM (11 years ago)

Author:

julien1311

Message:

[piwecard] Some code documentation

File:

• extensions/Piwecard/js/piwecard.js (modified) (3 diffs)

extensions/Piwecard/js/piwecard.js

@@ +1 @@
+/**
+ * Check if a field is valid
+ * @param Object element to check
+ * @param Integer type of the element (0 is text, 1 is email, 2 is number)
+ * @param String Style of the error displayed (default = inline)
+ * @param Boolean True if the field can be empty, False otherwise
+ * @return True if OK, False otherwise
+ */
 function piwecard_checkField(element, elementType, display, nullIsOK) {
         var TEXT = 0;
@@ -51 +59 @@
 }
 
+/**
+ * Style to add to the field if piwecard_checkField returns false
+ * @param Object element
+ * @param String Style of the error displayed (default = inline)
+ */
 function add_error_style(element, display) {
         document.getElementById(element.id+'_error').style.display = display;
@@ -56 +69 @@
 }
 
+/**
+ * Remove the error style from the field if piwecard_checkField returns true
+ * @param Object element
+ */
 function remove_error_style(element) {
         document.getElementById(element.id+'_error').style.display = 'none';