Changeset 20431 for extensions/Piwecard/ws/ws_functions.inc.php

Timestamp:

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

Author:

julien1311

Message:

[piwecard] Some code documentation

File:

• extensions/Piwecard/ws/ws_functions.inc.php (modified) (4 diffs)

extensions/Piwecard/ws/ws_functions.inc.php

@@ -12 +12 @@
 );
 
+/**
+ * Function called by Javascript
+ * @param Array Parameters passed through Javascript
+ * @param
+ * @return String the preview of the email
+ */
 function piwecard_ws_previewEmail($params, $service) {
         $format_message = $params['format_message'];
@@ -19 +25 @@
 }
 
+/**
+ * Construct the preview of the email
+ * @param String Email format (text or html)
+ * @param String the email message
+ * @return String the preview of the email
+ */
 function previewEmail($format_message, $message) {
         $piwecard = new Piwecard();
@@ -47 +59 @@
 }
 
+/**
+ * Get style from the email template
+ * @param String The value of the node "Style"
+ * @return Array the styles of the email
+ */
 function piwecard_create_style_array($style) {
         $style = str_replace(array("\n", "\t"), array('', ''), $style);
@@ -66 +83 @@
 }
 
+/**
+ * Parse the email message
+ * @param String message to parse
+ * @return String parsed message
+ */
 function parse($data) {
         global $conf;