Some comments altered

3 files changed, 17 insertions, 37 deletions

diff --git a/system/helpers/smiley_helper.php b/system/helpers/smiley_helper.php
index 83fb863df..bc592f74f 100644
--- a/system/helpers/smiley_helper.php
+++ b/system/helpers/smiley_helper.php
@@ -43,7 +43,6 @@
  * Returns the javascript required for the smiley insertion. Optionally takes
  * an array of aliases to loosely couple the smiley array to the view.
  *
- * @access	public
  * @param	mixed	alias name or array of alias->field_id pairs
  * @param	string	field_id if alias name was passed in
  * @return	array
@@ -125,7 +124,6 @@ EOF;
  * Returns an array of image tag links that can be clicked to be inserted
  * into a form field.
  *
- * @access	public
  * @param	string	the URL to the folder containing the smiley images
  * @return	array
  */
@@ -173,7 +171,6 @@ if ( ! function_exists('get_clickable_smileys'))
  *
  * Takes a string as input and swaps any contained smileys for the actual image
  *
- * @access	public
  * @param	string	the text to be parsed
  * @param	string	the URL to the folder containing the smiley images
  * @return	string
@@ -206,7 +203,6 @@ if ( ! function_exists('parse_smileys'))
  *
  * Fetches the config/smiley.php file
  *
- * @access	private
  * @return	mixed
  */
 if ( ! function_exists('_get_smiley_array'))
@@ -235,7 +231,6 @@ if ( ! function_exists('_get_smiley_array'))
  *
  * DEPRECATED as of version 1.7.2, use smiley_js instead
  *
- * @access	public
  * @param	string	form name
  * @param	string	field name
  * @return	string
diff --git a/system/helpers/string_helper.php b/system/helpers/string_helper.php
index 6573b9a5d..a53d1b88e 100644
--- a/system/helpers/string_helper.php
+++ b/system/helpers/string_helper.php
@@ -48,7 +48,6 @@
  *
  * this/that/theother
  *
- * @access	public
  * @param	string
  * @return	string
  */
@@ -67,7 +66,6 @@ if ( ! function_exists('trim_slashes'))
  *
  * Removes slashes contained in a string or in an array
  *
- * @access	public
  * @param	mixed	string or array
  * @return	mixed	string or array
  */
@@ -96,7 +94,6 @@ if ( ! function_exists('strip_slashes'))
  *
  * Removes single and double quotes from a string
  *
- * @access	public
  * @param	string
  * @return	string
  */
@@ -115,7 +112,6 @@ if ( ! function_exists('strip_quotes'))
  *
  * Converts single and double quotes to entities
  *
- * @access	public
  * @param	string
  * @return	string
  */
@@ -141,7 +137,6 @@ if ( ! function_exists('quotes_to_entities'))
  *
  * http://www.some-site.com/index.php
  *
- * @access	public
  * @param	string
  * @return	string
  */
@@ -166,7 +161,6 @@ if ( ! function_exists('reduce_double_slashes'))
  *
  * Fred, Bill, Joe, Jimmy
  *
- * @access	public
  * @param	string
  * @param	string	the character you wish to reduce
  * @param	bool	TRUE/FALSE - whether to trim the character from the beginning/end
@@ -188,7 +182,6 @@ if ( ! function_exists('reduce_multiples'))
  *
  * Useful for generating passwords or hashes.
  *
- * @access	public
  * @param	string	type of random string.  basic, alpha, alunum, numeric, nozero, unique, md5, encrypt and sha1
  * @param	int	number of characters
  * @return	string
@@ -219,7 +212,7 @@ if ( ! function_exists('random_string'))
 						$pool = '123456789';
 						break;
 				}
-				return substr(str_shuffle(str_repeat($pool, ceil($len/strlen($pool)))),0,$len);
+				return substr(str_shuffle(str_repeat($pool, ceil($len / strlen($pool)))), 0, $len);
 			case 'unique':
 			case 'md5': return md5(uniqid(mt_rand()));
 			case 'encrypt':
@@ -241,10 +234,13 @@ if ( ! function_exists('random_string'))
  * @param	string	$first  Which number should be used for the first dupe increment
  * @return	string
  */
-function increment_string($str, $separator = '_', $first = 1)
+if ( ! function_exists('increment_string'))
 {
-	preg_match('/(.+)'.$separator.'([0-9]+)$/', $str, $match);
-	return isset($match[2]) ? $match[1].$separator.($match[2] + 1) : $str.$separator.$first;
+	function increment_string($str, $separator = '_', $first = 1)
+	{
+		preg_match('/(.+)'.$separator.'([0-9]+)$/', $str, $match);
+		return isset($match[2]) ? $match[1].$separator.($match[2] + 1) : $str.$separator.$first;
+	}
 }
 
 // ------------------------------------------------------------------------
