| Index: trunk/phase3/includes/Skin.php |
| — | — | @@ -282,6 +282,8 @@ |
| 283 | 283 | * as their "relevant" title, this allows the skin system to display things |
| 284 | 284 | * such as content tabs which belong to to that page instead of displaying |
| 285 | 285 | * a basic special page tab which has almost no meaning. |
| | 286 | + * |
| | 287 | + * @return Title |
| 286 | 288 | */ |
| 287 | 289 | public function getRelevantTitle() { |
| 288 | 290 | if ( isset($this->mRelevantTitle) ) { |
| — | — | @@ -329,7 +331,7 @@ |
| 330 | 332 | |
| 331 | 333 | /** |
| 332 | 334 | * Outputs the HTML generated by other functions. |
| 333 | | - * @param $out Object: instance of OutputPage |
| | 335 | + * @param $out OutputPage |
| 334 | 336 | */ |
| 335 | 337 | abstract function outputPage( OutputPage $out ); |
| 336 | 338 | |
| — | — | @@ -398,6 +400,8 @@ |
| 399 | 401 | |
| 400 | 402 | /** |
| 401 | 403 | * @private |
| | 404 | + * @todo document |
| | 405 | + * @param $out OutputPage |
| 402 | 406 | */ |
| 403 | 407 | function setupUserCss( OutputPage $out ) { |
| 404 | 408 | global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs; |
| — | — | @@ -495,6 +499,8 @@ |
| 496 | 500 | * This will be called by OutputPage::headElement when it is creating the |
| 497 | 501 | * <body> tag, skins can override it if they have a need to add in any |
| 498 | 502 | * body attributes or classes of their own. |
| | 503 | + * @param $out OutputPage |
| | 504 | + * @param $bodyAttrs Array |
| 499 | 505 | */ |
| 500 | 506 | function addToBodyAttributes( $out, &$bodyAttrs ) { |
| 501 | 507 | // does nothing by default |
| — | — | @@ -502,6 +508,7 @@ |
| 503 | 509 | |
| 504 | 510 | /** |
| 505 | 511 | * URL to the logo |
| | 512 | + * @return String |
| 506 | 513 | */ |
| 507 | 514 | function getLogo() { |
| 508 | 515 | global $wgLogo; |
| — | — | @@ -564,7 +571,7 @@ |
| 565 | 572 | $parenttree = $this->getTitle()->getParentCategoryTree(); |
| 566 | 573 | # Skin object passed by reference cause it can not be |
| 567 | 574 | # accessed under the method subfunction drawCategoryBrowser |
| 568 | | - $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree, $this ) ); |
| | 575 | + $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) ); |
| 569 | 576 | # Clean out bogus first entry and sort them |
| 570 | 577 | unset( $tempout[0] ); |
| 571 | 578 | asort( $tempout ); |
| — | — | @@ -631,7 +638,7 @@ |
| 632 | 639 | * The output of this function gets processed in SkinTemplate::outputPage() for |
| 633 | 640 | * the SkinTemplate based skins, all other skins should directly echo it. |
| 634 | 641 | * |
| 635 | | - * Returns an empty string by default, if not changed by any hook function. |
| | 642 | + * @return String, empty by default, if not changed by any hook function. |
| 636 | 643 | */ |
| 637 | 644 | protected function afterContentHook() { |
| 638 | 645 | $data = ''; |
| — | — | @@ -826,6 +833,7 @@ |
| 827 | 834 | |
| 828 | 835 | /** |
| 829 | 836 | * Returns true if the IP should be shown in the header |
| | 837 | + * @return Bool |
| 830 | 838 | */ |
| 831 | 839 | function showIPinHeader() { |
| 832 | 840 | global $wgShowIPinHeader; |
| — | — | @@ -975,7 +983,8 @@ |
| 976 | 984 | /** |
| 977 | 985 | * Renders a $wgFooterIcons icon acording to the method's arguments |
| 978 | 986 | * @param $icon Array: The icon to build the html for, see $wgFooterIcons for the format of this array |
| 979 | | - * @param $withImage Boolean: Whether to use the icon's image or output a text-only footericon |
| | 987 | + * @param $withImage Bool|String: Whether to use the icon's image or output a text-only footericon |
| | 988 | + * @return String HTML |
| 980 | 989 | */ |
| 981 | 990 | function makeFooterIcon( $icon, $withImage = 'withImage' ) { |
| 982 | 991 | if ( is_string( $icon ) ) { |
| — | — | @@ -1031,6 +1040,7 @@ |
| 1032 | 1041 | |
| 1033 | 1042 | /** |
| 1034 | 1043 | * Gets the link to the wiki's privacy policy page. |
| | 1044 | + * @return String HTML |
| 1035 | 1045 | */ |
| 1036 | 1046 | function privacyLink() { |
| 1037 | 1047 | return $this->footerLink( 'privacy', 'privacypage' ); |
| — | — | @@ -1038,6 +1048,7 @@ |
| 1039 | 1049 | |
| 1040 | 1050 | /** |
| 1041 | 1051 | * Gets the link to the wiki's about page. |
| | 1052 | + * @return String HTML |
| 1042 | 1053 | */ |
| 1043 | 1054 | function aboutLink() { |
| 1044 | 1055 | return $this->footerLink( 'aboutsite', 'aboutpage' ); |
| — | — | @@ -1045,6 +1056,7 @@ |
| 1046 | 1057 | |
| 1047 | 1058 | /** |
| 1048 | 1059 | * Gets the link to the wiki's general disclaimers page. |
| | 1060 | + * @return String HTML |
| 1049 | 1061 | */ |
| 1050 | 1062 | function disclaimerLink() { |
| 1051 | 1063 | return $this->footerLink( 'disclaimers', 'disclaimerpage' ); |
| — | — | @@ -1131,6 +1143,8 @@ |
| 1132 | 1144 | /** |
| 1133 | 1145 | * If url string starts with http, consider as external URL, else |
| 1134 | 1146 | * internal |
| | 1147 | + * @param $name String |
| | 1148 | + * @return String URL |
| 1135 | 1149 | */ |
| 1136 | 1150 | static function makeInternalOrExternalUrl( $name ) { |
| 1137 | 1151 | if ( preg_match( '/^(?:' . wfUrlProtocols() . ')/', $name ) ) { |
| — | — | @@ -1161,6 +1175,9 @@ |
| 1162 | 1176 | |
| 1163 | 1177 | /** |
| 1164 | 1178 | * Make URL details where the article exists (or at least it's convenient to think so) |
| | 1179 | + * @param $name String Article name |
| | 1180 | + * @param $urlaction String |
| | 1181 | + * @return Array |
| 1165 | 1182 | */ |
| 1166 | 1183 | static function makeKnownUrlDetails( $name, $urlaction = '' ) { |
| 1167 | 1184 | $title = Title::newFromText( $name ); |
| — | — | @@ -1230,6 +1247,7 @@ |
| 1231 | 1248 | * @since 1.17 |
| 1232 | 1249 | * @param &$bar array |
| 1233 | 1250 | * @param $text string |
| | 1251 | + * @return Array |
| 1234 | 1252 | */ |
| 1235 | 1253 | function addToSidebarPlain( &$bar, $text ) { |
| 1236 | 1254 | $lines = explode( "\n", $text ); |