Merge "Fix typo"
[lhc/web/wiklou.git] / includes / parser / ParserOptions.php
index efd5f74..90617b3 100644 (file)
  * @ingroup Parser
  */
 class ParserOptions {
-       /** @var bool Parsing the page for a "preview" operation? */
-       public $mIsPreview = false;
 
-       /** @var bool Interlanguage links are removed and returned in an array */
-       protected $mInterwikiMagic;
+       /**
+        * Interlanguage links are removed and returned in an array
+        */
+       var $mInterwikiMagic;
 
-       /** @var bool Allow external images inline? */
-       protected $mAllowExternalImages;
+       /**
+        * Allow external images inline?
+        */
+       var $mAllowExternalImages;
 
-       /** @var string|array If not, any exception? */
-       protected $mAllowExternalImagesFrom;
+       /**
+        * If not, any exception?
+        */
+       var $mAllowExternalImagesFrom;
 
-       /** @var bool If not or it doesn't match, should we check an on-wiki whitelist? */
-       protected $mEnableImageWhitelist;
+       /**
+        * If not or it doesn't match, should we check an on-wiki whitelist?
+        */
+       var $mEnableImageWhitelist;
 
-       /** @var string Date format index */
-       protected $mDateFormat = null;
+       /**
+        * Date format index
+        */
+       var $mDateFormat = null;
 
-       /** @var bool Create "edit section" links? */
-       protected $mEditSection = true;
+       /**
+        * Create "edit section" links?
+        */
+       var $mEditSection = true;
 
-       /** @var bool Allow inclusion of special pages? */
-       protected $mAllowSpecialInclusion;
+       /**
+        * Allow inclusion of special pages?
+        */
+       var $mAllowSpecialInclusion;
 
-       /** @var bool Use tidy to cleanup output HTML? */
-       protected $mTidy = false;
+       /**
+        * Use tidy to cleanup output HTML?
+        */
+       var $mTidy = false;
 
        /**
-        * @var bool Which lang to call for PLURAL and GRAMMAR
-        * @todo FIXME: This comment doesn't appear to be correct.
-        *   Should be this? Whether this is an interface message.
+        * Which lang to call for PLURAL and GRAMMAR
         */
-       protected $mInterfaceMessage = false;
+       var $mInterfaceMessage = false;
 
-       /** @var string|Language Overrides $mInterfaceMessage with arbitrary language */
-       protected $mTargetLanguage = null;
+       /**
+        * Overrides $mInterfaceMessage with arbitrary language
+        */
+       var $mTargetLanguage = null;
 
-       /** @var int Maximum size of template expansions, in bytes */
-       protected $mMaxIncludeSize;
+       /**
+        * Maximum size of template expansions, in bytes
+        */
+       var $mMaxIncludeSize;
 
-       /** @var int Maximum number of nodes touched by PPFrame::expand() */
-       protected $mMaxPPNodeCount;
+       /**
+        * Maximum number of nodes touched by PPFrame::expand()
+        */
+       var $mMaxPPNodeCount;
 
-       /** @var int Maximum number of nodes generated by Preprocessor::preprocessToObj() */
-       protected $mMaxGeneratedPPNodeCount;
+       /**
+        * Maximum number of nodes generated by Preprocessor::preprocessToObj()
+        */
+       var $mMaxGeneratedPPNodeCount;
 
-       /** @var int Maximum recursion depth in PPFrame::expand() */
-       protected $mMaxPPExpandDepth;
+       /**
+        * Maximum recursion depth in PPFrame::expand()
+        */
+       var $mMaxPPExpandDepth;
 
-       /** @var int Maximum recursion depth for templates within templates */
-       protected $mMaxTemplateDepth;
+       /**
+        * Maximum recursion depth for templates within templates
+        */
+       var $mMaxTemplateDepth;
 
-       /** @var int Maximum number of calls per parse to expensive parser functions */
-       protected $mExpensiveParserFunctionLimit;
+       /**
+        * Maximum number of calls per parse to expensive parser functions
+        */
+       var $mExpensiveParserFunctionLimit;
 
-       /** @var bool Remove HTML comments. ONLY APPLIES TO PREPROCESS OPERATIONS */
-       protected $mRemoveComments = true;
+       /**
+        * Remove HTML comments. ONLY APPLIES TO PREPROCESS OPERATIONS
+        */
+       var $mRemoveComments = true;
 
-       /** @var array Callback for template fetching. Used as first argument to call_user_func(). */
-       protected $mTemplateCallback = array( 'Parser', 'statelessFetchTemplate' );
+       /**
+        * Callback for template fetching. Used as first argument to call_user_func().
+        */
+       var $mTemplateCallback =
+               array( 'Parser', 'statelessFetchTemplate' );
 
-       /** @var bool Enable limit report in an HTML comment on output */
-       protected $mEnableLimitReport = false;
+       /**
+        * Enable limit report in an HTML comment on output
+        */
+       var $mEnableLimitReport = false;
 
-       /** @var string Timestamp used for {{CURRENTDAY}} etc. */
-       protected $mTimestamp;
+       /**
+        * Timestamp used for {{CURRENTDAY}} etc.
+        */
+       var $mTimestamp;
 
-       /** @var bool|string Target attribute for external links */
-       protected $mExternalLinkTarget;
+       /**
+        * Target attribute for external links
+        */
+       var $mExternalLinkTarget;
 
        /**
-        * @var bool Clean up signature texts?
+        * Clean up signature texts?
         *
         * 1) Strip ~~~, ~~~~ and ~~~~~ out of signatures
         * 2) Substitute all transclusions
         */
-       protected $mCleanSignatures;
+       var $mCleanSignatures;
 
-       /** @var bool Transform wiki markup when saving the page? */
-       protected $mPreSaveTransform = true;
+       /**
+        * Transform wiki markup when saving the page?
+        */
+       var $mPreSaveTransform = true;
 
-       /** @var bool Whether content conversion should be disabled */
-       protected $mDisableContentConversion;
+       /**
+        * Whether content conversion should be disabled
+        */
+       var $mDisableContentConversion;
 
-       /** @var bool Whether title conversion should be disabled */
-       protected $mDisableTitleConversion;
+       /**
+        * Whether title conversion should be disabled
+        */
+       var $mDisableTitleConversion;
 
-       /** @var string Automatically number headings? */
-       protected $mNumberHeadings;
+       /**
+        * Automatically number headings?
+        */
+       var $mNumberHeadings;
 
-       /** @var string Thumb size preferred by the user. */
-       protected $mThumbSize;
+       /**
+        * Thumb size preferred by the user.
+        */
+       var $mThumbSize;
 
-       /** @var Language Language object of the User language. */
-       protected $mUserLang;
+       /**
+        * Maximum article size of an article to be marked as "stub"
+        */
+       private $mStubThreshold;
 
-       /** @var User Stored user object */
-       protected $mUser;
+       /**
+        * Language object of the User language.
+        */
+       var $mUserLang;
 
-       /** @var bool Parsing the page for a "preview" operation on a single section? */
-       protected $mIsSectionPreview = false;
+       /**
+        * @var User
+        * Stored user object
+        */
+       var $mUser;
 
-       /** @var bool Parsing the printable version of the page? */
-       protected $mIsPrintable = false;
+       /**
+        * Parsing the page for a "preview" operation?
+        */
+       var $mIsPreview = false;
 
-       /** @var string Extra key that should be present in the caching key. */
-       protected $mExtraKey = '';
+       /**
+        * Parsing the page for a "preview" operation on a single section?
+        */
+       var $mIsSectionPreview = false;
 
-       /** @var callable Function to be called when an option is accessed. */
-       protected $onAccessCallback = null;
+       /**
+        * Parsing the printable version of the page?
+        */
+       var $mIsPrintable = false;
 
-       /** @var int Maximum article size of an article to be marked as "stub" */
-       private $mStubThreshold;
+       /**
+        * Extra key that should be present in the caching key.
+        */
+       var $mExtraKey = '';
+
+       /**
+        * Function to be called when an option is accessed.
+        */
+       protected $onAccessCallback = null;
 
        function getInterwikiMagic() {
                return $this->mInterwikiMagic;
@@ -596,7 +663,7 @@ class ParserOptions {
         * Generate a hash string with the values set on these ParserOptions
         * for the keys given in the array.
         * This will be used as part of the hash key for the parser cache,
-        * so users sharign the options with vary for the same page share
+        * so users sharing the options with vary for the same page share
         * the same cached data safely.
         *
         * Extensions which require it should install 'PageRenderingHash' hook,