r44046 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r44045‎ | r44046 | r44047 >
Date:19:23, 29 November 2008
Author:ialex
Status:ok
Tags:
Comment:
More doxygen fixes
Modified paths:
  • /trunk/phase3/includes/Category.php (modified) (history)
  • /trunk/phase3/includes/CategoryPage.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/CategoryPage.php
@@ -72,8 +72,6 @@
7373 /**
7474 * Format the category data list.
7575 *
76 - * @param string $from -- return only sort keys from this item on
77 - * @param string $until -- don't return keys after this point.
7876 * @return string HTML output
7977 * @private
8078 */
@@ -131,7 +129,7 @@
132130
133131 /**
134132 * Add a subcategory to the internal lists, using a title object
135 - * @deprectated kept for compatibility, please use addSubcategoryObject instead
 133+ * @deprecated kept for compatibility, please use addSubcategoryObject instead
136134 */
137135 function addSubcategory( $title, $sortkey, $pageLength ) {
138136 global $wgContLang;
@@ -326,10 +324,10 @@
327325 * Format a list of articles chunked by letter, either as a
328326 * bullet list or a columnar format, depending on the length.
329327 *
330 - * @param array $articles
331 - * @param array $articles_start_char
332 - * @param int $cutoff
333 - * @return string
 328+ * @param $articles Array
 329+ * @param $articles_start_char Array
 330+ * @param $cutoff Int
 331+ * @return String
334332 * @private
335333 */
336334 function formatList( $articles, $articles_start_char, $cutoff = 6 ) {
@@ -346,9 +344,9 @@
347345 * Format a list of articles chunked by letter in a three-column
348346 * list, ordered vertically.
349347 *
350 - * @param array $articles
351 - * @param array $articles_start_char
352 - * @return string
 348+ * @param $articles Array
 349+ * @param $articles_start_char Array
 350+ * @return String
353351 * @private
354352 */
355353 function columnList( $articles, $articles_start_char ) {
@@ -405,9 +403,9 @@
406404
407405 /**
408406 * Format a list of articles chunked by letter in a bullet list.
409 - * @param array $articles
410 - * @param array $articles_start_char
411 - * @return string
 407+ * @param $articles Array
 408+ * @param $articles_start_char Array
 409+ * @return String
412410 * @private
413411 */
414412 function shortList( $articles, $articles_start_char ) {
@@ -427,12 +425,12 @@
428426 }
429427
430428 /**
431 - * @param Title $title
432 - * @param string $first
433 - * @param string $last
434 - * @param int $limit
435 - * @param array $query - additional query options to pass
436 - * @return string
 429+ * @param $title Title object
 430+ * @param $first String
 431+ * @param $last String
 432+ * @param $limit Int
 433+ * @param $query Array: additional query options to pass
 434+ * @return String
437435 * @private
438436 */
439437 function pagingLinks( $title, $first, $last, $limit, $query = array() ) {
@@ -464,10 +462,10 @@
465463 * category-subcat-count-limited, category-file-count,
466464 * category-file-count-limited.
467465 *
468 - * @param int $rescnt The number of items returned by our database query.
469 - * @param int $dbcnt The number of items according to the category table.
470 - * @param string $type 'subcat', 'article', or 'file'
471 - * @return string A message giving the number of items, to output to HTML.
 466+ * @param $rescnt Int: The number of items returned by our database query.
 467+ * @param $dbcnt Int: The number of items according to the category table.
 468+ * @param $type String: 'subcat', 'article', or 'file'
 469+ * @return String: A message giving the number of items, to output to HTML.
472470 */
473471 private function getCountMessage( $rescnt, $dbcnt, $type ) {
474472 global $wgLang;
Index: trunk/phase3/includes/Category.php
@@ -81,7 +81,7 @@
8282 /**
8383 * Factory function.
8484 *
85 - * @param array $name A category name (no "Category:" prefix). It need
 85+ * @param $name Array: A category name (no "Category:" prefix). It need
8686 * not be normalized, with spaces replaced by underscores.
8787 * @return mixed Category, or false on a totally invalid name
8888 */
@@ -101,8 +101,8 @@
102102 /**
103103 * Factory function.
104104 *
105 - * @param array $title Title for the category page
106 - * @return mixed Category, or false on a totally invalid name
 105+ * @param $title Title for the category page
 106+ * @return Mixed: category, or false on a totally invalid name
107107 */
108108 public static function newFromTitle( $title ) {
109109 $cat = new self();
@@ -116,7 +116,7 @@
117117 /**
118118 * Factory function.
119119 *
120 - * @param array $id A category id
 120+ * @param $id Integer: a category id
121121 * @return Category
122122 */
123123 public static function newFromID( $id ) {

Status & tagging log