Getting ready for 1.4.0 RC1

[squirrelmail.git] / plugins / squirrelspell / js / init.js

diff --git a/plugins/squirrelspell/js/init.js b/plugins/squirrelspell/js/init.js
index ca2a368fd1e1ebc2d8a823014637cf568cd2ae14..a7448c31fe9e1d2419ba913a715fafc5abe1c14e 100644 (file)
--- a/plugins/squirrelspell/js/init.js
+++ b/plugins/squirrelspell/js/init.js
@@ -1,12 +1,24 @@
 /**
-   INIT.JS
-   -------
-   Grabs the text from the SquirrelMail field and submits it to
-   the squirrelspell.
-                                                               **/
+ * init.js
+ * -------
+ * Grabs the text from the SquirrelMail field and submits it to
+ * the squirrelspell.
+ *
+ * $Id$
+ *
+ * @author Konstantin Riabitsev <icon@duke.edu> ($Author$)
+ * @version $Date$
+ */
+
+/**
+ * This is the work function.
+ *
+ * @param  flag tells the function whether to automatically submit the
+ *              form, or wait for user input. True submits the form, while
+ *              false doesn't.
+ * @return      void 
+ */
 function sqspell_init(flag){
-  // flag tells the function whether to automatically submit the form, or
-  // wait for user input. True submits the form, while False doesn't.
   textToSpell = opener.document.forms[0].subject.value + "\n" + opener.document.forms[0].body.value;
   document.forms[0].sqspell_text.value = textToSpell;
   if (flag) document.forms[0].submit();