From: umherirrender Date: Thu, 17 Apr 2014 12:34:58 +0000 (+0200) Subject: Fixed some @params documentation (skins) X-Git-Tag: 1.31.0-rc.0~16183 X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=5b12099f8f78e286905c6d268038d30f887e9ca5;p=lhc%2Fweb%2Fwiklou.git Fixed some @params documentation (skins) Swapped some "$var type" to "type $var" or added missing types before the $var. Changed some other types to match the more common spelling. Makes beginning of some text in captial. Also added some missing @param. Change-Id: I3f6affbf6f58ec83d6290cdc15a83d7956ce653a --- diff --git a/skins/CologneBlue.php b/skins/CologneBlue.php index 7c2860eb7d..3b534687a8 100644 --- a/skins/CologneBlue.php +++ b/skins/CologneBlue.php @@ -36,7 +36,7 @@ class SkinCologneBlue extends SkinTemplate { var $useHeadElement = true; /** - * @param $out OutputPage + * @param OutputPage $out */ function setupSkinUserCss( OutputPage $out ) { parent::setupSkinUserCss( $out ); @@ -47,6 +47,8 @@ class SkinCologneBlue extends SkinTemplate { /** * Override langlink formatting behavior not to uppercase the language names. * See otherLanguages() in CologneBlueTemplate. + * @param string $name + * @return string */ function formatLanguageName( $name ) { return $name; @@ -137,9 +139,9 @@ class CologneBlueTemplate extends BaseTemplate { /** * Used in bottomLinks() to eliminate repetitive code. * - * @param $key string Key to be passed to makeListItem() - * @param $navlink array Navlink suitable for processNavlinkForDocument() - * @param $message string Key of the message to use in place of standard text + * @param string $key Key to be passed to makeListItem() + * @param array $navlink Navlink suitable for processNavlinkForDocument() + * @param string $message Key of the message to use in place of standard text * * @return string */ @@ -257,8 +259,8 @@ class CologneBlueTemplate extends BaseTemplate { * and removes the accesskeys. This is necessary to be able to use the same navlink twice, * e.g. in sidebar and in footer. * - * @param $navlink array Navigational link generated by SkinTemplate - * @param $idPrefix mixed Prefix to add to id of this navlink. If false, id is removed entirely. Default is 'cb-'. + * @param array $navlink Navigational link generated by SkinTemplate + * @param mixed $idPrefix Prefix to add to id of this navlink. If false, id is removed entirely. Default is 'cb-'. */ function processNavlinkForDocument( $navlink, $idPrefix = 'cb-' ) { if ( $navlink['id'] ) { @@ -407,8 +409,8 @@ class CologneBlueTemplate extends BaseTemplate { /** * Adds CologneBlue-specific items to the sidebar: qbedit, qbpageoptions and qbmyoptions menus. * - * @param $bar sidebar data - * @return array modified sidebar data + * @param array $bar Sidebar data + * @return array Modified sidebar data */ function sidebarAdditions( $bar ) { // "This page" and "Edit" menus @@ -543,7 +545,7 @@ class CologneBlueTemplate extends BaseTemplate { } /** - * @param $label string + * @param string $label * @return string */ function searchForm( $which ) { diff --git a/skins/Modern.php b/skins/Modern.php index 8d778cf621..81c0f515fb 100644 --- a/skins/Modern.php +++ b/skins/Modern.php @@ -36,7 +36,7 @@ class SkinModern extends SkinTemplate { $template = 'ModernTemplate', $useHeadElement = true; /** - * @param $out OutputPage + * @param OutputPage $out */ function setupSkinUserCss( OutputPage $out ) { parent::setupSkinUserCss( $out ); diff --git a/skins/MonoBook.php b/skins/MonoBook.php index 34f59655b7..fe6a25f114 100644 --- a/skins/MonoBook.php +++ b/skins/MonoBook.php @@ -40,7 +40,7 @@ class SkinMonoBook extends SkinTemplate { $template = 'MonoBookTemplate', $useHeadElement = true; /** - * @param $out OutputPage + * @param OutputPage $out */ function setupSkinUserCss( OutputPage $out ) { parent::setupSkinUserCss( $out ); @@ -172,7 +172,7 @@ echo $footerEnd; /*************************************************************************************************/ /** - * @param $sidebar array + * @param array $sidebar */ protected function renderPortals( $sidebar ) { if ( !isset( $sidebar['SEARCH'] ) ) { @@ -295,8 +295,8 @@ echo $footerEnd; /*************************************************************************************************/ /** - * @param $bar string - * @param $cont array|string + * @param string $bar + * @param array|string $cont */ function customBox( $bar, $cont ) { $portletAttribs = array( 'class' => 'generated-sidebar portlet', 'id' => Sanitizer::escapeId( "p-$bar" ), 'role' => 'navigation' ); diff --git a/skins/Vector.php b/skins/Vector.php index 5b944ebb54..8ede82a2e0 100644 --- a/skins/Vector.php +++ b/skins/Vector.php @@ -40,7 +40,7 @@ class SkinVector extends SkinTemplate { /** * Initializes output page and sets up skin-specific parameters - * @param $out OutputPage object to initialize + * @param OutputPage $out Object to initialize */ public function initPage( OutputPage $out ) { global $wgLocalStylePath; @@ -62,7 +62,7 @@ class SkinVector extends SkinTemplate { /** * Loads skin and user CSS files. - * @param $out OutputPage object + * @param OutputPage $out */ function setupSkinUserCss( OutputPage $out ) { parent::setupSkinUserCss( $out ); @@ -75,8 +75,8 @@ class SkinVector extends SkinTemplate { /** * Adds classes to the body element. * - * @param $out OutputPage object - * @param &$bodyAttrs Array of attributes that will be set on the body element + * @param OutputPage $out + * @param array &$bodyAttrs Array of attributes that will be set on the body element */ function addToBodyAttributes( $out, &$bodyAttrs ) { if ( isset( $bodyAttrs['class'] ) && strlen( $bodyAttrs['class'] ) > 0 ) { @@ -249,7 +249,7 @@ class VectorTemplate extends BaseTemplate { /** * Render a series of portals * - * @param $portals array + * @param array $portals */ protected function renderPortals( $portals ) { // Force the rendering of the following portals @@ -287,10 +287,10 @@ class VectorTemplate extends BaseTemplate { } /** - * @param $name string - * @param $content array - * @param $msg null|string - * @param $hook null|string|array + * @param string $name + * @param array $content + * @param null|string $msg + * @param null|string|array $hook */ protected function renderPortal( $name, $content, $msg = null, $hook = null ) { if ( $msg === null ) { @@ -332,7 +332,7 @@ class VectorTemplate extends BaseTemplate { * Render one or more navigations elements by name, automatically reveresed * when UI is in RTL mode * - * @param $elements array + * @param array $elements */ protected function renderNavigation( $elements ) { global $wgVectorUseSimpleSearch;