Tassbrains found an ittty bitty bug, which I've quashed.

[squirrelmail.git] / functions / plugin.php

diff --git a/functions/plugin.php b/functions/plugin.php
index 9c70edd198771e86e23c05ca1fad37267f14b665..3004f8699e0d75659ea8d5b783ba84757839e3bd 100644 (file)
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -11,14 +11,20 @@
  * Documentation on how to write plugins might show up some time.
  *
  * $Id$
+ * @package squirrelmail
  */
 
+/** Everything needs global.. */
 require_once(SM_PATH . 'functions/global.php');
 
 global $squirrelmail_plugin_hooks;
 $squirrelmail_plugin_hooks = array();
 
-/* This function adds a plugin. */
+/**
+ * This function adds a plugin.
+ * @param string $name Internal plugin name (ie. delete_move_next)
+ * @return void
+ */
 function use_plugin ($name) {
     if (file_exists(SM_PATH . "plugins/$name/setup.php")) {
         include_once(SM_PATH . "plugins/$name/setup.php");
@@ -29,7 +35,11 @@ function use_plugin ($name) {
     }
 }
 
-/* This function executes a hook. */
+/**
+ * This function executes a hook.
+ * @param string $name Name of hook to fire
+ * @return mixed $data
+ */
 function do_hook ($name) {
     global $squirrelmail_plugin_hooks;
     $data = func_get_args();
@@ -50,7 +60,13 @@ function do_hook ($name) {
     return $data;
 }
 
-/* This function executes a hook. */
+/**
+ * This function executes a hook and allows for parameters to be passed.
+ *
+ * @param string name the name of the hook
+ * @param mixed param the parameters to pass to the hook function
+ * @return mixed the return value of the hook function
+ */
 function do_hook_function($name,$parm=NULL) {
     global $squirrelmail_plugin_hooks;
     $ret = '';
@@ -70,7 +86,14 @@ function do_hook_function($name,$parm=NULL) {
     return $ret;
 }
 
-/* This function executes a hook. */
+/**
+ * This function executes a hook, concatenating the results of each
+ * plugin that has the hook defined.
+ *
+ * @param string name the name of the hook
+ * @param mixed parm optional hook function parameters
+ * @return string a concatenation of the results of each plugin function
+ */
 function concat_hook_function($name,$parm=NULL) {
     global $squirrelmail_plugin_hooks;
     $ret = '';
@@ -95,7 +118,14 @@ function concat_hook_function($name,$parm=NULL) {
  * false. If $priority is > 0, any one or more trues will override
  * any falses. If $priority < 0, then one or more falses will
  * override any trues.
- * Priority 0 means majority rules.  Ties will be broken with $tie */
+ * Priority 0 means majority rules.  Ties will be broken with $tie
+ *
+ * @param string name the hook name
+ * @param mixed parm the parameters for the hook function
+ * @param int priority
+ * @param bool tie
+ * @return bool the result of the function
+ */
 function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
     global $squirrelmail_plugin_hooks;
     $yea = 0;
@@ -139,6 +169,9 @@ function boolean_hook_function($name,$parm=NULL,$priority=0,$tie=false) {
  * This function checks whether the user's USER_AGENT is known to
  * be broken. If so, returns true and the plugin is invisible to the
  * offending browser.
+ * This function needs to have its name changed!
+ *
+ * @return bool whether this browser properly supports JavaScript
  */
 function soupNazi(){