Followup r106070, r86347: copy some doc comments that apply to multiple functions...
authorBrion Vibber <brion@users.mediawiki.org>
Tue, 13 Dec 2011 20:20:03 +0000 (20:20 +0000)
committerBrion Vibber <brion@users.mediawiki.org>
Tue, 13 Dec 2011 20:20:03 +0000 (20:20 +0000)
includes/SpecialPage.php

index 853defe..97b0c6d 100644 (file)
@@ -458,9 +458,41 @@ class SpecialPage {
         * @deprecated since 1.18
         */
        function name( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mName, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
        function restriction( $x = null) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mRestriction, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
        function func( $x = null) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFunction, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
        function file( $x = null) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFile, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
        function includable( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mIncludable, $x ); }
 
        /**