From 4a55917201573d0f7deefd6c6ecda6decc1c3681 Mon Sep 17 00:00:00 2001 From: Happy-melon Date: Sun, 26 Jun 2011 23:40:43 +0000 Subject: [PATCH] Follow-up r86234, and more parameter documentation. --- includes/Skin.php | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/includes/Skin.php b/includes/Skin.php index fda64b6df3..4b06e1d86e 100644 --- a/includes/Skin.php +++ b/includes/Skin.php @@ -282,6 +282,8 @@ abstract class Skin { * as their "relevant" title, this allows the skin system to display things * such as content tabs which belong to to that page instead of displaying * a basic special page tab which has almost no meaning. + * + * @return Title */ public function getRelevantTitle() { if ( isset($this->mRelevantTitle) ) { @@ -329,7 +331,7 @@ abstract class Skin { /** * Outputs the HTML generated by other functions. - * @param $out Object: instance of OutputPage + * @param $out OutputPage */ abstract function outputPage( OutputPage $out ); @@ -398,6 +400,8 @@ abstract class Skin { /** * @private + * @todo document + * @param $out OutputPage */ function setupUserCss( OutputPage $out ) { global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs; @@ -495,6 +499,8 @@ abstract class Skin { * This will be called by OutputPage::headElement when it is creating the * tag, skins can override it if they have a need to add in any * body attributes or classes of their own. + * @param $out OutputPage + * @param $bodyAttrs Array */ function addToBodyAttributes( $out, &$bodyAttrs ) { // does nothing by default @@ -502,6 +508,7 @@ abstract class Skin { /** * URL to the logo + * @return String */ function getLogo() { global $wgLogo; @@ -564,7 +571,7 @@ abstract class Skin { $parenttree = $this->getTitle()->getParentCategoryTree(); # Skin object passed by reference cause it can not be # accessed under the method subfunction drawCategoryBrowser - $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree, $this ) ); + $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) ); # Clean out bogus first entry and sort them unset( $tempout[0] ); asort( $tempout ); @@ -631,7 +638,7 @@ abstract class Skin { * The output of this function gets processed in SkinTemplate::outputPage() for * the SkinTemplate based skins, all other skins should directly echo it. * - * Returns an empty string by default, if not changed by any hook function. + * @return String, empty by default, if not changed by any hook function. */ protected function afterContentHook() { $data = ''; @@ -826,6 +833,7 @@ abstract class Skin { /** * Returns true if the IP should be shown in the header + * @return Bool */ function showIPinHeader() { global $wgShowIPinHeader; @@ -975,7 +983,8 @@ abstract class Skin { /** * Renders a $wgFooterIcons icon acording to the method's arguments * @param $icon Array: The icon to build the html for, see $wgFooterIcons for the format of this array - * @param $withImage Boolean: Whether to use the icon's image or output a text-only footericon + * @param $withImage Bool|String: Whether to use the icon's image or output a text-only footericon + * @return String HTML */ function makeFooterIcon( $icon, $withImage = 'withImage' ) { if ( is_string( $icon ) ) { @@ -1031,6 +1040,7 @@ abstract class Skin { /** * Gets the link to the wiki's privacy policy page. + * @return String HTML */ function privacyLink() { return $this->footerLink( 'privacy', 'privacypage' ); @@ -1038,6 +1048,7 @@ abstract class Skin { /** * Gets the link to the wiki's about page. + * @return String HTML */ function aboutLink() { return $this->footerLink( 'aboutsite', 'aboutpage' ); @@ -1045,6 +1056,7 @@ abstract class Skin { /** * Gets the link to the wiki's general disclaimers page. + * @return String HTML */ function disclaimerLink() { return $this->footerLink( 'disclaimers', 'disclaimerpage' ); @@ -1131,6 +1143,8 @@ abstract class Skin { /** * If url string starts with http, consider as external URL, else * internal + * @param $name String + * @return String URL */ static function makeInternalOrExternalUrl( $name ) { if ( preg_match( '/^(?:' . wfUrlProtocols() . ')/', $name ) ) { @@ -1161,6 +1175,9 @@ abstract class Skin { /** * Make URL details where the article exists (or at least it's convenient to think so) + * @param $name String Article name + * @param $urlaction String + * @return Array */ static function makeKnownUrlDetails( $name, $urlaction = '' ) { $title = Title::newFromText( $name ); @@ -1230,6 +1247,7 @@ abstract class Skin { * @since 1.17 * @param &$bar array * @param $text string + * @return Array */ function addToSidebarPlain( &$bar, $text ) { $lines = explode( "\n", $text ); -- 2.20.1