Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed some doxygen warnings

Browse source
This commit is contained in:
Alexandre Emsenhuber 2010-03-29 20:10:29 +00:00
parent 4bb862c122
commit 55234801e1
1 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
includes/StringUtils.php
View file

@ -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 );