@@ -254,7 +250,6 @@ function increment_string($str, $separator = '_', $first = 1)
  *
  * Allows strings to be alternated. See docs...
  *
- * @access	public
  * @param	string	(as many parameters as needed)
  * @return	string
  */
@@ -279,7 +274,6 @@ if ( ! function_exists('alternator'))
 /**
  * Repeater function
  *
- * @access	public
  * @param	string
  * @param	int	number of repeats
  * @return	string
diff --git a/system/helpers/text_helper.php b/system/helpers/text_helper.php
index bddb112b2..9a56159d9 100644
--- a/system/helpers/text_helper.php
+++ b/system/helpers/text_helper.php
@@ -42,9 +42,8 @@
  *
  * Limits a string to X number of words.
  *
- * @access	public
  * @param	string
- * @param	integer
+ * @param	int
  * @param	string	the end character. Usually an ellipsis
  * @return	string
  */
@@ -76,9 +75,8 @@ if ( ! function_exists('word_limiter'))
  * Limits the string based on the character count. Preserves complete words
  * so the character count may not be exactly as specified.
  *
- * @access	public
  * @param	string
- * @param	integer
+ * @param	int
  * @param	string	the end character. Usually an ellipsis
  * @return	string
  */
@@ -119,7 +117,6 @@ if ( ! function_exists('character_limiter'))
  *
  * Converts High ascii text and MS Word special characters to character entities
  *
- * @access	public
  * @param	string
  * @return	string
  */
@@ -182,7 +179,6 @@ if ( ! function_exists('ascii_to_entities'))
  *
  * Converts character entities back to ASCII
  *
- * @access	public
  * @param	string
  * @param	bool
  * @return	string
@@ -238,7 +234,6 @@ if ( ! function_exists('entities_to_ascii'))
  * matched words will be converted to #### or to the replacement
  * word you've submitted.
  *
- * @access	public
  * @param	string	the text string
  * @param	string	the array of censoered words
  * @param	string	the optional replacement value
@@ -284,7 +279,6 @@ if ( ! function_exists('word_censor'))
  *
  * Colorizes code strings
  *
- * @access	public
  * @param	string	the text string
  * @return	string
  */
@@ -334,7 +328,6 @@ if ( ! function_exists('highlight_code'))
  *
  * Highlights a phrase within a text string
  *
- * @access	public
  * @param	string	the text string
  * @param	string	the phrase you'd like to highlight
  * @param	string	the openging tag to precede the phrase with
@@ -364,7 +357,6 @@ if ( ! function_exists('highlight_phrase'))
 /**
  * Convert Accented Foreign Characters to ASCII
  *
- * @access	public
  * @param	string	the text string
  * @return	string
  */
@@ -404,9 +396,8 @@ if ( ! function_exists('convert_accented_characters'))
  * Anything placed between {unwrap}{/unwrap} will not be word wrapped, nor
  * will URLs.
  *
- * @access	public
  * @param	string	the text string
- * @param	integer	the number of characters to wrap at
+ * @param	int	the number of characters to wrap at
  * @return	string
  */
 if ( ! function_exists('word_wrap'))
@@ -467,8 +458,8 @@ if ( ! function_exists('word_wrap'))
 				}
 
 				// Trim the word down
-				$temp .= substr($line, 0, $charlim-1);
-				$line = substr($line, $charlim-1);
+				$temp .= substr($line, 0, $charlim - 1);
+				$line = substr($line, $charlim - 1);
 			}
 
 			// If $temp contains data it means we had to split up an over-length
@@ -504,11 +495,11 @@ if ( ! function_exists('word_wrap'))
  *
  * This function will strip tags from a string, split it at its max_length and ellipsize
  *
- * @param	string		string to ellipsize
- * @param	integer		max length of string
- * @param	mixed		int (1|0) or float, .5, .2, etc for position to split
- * @param	string		ellipsis ; Default '...'
- * @return	string		ellipsized string
+ * @param	string	string to ellipsize
+ * @param	int	max length of string
+ * @param	mixed	int (1|0) or float, .5, .2, etc for position to split
+ * @param	string	ellipsis ; Default '...'
+ * @return	string	ellipsized string
  */
 if ( ! function_exists('ellipsize'))
 {