summaryrefslogtreecommitdiff
path: root/pear/PEAR.php
diff options
context:
space:
mode:
authorStig Bakken <ssb@php.net>2002-05-26 12:50:36 +0000
committerStig Bakken <ssb@php.net>2002-05-26 12:50:36 +0000
commitea14cadea220efcff252829aa271279f12d68bf9 (patch)
treef1cca377d95006af914588a03b087850a7df2dc5 /pear/PEAR.php
parentaf5663fa501942534705eb1de6e007e83cdf474a (diff)
downloadphp-git-ea14cadea220efcff252829aa271279f12d68bf9.tar.gz
* phpdoc fixes (un-break the broken)
Diffstat (limited to 'pear/PEAR.php')
-rw-r--r--pear/PEAR.php50
1 files changed, 26 insertions, 24 deletions
diff --git a/pear/PEAR.php b/pear/PEAR.php
index 46f0cec20c..5408f20a45 100644
--- a/pear/PEAR.php
+++ b/pear/PEAR.php
@@ -127,8 +127,8 @@ class PEAR
* $_PEAR_destructor_object_list for destructor emulation if a
* destructor object exists.
*
- * @param string (optional) which class to use for error objects,
- * defaults to PEAR_Error.
+ * @param string $error_class (optional) which class to use for
+ * error objects, defaults to PEAR_Error.
* @access public
* @return void
*/
@@ -183,8 +183,8 @@ class PEAR
* You MUST use a reference, or they will not persist!
*
* @access public
- * @param string The calling classname, to prevent clashes
- * @param string The variable to retrieve.
+ * @param string $class The calling classname, to prevent clashes
+ * @param string $var The variable to retrieve.
* @return mixed A reference to the variable. If not set it will be
* auto initialised to NULL.
*/
@@ -202,8 +202,8 @@ class PEAR
* classes.
*
* @access public
- * @param mixed The function name (or array of class/method) to call
- * @param mixed The arguments to pass to the function
+ * @param mixed $func The function name (or array of class/method) to call
+ * @param mixed $args The arguments to pass to the function
* @return void
*/
function registerShutdownFunc($func, $args = array())
@@ -217,7 +217,7 @@ class PEAR
/**
* Tell whether a value is a PEAR error.
*
- * @param mixed the value to test
+ * @param mixed $data the value to test
* @access public
* @return bool true if parameter is an error
*/
@@ -237,12 +237,12 @@ class PEAR
* PEAR objects. If called in an object, setErrorHandling sets
* the default behaviour for that object.
*
- * @param int
+ * @param int $mode
* One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE or
* PEAR_ERROR_CALLBACK.
*
- * @param mixed
+ * @param mixed $options
* When $mode is PEAR_ERROR_TRIGGER, this is the error level (one
* of E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
*
@@ -318,7 +318,7 @@ class PEAR
*
* Note that this method can not be called statically
*
- * @param mixed a single error code or an array of error codes to expect
+ * @param mixed $code a single error code or an array of error codes to expect
*
* @return int the new depth of the "expected errors" stack
* @access public
@@ -356,16 +356,16 @@ class PEAR
* handling applied. If the $mode and $options parameters are not
* specified, the object's defaults are used.
*
- * @param mixed a text error message or a PEAR error object
+ * @param mixed $message a text error message or a PEAR error object
*
- * @param int a numeric error code (it is up to your class
+ * @param int $code a numeric error code (it is up to your class
* to define these if you want to use codes)
*
- * @param int One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
+ * @param int $mode One of PEAR_ERROR_RETURN, PEAR_ERROR_PRINT,
* PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE or
* PEAR_ERROR_CALLBACK.
*
- * @param mixed If $mode is PEAR_ERROR_TRIGGER, this parameter
+ * @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter
* specifies the PHP-internal error level (one of
* E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
* If $mode is PEAR_ERROR_CALLBACK, this
@@ -373,13 +373,13 @@ class PEAR
* method. In other error modes this parameter
* is ignored.
*
- * @param string If you need to pass along for example debug
+ * @param string $userinfo If you need to pass along for example debug
* information, this parameter is meant for that.
*
- * @param string The returned error object will be instantiated
- * from this class, if specified.
+ * @param string $error_class The returned error object will be
+ * instantiated from this class, if specified.
*
- * @param bool If true, raiseError will only pass error codes,
+ * @param bool $skipmsg If true, raiseError will only pass error codes,
* the error message parameter will be dropped.
*
* @access public
@@ -445,8 +445,8 @@ class PEAR
* you can easily override the actual error handler for some code and restore
* it later with popErrorHandling.
*
- * @param mixed (same as setErrorHandling)
- * @param mixed (same as setErrorHandling)
+ * @param mixed $mode (same as setErrorHandling)
+ * @param mixed $options (same as setErrorHandling)
*
* @return bool Always true
*
@@ -557,18 +557,20 @@ class PEAR_Error
/**
* PEAR_Error constructor
*
- * @param string message
+ * @param string $message message
*
- * @param int (optional) error code
+ * @param int $code (optional) error code
*
- * @param int (optional) error mode, one of: PEAR_ERROR_RETURN,
+ * @param int $mode (optional) error mode, one of: PEAR_ERROR_RETURN,
* PEAR_ERROR_PRINT, PEAR_ERROR_DIE, PEAR_ERROR_TRIGGER or
* PEAR_ERROR_CALLBACK
*
- * @param mixed (optional) error level, _OR_ in the case of
+ * @param mixed $options (optional) error level, _OR_ in the case of
* PEAR_ERROR_CALLBACK, the callback function or object/method
* tuple.
*
+ * @param string $userinfo (optional) additional user/debug info
+ *
* @access public
*
*/