r66050 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r66049‎ | r66050 | r66051 >
Date:21:01, 7 May 2010
Author:ialex
Status:ok
Tags:
Comment:
Fixed some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/specials/SpecialAllpages.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/specials/SpecialAllpages.php
@@ -32,8 +32,8 @@
3333
3434 /**
3535 * Entry point : initialise variables and call subfunctions.
 36+ *
3637 * @param $par String: becomes "FOO" when called like Special:Allpages/FOO (default NULL)
37 - * @param $specialPage See the SpecialPage object.
3838 */
3939 function execute( $par ) {
4040 global $wgRequest, $wgOut, $wgContLang;
@@ -65,9 +65,10 @@
6666
6767 /**
6868 * HTML for the top form
69 - * @param integer $namespace A namespace constant (default NS_MAIN).
70 - * @param string $from dbKey we are starting listing at.
71 - * @param string $to dbKey we are ending listing at.
 69+ *
 70+ * @param $namespace Integer: a namespace constant (default NS_MAIN).
 71+ * @param $from String: dbKey we are starting listing at.
 72+ * @param $to String: dbKey we are ending listing at.
7273 */
7374 function namespaceForm( $namespace = NS_MAIN, $from = '', $to = '' ) {
7475 global $wgScript;
@@ -112,7 +113,9 @@
113114 }
114115
115116 /**
116 - * @param integer $namespace (default NS_MAIN)
 117+ * @param $namespace Integer (default NS_MAIN)
 118+ * @param $from String: list all pages from this name
 119+ * @param $to String: list all pages to this name
117120 */
118121 function showToplevel( $namespace = NS_MAIN, $from = '', $to = '' ) {
119122 global $wgOut;
@@ -233,9 +236,10 @@
234237
235238 /**
236239 * Show a line of "ABC to DEF" ranges of articles
237 - * @param string $inpoint Lower limit of pagenames
238 - * @param string $outpout Upper limit of pagenames
239 - * @param integer $namespace (Default NS_MAIN)
 240+ *
 241+ * @param $inpoint String: lower limit of pagenames
 242+ * @param $outpoint String: upper limit of pagenames
 243+ * @param $namespace Integer (Default NS_MAIN)
240244 */
241245 function showline( $inpoint, $outpoint, $namespace = NS_MAIN ) {
242246 global $wgContLang;
@@ -257,9 +261,9 @@
258262 }
259263
260264 /**
261 - * @param integer $namespace (Default NS_MAIN)
262 - * @param string $from list all pages from this name (default FALSE)
263 - * @param string $to list all pages to this name (default FALSE)
 265+ * @param $namespace Integer (Default NS_MAIN)
 266+ * @param $from String: list all pages from this name (default FALSE)
 267+ * @param $to String: list all pages to this name (default FALSE)
264268 */
265269 function showChunk( $namespace = NS_MAIN, $from = false, $to = false ) {
266270 global $wgOut, $wgUser, $wgContLang, $wgLang;
@@ -436,8 +440,8 @@
437441 }
438442
439443 /**
440 - * @param int $ns the namespace of the article
441 - * @param string $text the name of the article
 444+ * @param $ns Integer: the namespace of the article
 445+ * @param $text String: the name of the article
442446 * @return array( int namespace, string dbkey, string pagename ) or NULL on error
443447 * @static (sort of)
444448 * @access private

Status & tagging log