Bartosz Dziewoński has uploaded a new change for review.
https://gerrit.wikimedia.org/r/126122
Change subject: Consistently use '@deprecated since <version>'
......................................................................
Consistently use '@deprecated since <version>'
Variants included 'in <version>', 'as of <version>' and just the
version number.
Some @deprecated annotations do not have the version number at all,
I want to hunt them down separately.
Change-Id: I8208c6097098f4735d4f51bc42254675f1f27f6d
---
M includes/Article.php
M includes/Collation.php
M includes/EditPage.php
M includes/Export.php
M includes/GlobalFunctions.php
M includes/OutputPage.php
M includes/Preferences.php
M includes/Revision.php
M includes/Skin.php
M includes/Title.php
M includes/User.php
M includes/WikiPage.php
M includes/actions/RawAction.php
M includes/changes/RecentChange.php
M includes/clientpool/RedisConnectionPool.php
M includes/db/DatabaseMysqlBase.php
M includes/db/LoadBalancer.php
M includes/filerepo/file/ArchivedFile.php
M includes/gallery/TraditionalImageGallery.php
M includes/jobqueue/jobs/RefreshLinksJob2.php
M includes/logging/LogEventsList.php
M includes/logging/LogPage.php
M includes/objectcache/BagOStuff.php
M includes/parser/ParserOptions.php
M includes/specialpage/SpecialPage.php
M includes/specials/SpecialUserrights.php
M languages/Language.php
27 files changed, 49 insertions(+), 49 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/22/126122/1
diff --git a/includes/Article.php b/includes/Article.php
index 1133724..5ebeb60 100644
--- a/includes/Article.php
+++ b/includes/Article.php
@@ -238,7 +238,7 @@
* This function has side effects! Do not use this function if you
* only want the real revision text if any.
*
- * @deprecated in 1.21; use WikiPage::getContent() instead
+ * @deprecated since 1.21; use WikiPage::getContent() instead
*
* @return string Return the text of this revision
*/
@@ -355,7 +355,7 @@
/**
* Load the revision (including text) into this object
*
- * @deprecated in 1.19; use fetchContent()
+ * @deprecated since 1.19; use fetchContent()
*/
function loadContent() {
wfDeprecated( __METHOD__, '1.19' );
@@ -374,7 +374,7 @@
* has to remain public for now.
*
* @return mixed string containing article contents, or false if null
- * @deprecated in 1.21, use WikiPage::getContent() instead
+ * @deprecated since 1.21, use WikiPage::getContent() instead
*/
function fetchContent() { #BC cruft!
ContentHandler::deprecated( __METHOD__, '1.21' );
diff --git a/includes/Collation.php b/includes/Collation.php
index 88e15b3..050ec63 100644
--- a/includes/Collation.php
+++ b/includes/Collation.php
@@ -514,7 +514,7 @@
* Do a binary search, and return the index of the largest item that
sorts
* less than or equal to the target value.
*
- * @deprecated in 1.23; use ArrayUtils::findLowerBound() instead
+ * @deprecated since 1.23; use ArrayUtils::findLowerBound() instead
*
* @param array $valueCallback A function to call to get the value with
* a given array index.
diff --git a/includes/EditPage.php b/includes/EditPage.php
index d0bd7c7..c266996 100644
--- a/includes/EditPage.php
+++ b/includes/EditPage.php
@@ -545,7 +545,7 @@
* Show a read-only error
* Parameters are the same as OutputPage:readOnlyPage()
* Redirect to the article page if redlink=1
- * @deprecated in 1.19; use displayPermissionsError() instead
+ * @deprecated since 1.19; use displayPermissionsError() instead
*/
function readOnlyPage( $source = null, $protected = false, $reasons =
array(), $action = null ) {
wfDeprecated( __METHOD__, '1.19' );
@@ -3623,7 +3623,7 @@
/**
* Call the stock "user is blocked" page
*
- * @deprecated in 1.19; throw an exception directly instead
+ * @deprecated since 1.19; throw an exception directly instead
*/
function blockedPage() {
wfDeprecated( __METHOD__, '1.19' );
@@ -3635,7 +3635,7 @@
/**
* Produce the stock "please login to edit pages" page
*
- * @deprecated in 1.19; throw an exception directly instead
+ * @deprecated since 1.19; throw an exception directly instead
*/
function userNotLoggedInPage() {
wfDeprecated( __METHOD__, '1.19' );
@@ -3646,7 +3646,7 @@
* Show an error page saying to the user that he has insufficient
permissions
* to create a new page
*
- * @deprecated in 1.19; throw an exception directly instead
+ * @deprecated since 1.19; throw an exception directly instead
*/
function noCreatePermission() {
wfDeprecated( __METHOD__, '1.19' );
diff --git a/includes/Export.php b/includes/Export.php
index 2844a06..0ebdb78 100644
--- a/includes/Export.php
+++ b/includes/Export.php
@@ -477,7 +477,7 @@
class XmlDumpWriter {
/**
* Returns the export schema version.
- * @deprecated in 1.20; use WikiExporter::schemaVersion() instead
+ * @deprecated since 1.20; use WikiExporter::schemaVersion() instead
* @return string
*/
function schemaVersion() {
diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index c900306..b132826 100644
--- a/includes/GlobalFunctions.php
+++ b/includes/GlobalFunctions.php
@@ -2000,7 +2000,7 @@
* @param string $query optional URL query parameter string
* @param bool $atend optional param for specified if this is the last page
* @return string
- * @deprecated in 1.19; use Language::viewPrevNext() instead
+ * @deprecated since 1.19; use Language::viewPrevNext() instead
*/
function wfViewPrevNext( $offset, $limit, $link, $query = '', $atend = false )
{
wfDeprecated( __METHOD__, '1.19' );
@@ -4138,7 +4138,7 @@
* Work out the IP address based on various globals
* For trusted proxies, use the XFF client IP (first of the chain)
*
- * @deprecated in 1.19; call $wgRequest->getIP() directly.
+ * @deprecated since 1.19; call $wgRequest->getIP() directly.
* @return string
*/
function wfGetIP() {
diff --git a/includes/OutputPage.php b/includes/OutputPage.php
index 052ab34..f5dbfc6 100644
--- a/includes/OutputPage.php
+++ b/includes/OutputPage.php
@@ -930,7 +930,7 @@
/**
* Add $str to the subtitle
*
- * @deprecated in 1.19; use addSubtitle() instead
+ * @deprecated since 1.19; use addSubtitle() instead
* @param string|Message $str to add to the subtitle
*/
public function appendSubtitle( $str ) {
@@ -2265,7 +2265,7 @@
/**
* Produce the stock "please login to use the wiki" page
*
- * @deprecated in 1.19; throw the exception directly
+ * @deprecated since 1.19; throw the exception directly
*/
public function loginToUse() {
throw new PermissionsError( 'read' );
diff --git a/includes/Preferences.php b/includes/Preferences.php
index 1825cce..6075623 100644
--- a/includes/Preferences.php
+++ b/includes/Preferences.php
@@ -1475,7 +1475,7 @@
* Caller is responsible for checking $wgAuth and 'editmyprivateinfo'
* right.
*
- * @deprecated in 1.20; use User::setEmailWithConfirmation() instead.
+ * @deprecated since 1.20; use User::setEmailWithConfirmation() instead.
* @param $user User
* @param string $newaddr New email address
* @return Array (true on success or Status on failure, info string)
@@ -1492,7 +1492,7 @@
}
/**
- * @deprecated in 1.19
+ * @deprecated since 1.19
* @param $user User
* @return array
*/
diff --git a/includes/Revision.php b/includes/Revision.php
index 1ad0b4a..797980f 100644
--- a/includes/Revision.php
+++ b/includes/Revision.php
@@ -975,7 +975,7 @@
* @param $user User object to check for, only if FOR_THIS_USER is
passed
* to the $audience parameter
*
- * @deprecated in 1.21, use getContent() instead
+ * @deprecated since 1.21, use getContent() instead
* @todo Replace usage in core
* @return String
*/
diff --git a/includes/Skin.php b/includes/Skin.php
index e6abdfb..8762565 100644
--- a/includes/Skin.php
+++ b/includes/Skin.php
@@ -397,7 +397,7 @@
/**
* Make a "<script>" tag containing global variables
*
- * @deprecated in 1.19
+ * @deprecated since 1.19
* @param $unused
* @return string HTML fragment
*/
diff --git a/includes/Title.php b/includes/Title.php
index 31e5868..99e0091 100644
--- a/includes/Title.php
+++ b/includes/Title.php
@@ -1837,7 +1837,7 @@
/**
* Is $wgUser watching this page?
*
- * @deprecated in 1.20; use User::isWatched() instead.
+ * @deprecated since 1.20; use User::isWatched() instead.
* @return Bool
*/
public function userIsWatching() {
@@ -1856,7 +1856,7 @@
/**
* Can $wgUser read this page?
*
- * @deprecated in 1.19; use userCan(), quickUserCan() or
getUserPermissionsErrors() instead
+ * @deprecated since 1.19; use userCan(), quickUserCan() or
getUserPermissionsErrors() instead
* @return Bool
*/
public function userCanRead() {
@@ -2521,7 +2521,7 @@
/**
* Update the title protection status
*
- * @deprecated in 1.19; use WikiPage::doUpdateRestrictions() instead.
+ * @deprecated since 1.19; use WikiPage::doUpdateRestrictions() instead.
* @param $create_perm String Permission required for creation
* @param string $reason Reason for protection
* @param string $expiry Expiry timestamp
diff --git a/includes/User.php b/includes/User.php
index 1ccb732..c5f63cc 100644
--- a/includes/User.php
+++ b/includes/User.php
@@ -3258,7 +3258,7 @@
* Set this user's options from an encoded string
* @param string $str Encoded options to import
*
- * @deprecated in 1.19 due to removal of user_options from the user
table
+ * @deprecated since 1.19 due to removal of user_options from the user
table
*/
private function decodeOptions( $str ) {
wfDeprecated( __METHOD__, '1.19' );
diff --git a/includes/WikiPage.php b/includes/WikiPage.php
index a5d66df..0dec766 100644
--- a/includes/WikiPage.php
+++ b/includes/WikiPage.php
@@ -687,7 +687,7 @@
* @param $user User object to check for, only if FOR_THIS_USER is
passed
* to the $audience parameter
* @return String|false The text of the current revision
- * @deprecated as of 1.21, getContent() should be used instead.
+ * @deprecated since 1.21, getContent() should be used instead.
*/
public function getText( $audience = Revision::FOR_PUBLIC, User $user =
null ) { // @todo deprecated, replace usage!
ContentHandler::deprecated( __METHOD__, '1.21' );
@@ -703,7 +703,7 @@
* Get the text of the current revision. No side-effects...
*
* @return String|bool The text of the current revision. False on
failure
- * @deprecated as of 1.21, getContent() should be used instead.
+ * @deprecated since 1.21, getContent() should be used instead.
*/
public function getRawText() {
ContentHandler::deprecated( __METHOD__, '1.21' );
@@ -2033,7 +2033,7 @@
* Prepare text which is about to be saved.
* Returns a stdclass with source, pst and output members
*
- * @deprecated in 1.21: use prepareContentForEdit instead.
+ * @deprecated since 1.21: use prepareContentForEdit instead.
*/
public function prepareTextForEdit( $text, $revid = null, User $user =
null ) {
ContentHandler::deprecated( __METHOD__, '1.21' );
@@ -3380,7 +3380,7 @@
* Return a list of templates used by this article.
* Uses the templatelinks table
*
- * @deprecated in 1.19; use Title::getTemplateLinksFrom()
+ * @deprecated since 1.19; use Title::getTemplateLinksFrom()
* @return Array of Title objects
*/
public function getUsedTemplates() {
@@ -3391,7 +3391,7 @@
* This function is called right before saving the wikitext,
* so we can do things like signatures and links-in-context.
*
- * @deprecated in 1.19; use Parser::preSaveTransform() instead
+ * @deprecated since 1.19; use Parser::preSaveTransform() instead
* @param string $text article contents
* @param $user User object: user doing the edit
* @param $popts ParserOptions object: parser options, default options
for
@@ -3416,7 +3416,7 @@
/**
* Check whether the number of revisions of this page surpasses
$wgDeleteRevisionsLimit
*
- * @deprecated in 1.19; use Title::isBigDeletion() instead.
+ * @deprecated since 1.19; use Title::isBigDeletion() instead.
* @return bool
*/
public function isBigDeletion() {
@@ -3427,7 +3427,7 @@
/**
* Get the approximate revision count of this page.
*
- * @deprecated in 1.19; use Title::estimateRevisionCount() instead.
+ * @deprecated since 1.19; use Title::estimateRevisionCount() instead.
* @return int
*/
public function estimateRevisionCount() {
diff --git a/includes/actions/RawAction.php b/includes/actions/RawAction.php
index 1b72662..a212915 100644
--- a/includes/actions/RawAction.php
+++ b/includes/actions/RawAction.php
@@ -256,7 +256,7 @@
/**
* Backward compatibility for extensions
*
- * @deprecated in 1.19
+ * @deprecated since 1.19
*/
class RawPage extends RawAction {
public $mOldId;
diff --git a/includes/changes/RecentChange.php
b/includes/changes/RecentChange.php
index 4827047..bbf4ab6 100644
--- a/includes/changes/RecentChange.php
+++ b/includes/changes/RecentChange.php
@@ -104,7 +104,7 @@
/**
* No uses left in Gerrit on 2013-11-19.
- * @deprecated in 1.22
+ * @deprecated since 1.22
* @param mixed $row
* @return RecentChange
*/
@@ -734,7 +734,7 @@
/**
* Makes a pseudo-RC entry from a cur row
*
- * @deprecated in 1.22
+ * @deprecated since 1.22
* @param mixed $row
*/
public function loadFromCurRow( $row ) {
diff --git a/includes/clientpool/RedisConnectionPool.php
b/includes/clientpool/RedisConnectionPool.php
index c21b113..15f0a47 100644
--- a/includes/clientpool/RedisConnectionPool.php
+++ b/includes/clientpool/RedisConnectionPool.php
@@ -277,7 +277,7 @@
* @param string $server
* @param RedisConnRef $cref
* @param RedisException $e
- * @deprecated 1.23
+ * @deprecated since 1.23
*/
public function handleException( $server, RedisConnRef $cref,
RedisException $e ) {
return $this->handleError( $cref, $e );
diff --git a/includes/db/DatabaseMysqlBase.php
b/includes/db/DatabaseMysqlBase.php
index 3b70ae1..d437c4c 100644
--- a/includes/db/DatabaseMysqlBase.php
+++ b/includes/db/DatabaseMysqlBase.php
@@ -638,7 +638,7 @@
}
/**
- * @deprecated in 1.19, use getLagFromSlaveStatus
+ * @deprecated since 1.19, use getLagFromSlaveStatus
*
* @return bool|int
*/
diff --git a/includes/db/LoadBalancer.php b/includes/db/LoadBalancer.php
index 8aa8061..aab0486 100644
--- a/includes/db/LoadBalancer.php
+++ b/includes/db/LoadBalancer.php
@@ -881,7 +881,7 @@
/**
* Deprecated function, typo in function name
*
- * @deprecated in 1.18
+ * @deprecated since 1.18
* @param DatabaseBase $conn
*/
function closeConnecton( $conn ) {
diff --git a/includes/filerepo/file/ArchivedFile.php
b/includes/filerepo/file/ArchivedFile.php
index 439c25f..845fd71 100644
--- a/includes/filerepo/file/ArchivedFile.php
+++ b/includes/filerepo/file/ArchivedFile.php
@@ -475,7 +475,7 @@
/**
* Return the user name of the uploader.
*
- * @deprecated 1.23 Use getUser( 'text' ) instead.
+ * @deprecated since 1.23 Use getUser( 'text' ) instead.
* @return string
*/
public function getUserText() {
diff --git a/includes/gallery/TraditionalImageGallery.php
b/includes/gallery/TraditionalImageGallery.php
index cfedac7..37f2221 100644
--- a/includes/gallery/TraditionalImageGallery.php
+++ b/includes/gallery/TraditionalImageGallery.php
@@ -328,7 +328,7 @@
* if called the old way, for extensions that may expect traditional
* mode.
*
- * @deprecated 1.22 Use ImageGalleryBase::factory instead.
+ * @deprecated since 1.22 Use ImageGalleryBase::factory instead.
*/
class ImageGallery extends TraditionalImageGallery {
function __construct( $mode = 'traditional' ) {
diff --git a/includes/jobqueue/jobs/RefreshLinksJob2.php
b/includes/jobqueue/jobs/RefreshLinksJob2.php
index 77e3b3f..1a27e1f 100644
--- a/includes/jobqueue/jobs/RefreshLinksJob2.php
+++ b/includes/jobqueue/jobs/RefreshLinksJob2.php
@@ -26,7 +26,7 @@
* Newer version for high use templates. This is deprecated by
RefreshLinksPartitionJob.
*
* @ingroup JobQueue
- * @deprecated 1.23
+ * @deprecated since 1.23
*/
class RefreshLinksJob2 extends Job {
function __construct( $title, $params ) {
diff --git a/includes/logging/LogEventsList.php
b/includes/logging/LogEventsList.php
index ad8710c..cce902f 100644
--- a/includes/logging/LogEventsList.php
+++ b/includes/logging/LogEventsList.php
@@ -60,7 +60,7 @@
/**
* Deprecated alias for getTitle(); do not use.
*
- * @deprecated in 1.20; use getTitle() instead.
+ * @deprecated since 1.20; use getTitle() instead.
* @return Title
*/
public function getDisplayTitle() {
@@ -71,7 +71,7 @@
/**
* Set page title and show header for this log type
* @param array $type
- * @deprecated in 1.19
+ * @deprecated since 1.19
*/
public function showHeader( $type ) {
wfDeprecated( __METHOD__, '1.19' );
diff --git a/includes/logging/LogPage.php b/includes/logging/LogPage.php
index 2ec4f69..1b7e677 100644
--- a/includes/logging/LogPage.php
+++ b/includes/logging/LogPage.php
@@ -215,7 +215,7 @@
*
* @param string $type Log type
* @return string Log name
- * @deprecated in 1.19, warnings in 1.21. Use getName()
+ * @deprecated since 1.19, warnings in 1.21. Use getName()
*/
public static function logName( $type ) {
global $wgLogNames;
@@ -236,7 +236,7 @@
* @todo handle missing log types
* @param string $type logtype
* @return string Header text of this logtype
- * @deprecated in 1.19, warnings in 1.21. Use getDescription()
+ * @deprecated since 1.19, warnings in 1.21. Use getDescription()
*/
public static function logHeader( $type ) {
global $wgLogHeaders;
diff --git a/includes/objectcache/BagOStuff.php
b/includes/objectcache/BagOStuff.php
index ad3aa96..1b3e4bc 100644
--- a/includes/objectcache/BagOStuff.php
+++ b/includes/objectcache/BagOStuff.php
@@ -265,7 +265,7 @@
* @param $value mixed
* @param $exptime int
* @return bool success
- * @deprecated 1.23
+ * @deprecated since 1.23
*/
public function replace( $key, $value, $exptime = 0 ) {
wfDeprecated( __METHOD__, '1.23' );
diff --git a/includes/parser/ParserOptions.php
b/includes/parser/ParserOptions.php
index edd4911..21403b4 100644
--- a/includes/parser/ParserOptions.php
+++ b/includes/parser/ParserOptions.php
@@ -303,7 +303,7 @@
function setAllowSpecialInclusion( $x ) { return wfSetVar(
$this->mAllowSpecialInclusion, $x ); }
function setTidy( $x ) { return wfSetVar(
$this->mTidy, $x ); }
- /** @deprecated in 1.19 */
+ /** @deprecated since 1.19 */
function setSkin( $x ) { wfDeprecated( __METHOD__,
'1.19' ); }
function setInterfaceMessage( $x ) { return wfSetVar(
$this->mInterfaceMessage, $x ); }
function setTargetLanguage( $x ) { return wfSetVar(
$this->mTargetLanguage, $x, true ); }
diff --git a/includes/specialpage/SpecialPage.php
b/includes/specialpage/SpecialPage.php
index f7fcc7a..82d6177 100644
--- a/includes/specialpage/SpecialPage.php
+++ b/includes/specialpage/SpecialPage.php
@@ -473,7 +473,7 @@
*
* @param string|bool $subpage
* @return Title
- * @deprecated in 1.23, use SpecialPage::getPageTitle
+ * @deprecated since 1.23, use SpecialPage::getPageTitle
*/
function getTitle( $subpage = false ) {
return $this->getPageTitle( $subpage );
diff --git a/includes/specials/SpecialUserrights.php
b/includes/specials/SpecialUserrights.php
index 08edf73..29266ca 100644
--- a/includes/specials/SpecialUserrights.php
+++ b/includes/specials/SpecialUserrights.php
@@ -395,7 +395,7 @@
/**
* Make a list of group names to be stored as parameter for log entries
*
- * @deprecated in 1.21; use LogFormatter instead.
+ * @deprecated since 1.21; use LogFormatter instead.
* @param $ids array
* @return string
*/
diff --git a/languages/Language.php b/languages/Language.php
index 1ad2b7a..5ef781d 100644
--- a/languages/Language.php
+++ b/languages/Language.php
@@ -480,7 +480,7 @@
/**
* Same as getFallbacksFor for current language.
* @return array|bool
- * @deprecated in 1.19
+ * @deprecated since 1.19
*/
function getFallbackLanguageCode() {
wfDeprecated( __METHOD__, '1.19' );
@@ -844,7 +844,7 @@
* @param $customisedOnly bool
*
* @return array
- * @deprecated in 1.20, use fetchLanguageNames()
+ * @deprecated since 1.20, use fetchLanguageNames()
*/
public static function getLanguageNames( $customisedOnly = false ) {
return self::fetchLanguageNames( null, $customisedOnly ?
'mwfile' : 'mw' );
@@ -857,7 +857,7 @@
* @param $code String Language code.
* @return Array language code => language name
* @since 1.18.0
- * @deprecated in 1.20, use fetchLanguageNames()
+ * @deprecated since 1.20, use fetchLanguageNames()
*/
public static function getTranslatedLanguageNames( $code ) {
return self::fetchLanguageNames( $code, 'all' );
@@ -956,7 +956,7 @@
* Only if defined in MediaWiki, no other data like CLDR.
* @param $code string
* @return string
- * @deprecated in 1.20, use fetchLanguageName()
+ * @deprecated since 1.20, use fetchLanguageName()
*/
function getLanguageName( $code ) {
return self::fetchLanguageName( $code );
--
To view, visit https://gerrit.wikimedia.org/r/126122
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I8208c6097098f4735d4f51bc42254675f1f27f6d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Bartosz Dziewoński <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits