From 9736d3fb84260c24faa6c1538c99859441c0e2f8 Mon Sep 17 00:00:00 2001 From: Derek Allard Date: Mon, 16 Jun 2008 21:36:01 +0000 Subject: correcting some docblock comments --- system/libraries/Email.php | 18 +++++++++--------- system/libraries/Loader.php | 4 ++-- system/libraries/Log.php | 3 --- system/libraries/Validation.php | 4 ++++ system/libraries/Zip.php | 1 - 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/system/libraries/Email.php b/system/libraries/Email.php index e02c83d19..6ced2c5c8 100644 --- a/system/libraries/Email.php +++ b/system/libraries/Email.php @@ -377,7 +377,7 @@ class CI_Email { /** * Add a Header Item * - * @access public + * @access private * @param string * @param string * @return void @@ -392,7 +392,7 @@ class CI_Email { /** * Convert a String to an Array * - * @access public + * @access private * @param string * @return array */ @@ -646,7 +646,7 @@ class CI_Email { /** * Set RFC 822 Date * - * @access public + * @access private * @return string */ function _set_date() @@ -902,7 +902,7 @@ class CI_Email { /** * Build final headers * - * @access public + * @access private * @param string * @return string */ @@ -920,7 +920,7 @@ class CI_Email { /** * Write Headers as a string * - * @access public + * @access private * @return void */ function _write_headers() @@ -953,7 +953,7 @@ class CI_Email { /** * Build Final Body and attachments * - * @access public + * @access private * @return void */ function _build_message() @@ -1145,7 +1145,7 @@ class CI_Email { * Prepares string for Quoted-Printable Content-Transfer-Encoding * Refer to RFC 2045 http://www.ietf.org/rfc/rfc2045.txt * - * @access public + * @access private * @param string * @param integer * @return string @@ -1525,7 +1525,7 @@ class CI_Email { /** * SMTP Connect * - * @access public + * @access private * @param string * @return string */ @@ -1798,7 +1798,7 @@ class CI_Email { /** * Set Message * - * @access public + * @access private * @param string * @return string */ diff --git a/system/libraries/Loader.php b/system/libraries/Loader.php index 3346f0a2a..9b21bc31a 100644 --- a/system/libraries/Loader.php +++ b/system/libraries/Loader.php @@ -100,9 +100,9 @@ class CI_Loader { * * This function lets users load and instantiate models. * - * @access public * @param string the name of the class - * @param mixed any initialization parameters + * @param string name for the model + * @param bool database connection * @return void */ function model($model, $name = '', $db_conn = FALSE) diff --git a/system/libraries/Log.php b/system/libraries/Log.php index 4d64cd328..2ff2c2dbb 100644 --- a/system/libraries/Log.php +++ b/system/libraries/Log.php @@ -36,9 +36,6 @@ class CI_Log { * Constructor * * @access public - * @param string the log file path - * @param string the error threshold - * @param string the date formatting codes */ function CI_Log() { diff --git a/system/libraries/Validation.php b/system/libraries/Validation.php index 9654b4f4e..f5e4d2223 100644 --- a/system/libraries/Validation.php +++ b/system/libraries/Validation.php @@ -402,6 +402,7 @@ class CI_Validation { * * @access public * @param string + * @param field * @return bool */ function matches($str, $field) @@ -421,6 +422,7 @@ class CI_Validation { * * @access public * @param string + * @param value * @return bool */ function min_length($str, $val) @@ -440,6 +442,7 @@ class CI_Validation { * * @access public * @param string + * @param value * @return bool */ function max_length($str, $val) @@ -459,6 +462,7 @@ class CI_Validation { * * @access public * @param string + * @param value * @return bool */ function exact_length($str, $val) diff --git a/system/libraries/Zip.php b/system/libraries/Zip.php index ed476ab48..8958b572c 100644 --- a/system/libraries/Zip.php +++ b/system/libraries/Zip.php @@ -291,7 +291,6 @@ class CI_Zip { * * @access public * @param string the file name - * @param string the data to be encoded * @return bool */ function archive($filepath) -- cgit v1.2.3-24-g4f1b