From 1ec45bef2e95fd665ea815274319fd0f3c460f18 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Wed, 9 Jun 2010 14:57:59 +0000 Subject: [PATCH] Fixed some doxygen warnings --- includes/parser/CoreParserFunctions.php | 2 +- includes/parser/DateFormatter.php | 1 + includes/parser/LinkHolderArray.php | 9 ++++++--- includes/parser/ParserOptions.php | 4 +++- includes/parser/Preprocessor_DOM.php | 6 +++--- includes/parser/Preprocessor_Hash.php | 6 +++--- includes/parser/Tidy.php | 6 +++--- 7 files changed, 20 insertions(+), 14 deletions(-) diff --git a/includes/parser/CoreParserFunctions.php b/includes/parser/CoreParserFunctions.php index c3e9884eac..92897428db 100644 --- a/includes/parser/CoreParserFunctions.php +++ b/includes/parser/CoreParserFunctions.php @@ -131,7 +131,7 @@ class CoreParserFunctions { * Or to encode a value for the HTTP "path", spaces are encoded as '%20'. * For links to "wiki"s, or similar software, spaces are encoded as '_', * - * @param $parser. + * @param $parser Parser object * @param $s String: The text to encode. * @param $arg String (optional): The type of encoding. */ diff --git a/includes/parser/DateFormatter.php b/includes/parser/DateFormatter.php index 602bcff370..83b609de0c 100644 --- a/includes/parser/DateFormatter.php +++ b/includes/parser/DateFormatter.php @@ -116,6 +116,7 @@ class DateFormatter /** * @param $preference String: User preference * @param $text String: Text to reformat + * @param $options Array: can contain 'linked' and/or 'match-whole' */ function reformat( $preference, $text, $options = array('linked') ) { diff --git a/includes/parser/LinkHolderArray.php b/includes/parser/LinkHolderArray.php index 00e5ef5b97..17cffe86a6 100644 --- a/includes/parser/LinkHolderArray.php +++ b/includes/parser/LinkHolderArray.php @@ -405,8 +405,9 @@ class LinkHolderArray { /** * Replace link placeholders with plain text of links * (not HTML-formatted). - * @param string $text - * @return string + * + * @param $text String + * @return String */ function replaceText( $text ) { wfProfileIn( __METHOD__ ); @@ -421,7 +422,9 @@ class LinkHolderArray { } /** - * @param array $matches + * Callback for replaceText() + * + * @param $matches Array * @return string * @private */ diff --git a/includes/parser/ParserOptions.php b/includes/parser/ParserOptions.php index 985bba28ec..71377e311d 100644 --- a/includes/parser/ParserOptions.php +++ b/includes/parser/ParserOptions.php @@ -111,7 +111,9 @@ class ParserOptions { /** * Get parser options - * @static + * + * @param $user User object + * @return ParserOptions object */ static function newFromUser( $user ) { return new ParserOptions( $user ); diff --git a/includes/parser/Preprocessor_DOM.php b/includes/parser/Preprocessor_DOM.php index 673ac241f3..625dc8a801 100644 --- a/includes/parser/Preprocessor_DOM.php +++ b/includes/parser/Preprocessor_DOM.php @@ -45,8 +45,8 @@ class Preprocessor_DOM implements Preprocessor { * Preprocess some wikitext and return the document tree. * This is the ghost of Parser::replace_variables(). * - * @param string $text The text to parse - * @param integer flags Bitwise combination of: + * @param $text String: the text to parse + * @param $flags Integer: bitwise combination of: * Parser::PTD_FOR_INCLUSION Handle / as if the text is being * included. Default is to assume a direct page view. * @@ -822,7 +822,7 @@ class PPFrame_DOM implements PPFrame { /** * Construct a new preprocessor frame. - * @param Preprocessor $preprocessor The parent preprocessor + * @param $preprocessor Preprocessor: The parent preprocessor */ function __construct( $preprocessor ) { $this->preprocessor = $preprocessor; diff --git a/includes/parser/Preprocessor_Hash.php b/includes/parser/Preprocessor_Hash.php index c5d69685e4..5015f1250e 100644 --- a/includes/parser/Preprocessor_Hash.php +++ b/includes/parser/Preprocessor_Hash.php @@ -27,8 +27,8 @@ class Preprocessor_Hash implements Preprocessor { * Preprocess some wikitext and return the document tree. * This is the ghost of Parser::replace_variables(). * - * @param string $text The text to parse - * @param integer flags Bitwise combination of: + * @param $text String: the text to parse + * @param $flags Integer: bitwise combination of: * Parser::PTD_FOR_INCLUSION Handle / as if the text is being * included. Default is to assume a direct page view. * @@ -804,7 +804,7 @@ class PPFrame_Hash implements PPFrame { /** * Construct a new preprocessor frame. - * @param Preprocessor $preprocessor The parent preprocessor + * @param $preprocessor Preprocessor: the parent preprocessor */ function __construct( $preprocessor ) { $this->preprocessor = $preprocessor; diff --git a/includes/parser/Tidy.php b/includes/parser/Tidy.php index 85e5394993..a4bd19b63a 100644 --- a/includes/parser/Tidy.php +++ b/includes/parser/Tidy.php @@ -16,8 +16,8 @@ class MWTidy { * If tidy isn't able to correct the markup, the original will be * returned in all its glory with a warning comment appended. * - * @param string $text Hideous HTML input - * @return string Corrected HTML output + * @param $text String: hideous HTML input + * @return String: corrected HTML output */ public static function tidy( $text ) { global $wgTidyInternal; @@ -71,7 +71,7 @@ class MWTidy { * @param $text String: HTML to check * @param $stderr Boolean: Whether to read from STDERR rather than STDOUT * @param &$retval Exit code (-1 on internal error) - * @retrun mixed String or null + * @return mixed String or null */ private static function execExternalTidy( $text, $stderr = false, &$retval = null ) { global $wgTidyConf, $wgTidyBin, $wgTidyOpts; -- 2.20.1