Improve some parameter docs

[lhc/web/wiklou.git] / includes / parser / ParserOutput.php

diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php
index 10ac192..2981748 100644 (file)
--- a/includes/parser/ParserOutput.php
+++ b/includes/parser/ParserOutput.php
@@ -211,10 +211,10 @@ class ParserOutput extends CacheTime {
         */
        private $mFlags = [];
 
-       /** @var integer|null Assumed rev ID for {{REVISIONID}} if no revision is set */
+       /** @var int|null Assumed rev ID for {{REVISIONID}} if no revision is set */
        private $mSpeculativeRevId;
 
-       /** @var integer Upper bound of expiry based on parse duration */
+       /** @var int Upper bound of expiry based on parse duration */
        private $mMaxAdaptiveExpiry = INF;
 
        const EDITSECTION_REGEX =
@@ -243,6 +243,7 @@ class ParserOutput extends CacheTime {
         * return value is suitable for writing back via setText() but is not valid
         * for display to the user.
         *
+        * @return string
         * @since 1.27
         */
        public function getRawText() {
@@ -253,7 +254,7 @@ class ParserOutput extends CacheTime {
                $text = $this->mText;
                if ( $this->mEditSectionTokens ) {
                        $text = preg_replace_callback(
-                               ParserOutput::EDITSECTION_REGEX,
+                               self::EDITSECTION_REGEX,
                                function ( $m ) {
                                        global $wgOut, $wgLang;
                                        $editsectionPage = Title::newFromText( htmlspecialchars_decode( $m[1] ) );
@@ -274,7 +275,7 @@ class ParserOutput extends CacheTime {
                                $text
                        );
                } else {
-                       $text = preg_replace( ParserOutput::EDITSECTION_REGEX, '', $text );
+                       $text = preg_replace( self::EDITSECTION_REGEX, '', $text );
                }
 
                // If you have an old cached version of this class - sorry, you can't disable the TOC
@@ -291,14 +292,17 @@ class ParserOutput extends CacheTime {
        }
 
        /**
-        * @param integer $id
+        * @param int $id
         * @since 1.28
         */
        public function setSpeculativeRevIdUsed( $id ) {
                $this->mSpeculativeRevId = $id;
        }
 
-       /** @since 1.28 */
+       /**
+        * @return int|null
+        * @since 1.28
+        */
        public function getSpeculativeRevIdUsed() {
                return $this->mSpeculativeRevId;
        }
@@ -320,6 +324,7 @@ class ParserOutput extends CacheTime {
        }
 
        /**
+        * @return array
         * @since 1.25
         */
        public function getIndicators() {
@@ -382,7 +387,10 @@ class ParserOutput extends CacheTime {
                return $this->mModuleStyles;
        }
 
-       /** @since 1.23 */
+       /**
+        * @return array
+        * @since 1.23
+        */
        public function getJsConfigVars() {
                return $this->mJsConfigVars;
        }
@@ -471,6 +479,8 @@ class ParserOutput extends CacheTime {
        }
 
        /**
+        * @param string $id
+        * @param string $content
         * @since 1.25
         */
        public function setIndicator( $id, $content ) {
@@ -836,6 +846,8 @@ class ParserOutput extends CacheTime {
         * @code
         *    $parser->getOutput()->my_ext_foo = '...';
         * @endcode
+        * @param string $name
+        * @param mixed $value
         */
        public function setProperty( $name, $value ) {
                $this->mProperties[$name] = $value;
@@ -1075,7 +1087,7 @@ class ParserOutput extends CacheTime {
        /**
         * Lower the runtime adaptive TTL to at most this value
         *
-        * @param integer $ttl
+        * @param int $ttl
         * @since 1.28
         */
        public function updateRuntimeAdaptiveExpiry( $ttl ) {