Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix some @stable for ... annotations to use @stable to ...

Browse source 
Bug: T257789
Change-Id: I3ba94a9d6b739cd57cd57afe5d397963127160a8
This commit is contained in:
DannyS712 2021-07-08 02:51:13 +00:00
parent 95ea8d29a9
commit b0ab985420
10 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
includes/Rest/ResponseInterface.php
View file

@ -36,7 +36,7 @@ use Psr\Http\Message\StreamInterface;
* An interface similar to PSR-7's ResponseInterface, the primary difference
* being that it is mutable.
*
* @stable for implementing
* @stable to implement
*/
interface ResponseInterface {
// ResponseInterface

2
includes/actions/EditAction.php
View file

@ -23,7 +23,7 @@
*
* This is a wrapper that will call the EditPage class or a custom editor from an extension.
*
* @stable for subclasssing
* @stable to extend
* @ingroup Actions
*/
class EditAction extends FormlessAction {

2
includes/language/MessageLocalizer.php
View file

@ -21,7 +21,7 @@
/**
* Interface for localizing messages in MediaWiki
*
* @stable for implementing
* @stable to implement
*
* @since 1.30
* @ingroup Language

2
includes/linker/Hook/LinkerGenerateRollbackLinkHook.php
View file

@ -6,7 +6,7 @@ use IContextSource;
use MediaWiki\Revision\RevisionRecord;
/**
* @stable for implementation
* @stable to implement
* @ingroup Hooks
*/
interface LinkerGenerateRollbackLinkHook {

2
includes/rcfeed/RCFeedFormatter.php
View file

@ -22,7 +22,7 @@
/**
* Interface for RC feed formatters
*
* @stable for implementing
* @stable to implement
* @since 1.22
*/
interface RCFeedFormatter {

2
includes/skins/Hook/SkinPageReadyConfigHook.php
View file

@ -8,7 +8,7 @@ use ResourceLoaderContext;
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "SkinPageReadyConfig" to register handlers implementing this interface.
*
* @stable for implementation
* @stable to implement
*/
interface SkinPageReadyConfigHook {
/**

2
includes/skins/SkinMustache.php
View file

@ -31,7 +31,7 @@ class SkinMustache extends SkinTemplate {
/**
* @since 1.36
* @stable for overriding
* @stable to override
* @param string $name of the portal e.g. p-personal the name is personal.
* @param array $items that are accepted input to Skin::makeListItem
* @return array data that can be passed to a Mustache template that

28
maintenance/includes/Maintenance.php
View file

@ -51,7 +51,7 @@ use Wikimedia\Rdbms\IMaintainableDatabase;
* be careful with the constructor when subclassing. MediaWikiServices instance
* is not yet available at this point.
*
* @stable for subclassing
* @stable to extend
*
* @since 1.16
* @ingroup Maintenance
@ -175,7 +175,7 @@ abstract class Maintenance {
* Default constructor. Children should call this *first* if implementing
* their own constructors
*
* @stable for calling
* @stable to call
*/
public function __construct() {
$this->addDefaultParams();
@ -428,7 +428,7 @@ abstract class Maintenance {
/**
* Throw some output to the user. Scripts can call this with no fears,
* as we handle all --quiet stuff here
* @stable for overriding
* @stable to override
* @param string $out The text to show to the user
* @param mixed|null $channel Unique identifier for the channel. See function outputChanneled.
*/
@ -457,7 +457,7 @@ abstract class Maintenance {
/**
* Throw an error to the user. Doesn't respect --quiet, so don't use
* this for non-error output
* @stable for overriding
* @stable to override
* @param string $err The error to display
* @param int $die Deprecated since 1.31, use Maintenance::fatalError() instead
*/
@ -480,7 +480,7 @@ abstract class Maintenance {
/**
* Output a message and terminate the current script.
*
* @stable for overriding
* @stable to override
* @param string $msg Error message
* @param int $exitCode PHP exit status. Should be in range 1-254.
* @since 1.31
@ -542,7 +542,7 @@ abstract class Maintenance {
* Maintenance::DB_NONE - For no DB access at all
* Maintenance::DB_STD - For normal DB access, default
* Maintenance::DB_ADMIN - For admin DB access
* @stable for overriding
* @stable to override
* @return int
*/
public function getDbType() {
@ -591,7 +591,7 @@ abstract class Maintenance {
/**
* @since 1.24
* @stable for overriding
* @stable to override
* @return Config
*/
public function getConfig() {
@ -747,7 +747,7 @@ abstract class Maintenance {
* to allow sysadmins to explicitly set one if they'd prefer to override
* defaults (or for people using Suhosin which yells at you for trying
* to disable the limits)
* @stable for overriding
* @stable to override
* @return string
*/
public function memoryLimit() {
@ -950,7 +950,7 @@ abstract class Maintenance {
/**
* Run some validation checks on the params, etc
* @stable for overriding
* @stable to override
*/
public function validateParamsAndArgs() {
$die = false;
@ -983,7 +983,7 @@ abstract class Maintenance {
/**
* Handle the special variables that are global to all scripts
* @stable for overriding
* @stable to override
*/
protected function loadSpecialVars() {
if ( $this->hasOption( 'dbuser' ) ) {
@ -1123,7 +1123,7 @@ abstract class Maintenance {
/**
* Handle some last-minute setup here.
* @stable for overriding
* @stable to override
*/
public function finalSetup() {
global $wgCommandLineMode, $wgServer, $wgShowExceptionDetails, $wgShowHostnames;
@ -1209,7 +1209,7 @@ abstract class Maintenance {
/**
* Execute a callback function at the end of initialisation
* @stable for overriding
* @stable to override
*/
protected function afterFinalSetup() {
if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
@ -1351,7 +1351,7 @@ abstract class Maintenance {
*
* This function has the same parameters as LoadBalancer::getConnection().
*
* @stable for overriding
* @stable to override
*
* @param int $db DB index (DB_REPLICA/DB_PRIMARY)
* @param string|string[] $groups default: empty array
@ -1371,7 +1371,7 @@ abstract class Maintenance {
/**
* Sets database object to be returned by getDB().
* @stable for overriding
* @stable to override
*
* @param IMaintainableDatabase $db
*/

10
tests/phpunit/MediaWikiIntegrationTestCase.php
View file

@ -25,7 +25,7 @@ use Wikimedia\Rdbms\IMaintainableDatabase;
* Consider using MediaWikiUnitTestCase and mocking dependencies if your code uses dependency
* injection and does not access any globals.
*
* @stable for subclassing
* @stable to extend
*/
abstract class MediaWikiIntegrationTestCase extends PHPUnit\Framework\TestCase {
use MediaWikiCoversValidator;
@ -154,7 +154,7 @@ abstract class MediaWikiIntegrationTestCase extends PHPUnit\Framework\TestCase {
];
/**
* @stable for calling
* @stable to call
* @param string|null $name
* @param array $data
* @param string $dataName
@ -1360,7 +1360,7 @@ abstract class MediaWikiIntegrationTestCase extends PHPUnit\Framework\TestCase {
* @see resetDB()
*
* @since 1.27
* @stable for overriding
* @stable to override
*/
public function addDBDataOnce() {
}
@ -1373,7 +1373,7 @@ abstract class MediaWikiIntegrationTestCase extends PHPUnit\Framework\TestCase {
* @see resetDB()
*
* @since 1.18
* @stable for overriding
* @stable to override
*/
public function addDBData() {
}
@ -1639,7 +1639,7 @@ abstract class MediaWikiIntegrationTestCase extends PHPUnit\Framework\TestCase {
* by the 'scripts', even if the test is only interested in a subset of them, otherwise
* the overrides may not be fully cleaned up, leading to errors later.
*
* @stable for overriding
* @stable to override
* @param IMaintainableDatabase $db The DB connection to use for the mock schema.
* May be used to check the current state of the schema, to determine what
* overrides are needed.

2
tests/phpunit/MediaWikiUnitTestCase.php
View file

@ -30,7 +30,7 @@ use Wikimedia\ObjectFactory;
* Extend this class if you are testing classes which use dependency injection and do not access
* global functions, variables, services or a storage backend.
*
* @stable for subclassing
* @stable to extend
* @since 1.34
*/
abstract class MediaWikiUnitTestCase extends TestCase {