r62137 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r62136‎ | r62137 | r62138 >
Date:20:41, 8 February 2010
Author:ialex
Status:ok
Tags:
Comment:
Fixed some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/specials/SpecialMostlinked.php (modified) (history)
  • /trunk/phase3/includes/specials/SpecialMostlinkedtemplates.php (modified) (history)
  • /trunk/phase3/includes/specials/SpecialUncategorizedtemplates.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/specials/SpecialMostlinkedtemplates.php
@@ -16,7 +16,7 @@
1717 /**
1818 * Name of the report
1919 *
20 - * @return string
 20+ * @return String
2121 */
2222 public function getName() {
2323 return 'Mostlinkedtemplates';
@@ -25,7 +25,7 @@
2626 /**
2727 * Is this report expensive, i.e should it be cached?
2828 *
29 - * @return bool
 29+ * @return Boolean
3030 */
3131 public function isExpensive() {
3232 return true;
@@ -34,7 +34,7 @@
3535 /**
3636 * Is there a feed available?
3737 *
38 - * @return bool
 38+ * @return Boolean
3939 */
4040 public function isSyndicated() {
4141 return false;
@@ -43,7 +43,7 @@
4444 /**
4545 * Sort the results in descending order?
4646 *
47 - * @return bool
 47+ * @return Boolean
4848 */
4949 public function sortDescending() {
5050 return true;
@@ -52,7 +52,7 @@
5353 /**
5454 * Generate SQL for the report
5555 *
56 - * @return string
 56+ * @return String
5757 */
5858 public function getSql() {
5959 $dbr = wfGetDB( DB_SLAVE );
@@ -70,8 +70,8 @@
7171 /**
7272 * Pre-cache page existence to speed up link generation
7373 *
74 - * @param Database $dbr Database connection
75 - * @param int $res Result pointer
 74+ * @param $db Database connection
 75+ * @param $res ResultWrapper
7676 */
7777 public function preprocessResults( $db, $res ) {
7878 $batch = new LinkBatch();
@@ -86,9 +86,9 @@
8787 /**
8888 * Format a result row
8989 *
90 - * @param Skin $skin Skin to use for UI elements
91 - * @param object $result Result row
92 - * @return string
 90+ * @param $skin Skin to use for UI elements
 91+ * @param $result Result row
 92+ * @return String
9393 */
9494 public function formatResult( $skin, $result ) {
9595 $title = Title::makeTitleSafe( $result->namespace, $result->title );
@@ -102,10 +102,10 @@
103103 /**
104104 * Make a "what links here" link for a given title
105105 *
106 - * @param Title $title Title to make the link for
107 - * @param Skin $skin Skin to use
108 - * @param object $result Result row
109 - * @return string
 106+ * @param $title Title to make the link for
 107+ * @param $skin Skin to use
 108+ * @param $result Result row
 109+ * @return String
110110 */
111111 private function makeWlhLink( $title, $skin, $result ) {
112112 global $wgLang;
@@ -119,7 +119,7 @@
120120 /**
121121 * Execution function
122122 *
123 - * @param mixed $par Parameters passed to the page
 123+ * @param $par Mixed: parameters passed to the page
124124 */
125125 function wfSpecialMostlinkedtemplates( $par = false ) {
126126 list( $limit, $offset ) = wfCheckLimits();
Index: trunk/phase3/includes/specials/SpecialUncategorizedtemplates.php
@@ -23,8 +23,6 @@
2424
2525 /**
2626 * Main execution point
27 - *
28 - * @param mixed $par Parameter passed to the page
2927 */
3028 function wfSpecialUncategorizedtemplates() {
3129 list( $limit, $offset ) = wfCheckLimits();
Index: trunk/phase3/includes/specials/SpecialMostlinked.php
@@ -70,8 +70,9 @@
7171 * Make a link to "what links here" for the specified title
7272 *
7373 * @param $title Title being queried
 74+ * @param $caption String: text to display on the link
7475 * @param $skin Skin to use
75 - * @return string
 76+ * @return String
7677 */
7778 function makeWlhLink( &$title, $caption, &$skin ) {
7879 $wlh = SpecialPage::getTitleFor( 'Whatlinkshere', $title->getPrefixedDBkey() );

Status & tagging log