From 55234801e19ed5cc2dd8fa1576c443ab8273c125 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Mon, 29 Mar 2010 20:10:29 +0000 Subject: [PATCH] Fixed some doxygen warnings --- includes/StringUtils.php | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/includes/StringUtils.php b/includes/StringUtils.php index c437b3c19e..6c8412f210 100644 --- a/includes/StringUtils.php +++ b/includes/StringUtils.php @@ -36,7 +36,11 @@ class StringUtils { * This implementation is slower than hungryDelimiterReplace but uses far less * memory. The delimiters are literal strings, not regular expressions. * - * @param string $flags Regular expression flags + * @param $startDelim String: start delimiter + * @param $endDelim String: end delimiter + * @param $callback Callback: function to call on each match + * @param $subject String + * @param $flags String: regular expression flags */ # If the start delimiter ends with an initial substring of the end delimiter, # e.g. in the case of C-style comments, the behaviour differs from the model @@ -116,12 +120,12 @@ class StringUtils { * * preg_replace( "!$startDelim(.*)$endDelim!$flags", $replace, $subject ) * - * @param string $startDelim Start delimiter regular expression - * @param string $endDelim End delimiter regular expression - * @param string $replace Replacement string. May contain $1, which will be - * replaced by the text between the delimiters - * @param string $subject String to search - * @return string The string with the matches replaced + * @param $startDelim String: start delimiter regular expression + * @param $endDelim String: end delimiter regular expression + * @param $replace String: replacement string. May contain $1, which will be + * replaced by the text between the delimiters + * @param $subject String to search + * @return String: The string with the matches replaced */ static function delimiterReplace( $startDelim, $endDelim, $replace, $subject, $flags = '' ) { $replacer = new RegexlikeReplacer( $replace ); @@ -132,8 +136,8 @@ class StringUtils { /** * More or less "markup-safe" explode() * Ignores any instances of the separator inside <...> - * @param string $separator - * @param string $text + * @param $separator String + * @param $text String * @return array */ static function explodeMarkup( $separator, $text ) { @@ -159,8 +163,8 @@ class StringUtils { * Escape a string to make it suitable for inclusion in a preg_replace() * replacement parameter. * - * @param string $string - * @return string + * @param $string String + * @return String */ static function escapeRegexReplacement( $string ) { $string = str_replace( '\\', '\\\\', $string ); -- 2.20.1