More bits of documentation
authorSam Reed <reedy@users.mediawiki.org>
Sun, 27 Feb 2011 15:23:41 +0000 (15:23 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Sun, 27 Feb 2011 15:23:41 +0000 (15:23 +0000)
includes/Title.php
includes/parser/Parser.php
includes/parser/ParserOptions.php

index d69610f..399eb49 100644 (file)
@@ -3704,6 +3704,9 @@ class Title {
        /**
         * Callback for usort() to do title sorts by (namespace, title)
         *
+        * @param $a Title
+        * @param $b Title
+        *
         * @return Integer: result of string comparison, or namespace comparison
         */
        public static function compare( $a, $b ) {
index b9341d2..5d1535d 100644 (file)
@@ -112,7 +112,6 @@ class Parser {
        var $mVariables, $mSubstWords; # Initialised by initialiseVariables()
        var $mConf, $mPreprocessor, $mExtLinkBracketedRegex, $mUrlProtocols; # Initialised in constructor
 
-
        # Cleared with clearState():
        var $mOutput, $mAutonumber, $mDTopen;
 
@@ -127,6 +126,10 @@ class Parser {
        var $mTplExpandCache; # empty-frame expansion cache
        var $mTplRedirCache, $mTplDomCache, $mHeadings, $mDoubleUnderscores;
        var $mExpensiveFunctionCount; # number of expensive parser function calls
+
+       /**
+        * @var User
+        */
        var $mUser; # User object; only used when doing pre-save transform
 
        # Temporary
@@ -136,6 +139,10 @@ class Parser {
         * @var ParserOptions
         */
        var $mOptions;
+
+       /**
+        * @var Title
+        */
        var $mTitle;        # Title context, used for self-link rendering and similar things
        var $mOutputType;   # Output type, one of the OT_xxx constants
        var $ot;            # Shortcut alias, see setOutputType()
index 7a6b877..39e9ec7 100644 (file)
@@ -91,6 +91,10 @@ class ParserOptions {
        function getUser()                          { return $this->mUser; }
        function getPreSaveTransform()              { return $this->mPreSaveTransform; }
 
+       /**
+        * @param $title Title
+        * @return Skin
+        */
        function getSkin( $title = null ) {
                if ( !isset( $this->mSkin ) ) {
                        $this->mSkin = $this->mUser->getSkin( $title );