diff options
author | daniel <dkinzler@wikimedia.org> | 2020-07-13 11:20:52 +0200 |
---|---|---|
committer | Jforrester <jforrester@wikimedia.org> | 2020-07-13 09:40:54 +0000 |
commit | 48eb174759c76852cb412ae22ca7a17e218cb95a (patch) | |
tree | 9b31ce9a7f59889c387273531da1911e5303ac2d | |
parent | 5fb9e95b22c92acbd1614e5bb901f4fd74c48b3c (diff) | |
download | mediawikicore-48eb174759c76852cb412ae22ca7a17e218cb95a.tar.gz mediawikicore-48eb174759c76852cb412ae22ca7a17e218cb95a.zip |
Update stability annotations to follow new stable interface policy
This is a follow-up to I1939bb11038ec2.
Bug: T247862
Change-Id: I69a1ec1700bfb68a36003d65cc2184f23f208794
-rw-r--r-- | includes/changes/ChannelFeed.php | 6 | ||||
-rw-r--r-- | includes/collation/Collation.php | 2 | ||||
-rw-r--r-- | includes/gallery/ImageGalleryBase.php | 9 | ||||
-rw-r--r-- | includes/jobqueue/JobQueue.php | 32 | ||||
-rw-r--r-- | includes/user/CentralIdLookup.php | 6 |
5 files changed, 31 insertions, 24 deletions
diff --git a/includes/changes/ChannelFeed.php b/includes/changes/ChannelFeed.php index 10fd90dda3bb..4c15c7f2e18f 100644 --- a/includes/changes/ChannelFeed.php +++ b/includes/changes/ChannelFeed.php @@ -24,7 +24,7 @@ /** * Class to support the outputting of syndication feeds in Atom and RSS format. * - * @stable for subclassing + * @stable to extend * @ingroup Feed */ abstract class ChannelFeed extends FeedItem { @@ -33,7 +33,7 @@ abstract class ChannelFeed extends FeedItem { protected $templateParser; /** - * @stable for calling + * @stable to call * * @param string|Title $title Feed's title * @param string $description @@ -108,6 +108,8 @@ abstract class ChannelFeed extends FeedItem { /** * Return an internet media type to be sent in the headers. * + * @stable to override + * * @return string */ private function contentType() { diff --git a/includes/collation/Collation.php b/includes/collation/Collation.php index cc4817b6dee5..17dd282da9c7 100644 --- a/includes/collation/Collation.php +++ b/includes/collation/Collation.php @@ -25,7 +25,7 @@ use MediaWiki\MediaWikiServices; /** * @since 1.16.3 * @author Tim Starling - * @stable for subclassing + * @stable to extend */ abstract class Collation { private static $instance; diff --git a/includes/gallery/ImageGalleryBase.php b/includes/gallery/ImageGalleryBase.php index 9aae713ef7d1..401dd5088736 100644 --- a/includes/gallery/ImageGalleryBase.php +++ b/includes/gallery/ImageGalleryBase.php @@ -26,7 +26,7 @@ use MediaWiki\MediaWikiServices; * Image gallery * * Add images to the gallery using add(), then render that list to HTML using toHTML(). - * @stable for subclassing + * @stable to extend * @ingroup Media */ abstract class ImageGalleryBase extends ContextSource { @@ -153,6 +153,11 @@ abstract class ImageGalleryBase extends ContextSource { * * You should not call this directly, but instead use * ImageGalleryBase::factory(). + * + * @stable to call + * @note constructors of subclasses must have a compatible signature + * for use by the factory() method. + * * @param string $mode * @param IContextSource|null $context */ @@ -258,7 +263,7 @@ abstract class ImageGalleryBase extends ContextSource { * to allow extensions to add additional parameters to * <gallery> parser tag. * - * @stable for overriding + * @stable to override * * @param array $options Attributes of gallery tag */ diff --git a/includes/jobqueue/JobQueue.php b/includes/jobqueue/JobQueue.php index 449f63e27ad4..3b69805755a8 100644 --- a/includes/jobqueue/JobQueue.php +++ b/includes/jobqueue/JobQueue.php @@ -30,7 +30,7 @@ use Wikimedia\UUID\GlobalIdGenerator; * * @ingroup JobQueue * @since 1.21 - * @stable for subclassing + * @stable to extend */ abstract class JobQueue { /** @var string DB domain ID */ @@ -58,7 +58,7 @@ abstract class JobQueue { protected const ROOTJOB_TTL = 2419200; // integer; seconds to remember root jobs (28 days) /** - * @stable for calling + * @stable to call * * @param array $params * - type : A job type @@ -191,7 +191,7 @@ abstract class JobQueue { /** * Find out if delayed jobs are supported for configuration validation * - * @stable for overriding + * @stable to override * @return bool Whether delayed jobs are supported */ protected function supportsDelayedJobs() { @@ -297,7 +297,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::getDelayedCount() * @return int */ @@ -321,7 +321,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::getAbandonedCount() * @return int */ @@ -485,7 +485,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::deduplicateRootJob() * @param IJobSpecification $job * @throws JobQueueError @@ -527,7 +527,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::isRootJobOldDuplicate() * @param IJobSpecification $job * @return bool @@ -578,7 +578,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::delete() * @throws JobQueueError */ @@ -599,7 +599,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::waitForBackups() * @return void */ @@ -616,7 +616,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::flushCaches() * @return void */ @@ -637,7 +637,7 @@ abstract class JobQueue { * Get an iterator to traverse over all delayed jobs in this queue. * Note: results may be stale if the queue is concurrently modified. * - * @stable for overriding + * @stable to override * @return Iterator * @throws JobQueueError * @since 1.22 @@ -652,7 +652,7 @@ abstract class JobQueue { * Callers should be quick to iterator over it or few results * will be returned due to jobs being acknowledged and deleted * - * @stable for overriding + * @stable to override * @return Iterator * @throws JobQueueError * @since 1.26 @@ -664,7 +664,7 @@ abstract class JobQueue { /** * Get an iterator to traverse over all abandoned jobs in this queue * - * @stable for overriding + * @stable to override * @return Iterator * @throws JobQueueError * @since 1.25 @@ -676,7 +676,7 @@ abstract class JobQueue { /** * Do not use this function outside of JobQueue/JobQueueGroup * - * @stable for overriding + * @stable to override * @return string * @since 1.22 */ @@ -698,7 +698,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::getSiblingQueuesWithJobs() * @param array $types List of queues types * @return array|null (list of queue types) or null if unsupported @@ -722,7 +722,7 @@ abstract class JobQueue { } /** - * @stable for overriding + * @stable to override * @see JobQueue::getSiblingQueuesSize() * @param array $types List of queues types * @return array|null (list of queue types) or null if unsupported diff --git a/includes/user/CentralIdLookup.php b/includes/user/CentralIdLookup.php index 711e2dc41327..c723f99e494d 100644 --- a/includes/user/CentralIdLookup.php +++ b/includes/user/CentralIdLookup.php @@ -26,7 +26,7 @@ use Wikimedia\ObjectFactory; * cluster-wide IDs. * * @since 1.27 - * @stable for subclassing + * @stable to extend */ abstract class CentralIdLookup implements IDBAccessObject { // Audience options for accessors @@ -223,7 +223,7 @@ abstract class CentralIdLookup implements IDBAccessObject { * Given a central user ID, return a local User object * @note Unlike nameFromCentralId(), this does guarantee that the local * user exists and is attached to the central account. - * @stable for overriding + * @stable to override * @param int $id Central user ID * @param int|User $audience One of the audience constants, or a specific user * @param int $flags IDBAccessObject read flags @@ -246,7 +246,7 @@ abstract class CentralIdLookup implements IDBAccessObject { /** * Given a local User object, return the central ID - * @stable for overriding + * @stable to override * @note Unlike centralIdFromName(), this does guarantee that the local * user is attached to the central account. * @param User $user Local user |