r67726 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r67725‎ | r67726 | r67727 >
Date:14:57, 9 June 2010
Author:ialex
Status:ok
Tags:
Comment:
Fixed some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/parser/CoreParserFunctions.php (modified) (history)
  • /trunk/phase3/includes/parser/DateFormatter.php (modified) (history)
  • /trunk/phase3/includes/parser/LinkHolderArray.php (modified) (history)
  • /trunk/phase3/includes/parser/ParserOptions.php (modified) (history)
  • /trunk/phase3/includes/parser/Preprocessor_DOM.php (modified) (history)
  • /trunk/phase3/includes/parser/Preprocessor_Hash.php (modified) (history)
  • /trunk/phase3/includes/parser/Tidy.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/parser/Preprocessor_Hash.php
@@ -27,8 +27,8 @@
2828 * Preprocess some wikitext and return the document tree.
2929 * This is the ghost of Parser::replace_variables().
3030 *
31 - * @param string $text The text to parse
32 - * @param integer flags Bitwise combination of:
 31+ * @param $text String: the text to parse
 32+ * @param $flags Integer: bitwise combination of:
3333 * Parser::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being
3434 * included. Default is to assume a direct page view.
3535 *
@@ -804,7 +804,7 @@
805805
806806 /**
807807 * Construct a new preprocessor frame.
808 - * @param Preprocessor $preprocessor The parent preprocessor
 808+ * @param $preprocessor Preprocessor: the parent preprocessor
809809 */
810810 function __construct( $preprocessor ) {
811811 $this->preprocessor = $preprocessor;
Index: trunk/phase3/includes/parser/Tidy.php
@@ -16,8 +16,8 @@
1717 * If tidy isn't able to correct the markup, the original will be
1818 * returned in all its glory with a warning comment appended.
1919 *
20 - * @param string $text Hideous HTML input
21 - * @return string Corrected HTML output
 20+ * @param $text String: hideous HTML input
 21+ * @return String: corrected HTML output
2222 */
2323 public static function tidy( $text ) {
2424 global $wgTidyInternal;
@@ -71,7 +71,7 @@
7272 * @param $text String: HTML to check
7373 * @param $stderr Boolean: Whether to read from STDERR rather than STDOUT
7474 * @param &$retval Exit code (-1 on internal error)
75 - * @retrun mixed String or null
 75+ * @return mixed String or null
7676 */
7777 private static function execExternalTidy( $text, $stderr = false, &$retval = null ) {
7878 global $wgTidyConf, $wgTidyBin, $wgTidyOpts;
Index: trunk/phase3/includes/parser/LinkHolderArray.php
@@ -405,8 +405,9 @@
406406 /**
407407 * Replace <!--LINK--> link placeholders with plain text of links
408408 * (not HTML-formatted).
409 - * @param string $text
410 - * @return string
 409+ *
 410+ * @param $text String
 411+ * @return String
411412 */
412413 function replaceText( $text ) {
413414 wfProfileIn( __METHOD__ );
@@ -421,7 +422,9 @@
422423 }
423424
424425 /**
425 - * @param array $matches
 426+ * Callback for replaceText()
 427+ *
 428+ * @param $matches Array
426429 * @return string
427430 * @private
428431 */
Index: trunk/phase3/includes/parser/CoreParserFunctions.php
@@ -131,7 +131,7 @@
132132 * Or to encode a value for the HTTP "path", spaces are encoded as '%20'.
133133 * For links to "wiki"s, or similar software, spaces are encoded as '_',
134134 *
135 - * @param $parser.
 135+ * @param $parser Parser object
136136 * @param $s String: The text to encode.
137137 * @param $arg String (optional): The type of encoding.
138138 */
Index: trunk/phase3/includes/parser/DateFormatter.php
@@ -116,6 +116,7 @@
117117 /**
118118 * @param $preference String: User preference
119119 * @param $text String: Text to reformat
 120+ * @param $options Array: can contain 'linked' and/or 'match-whole'
120121 */
121122 function reformat( $preference, $text, $options = array('linked') ) {
122123
Index: trunk/phase3/includes/parser/Preprocessor_DOM.php
@@ -45,8 +45,8 @@
4646 * Preprocess some wikitext and return the document tree.
4747 * This is the ghost of Parser::replace_variables().
4848 *
49 - * @param string $text The text to parse
50 - * @param integer flags Bitwise combination of:
 49+ * @param $text String: the text to parse
 50+ * @param $flags Integer: bitwise combination of:
5151 * Parser::PTD_FOR_INCLUSION Handle <noinclude>/<includeonly> as if the text is being
5252 * included. Default is to assume a direct page view.
5353 *
@@ -822,7 +822,7 @@
823823
824824 /**
825825 * Construct a new preprocessor frame.
826 - * @param Preprocessor $preprocessor The parent preprocessor
 826+ * @param $preprocessor Preprocessor: The parent preprocessor
827827 */
828828 function __construct( $preprocessor ) {
829829 $this->preprocessor = $preprocessor;
Index: trunk/phase3/includes/parser/ParserOptions.php
@@ -111,7 +111,9 @@
112112
113113 /**
114114 * Get parser options
115 - * @static
 115+ *
 116+ * @param $user User object
 117+ * @return ParserOptions object
116118 */
117119 static function newFromUser( $user ) {
118120 return new ParserOptions( $user );

Status & tagging log