From: Brion Vibber <brion@users.mediawiki.org>
Date: Tue, 13 Dec 2011 20:20:03 +0000 (+0000)
Subject: Followup r106070, r86347: copy some doc comments that apply to multiple functions... 
X-Git-Tag: 1.31.0-rc.0~25992
X-Git-Url: http://git.cyclocoop.org/%24self?a=commitdiff_plain;h=493a76d4534c70ab0a47c65781c33b21d15f07fd;p=lhc%2Fweb%2Fwiklou.git

Followup r106070, r86347: copy some doc comments that apply to multiple functions so doxygen will pick them up
---

diff --git a/includes/SpecialPage.php b/includes/SpecialPage.php
index 853defe4f9..97b0c6de30 100644
--- a/includes/SpecialPage.php
+++ b/includes/SpecialPage.php
@@ -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 ); }
 
 	/**