Improve method documentation
authorSam Reed <reedy@users.mediawiki.org>
Sat, 19 Feb 2011 21:16:47 +0000 (21:16 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Sat, 19 Feb 2011 21:16:47 +0000 (21:16 +0000)
Few bits of fixup

includes/Skin.php
skins/Modern.php
skins/MonoBook.php
skins/Standard.php
skins/Vector.php

index ceb8cb1..7d0c549 100644 (file)
@@ -360,7 +360,10 @@ abstract class Skin extends Linker {
                $this->mTitle = $t;
        }
 
-       /** Get the title */
+       /** Get the title
+        *
+        * @return Title
+        */
        public function getTitle() {
                return $this->mTitle;
        }
index 062d571..017be88 100644 (file)
@@ -32,6 +32,10 @@ class SkinModern extends SkinTemplate {
  * @ingroup Skins
  */
 class ModernTemplate extends MonoBookTemplate {
+
+       /**
+        * @var Skin
+        */
        var $skin;
        /**
         * Template filter callback for Modern skin.
@@ -44,7 +48,6 @@ class ModernTemplate extends MonoBookTemplate {
        function execute() {
                global $wgRequest;
                $this->skin = $skin = $this->data['skin'];
-               $action = $wgRequest->getText( 'action' );
 
                // Suppress warnings to prevent notices about missing indexes in $this->data
                wfSuppressWarnings();
index 061f4f6..18e6b9f 100644 (file)
@@ -52,7 +52,12 @@ class SkinMonoBook extends SkinTemplate {
  * @ingroup Skins
  */
 class MonoBookTemplate extends BaseTemplate {
+
+       /**
+        * @var Skin
+        */
        var $skin;
+
        /**
         * Template filter callback for MonoBook skin.
         * Takes an associative array of data set from a SkinTemplate-based
index fb54621..38ed860 100644 (file)
@@ -18,9 +18,6 @@ class SkinStandard extends SkinLegacy {
        var $skinname = 'standard', $stylename = 'standard',
                $template = 'StandardTemplate';
 
-       /**
-        *
-        */
        function setupSkinUserCss( OutputPage $out ){
                parent::setupSkinUserCss( $out );
                $out->AddModuleStyles( 'skins.standard' );
index 174969d..508e785 100644 (file)
@@ -61,7 +61,7 @@ class VectorTemplate extends BaseTemplate {
        /* Members */
 
        /**
-        * @var Cached skin object
+        * @var Skin Cached skin object
         */
        var $skin;
 
@@ -80,7 +80,7 @@ class VectorTemplate extends BaseTemplate {
                $nav = $this->data['content_navigation'];
                
                if ( $wgVectorUseIconWatch ) {
-                       $mode = $this->skin->mTitle->userIsWatching() ? 'unwatch' : 'watch';
+                       $mode = $this->skin->getTitle()->userIsWatching() ? 'unwatch' : 'watch';
                        if ( isset($nav['actions'][$mode]) ) {
                                $nav['views'][$mode] = $nav['actions'][$mode];
                                $nav['views'][$mode]['class'] = rtrim('icon ' . $nav['views'][$mode]['class'], ' ');
@@ -88,7 +88,8 @@ class VectorTemplate extends BaseTemplate {
                                unset($nav['actions'][$mode]);
                        }
                }
-               
+
+               $xmlID = '';
                foreach ( $nav as $section => $links ) {
                        foreach ( $links as $key => $link ) {
                                if ( $section == "views" && !(isset($link["primary"]) && $link["primary"]) ) {