From bf61a7743194c6b3add03fa4f0413d5cc21e40b8 Mon Sep 17 00:00:00 2001 From: Umherirrender Date: Fri, 11 Aug 2017 16:49:52 +0200 Subject: [PATCH] Change @inheritdoc to @inheritDoc Only @inheritDoc works for the Sniff MediaWiki.Commenting.FunctionComment Change-Id: I91fc02cda6701d790e4334fc2bc47f230955545c --- includes/api/ApiUsageException.php | 6 +++--- includes/auth/AbstractAuthenticationProvider.php | 2 +- includes/auth/AbstractPrimaryAuthenticationProvider.php | 4 ++-- includes/auth/AbstractSecondaryAuthenticationProvider.php | 2 +- includes/auth/PrimaryAuthenticationProvider.php | 2 +- includes/changes/ChangesListBooleanFilter.php | 8 ++++---- includes/changes/ChangesListBooleanFilterGroup.php | 4 ++-- includes/changes/ChangesListStringOptionsFilter.php | 4 ++-- includes/changes/ChangesListStringOptionsFilterGroup.php | 6 +++--- includes/debug/logger/monolog/BufferHandler.php | 2 +- includes/debug/logger/monolog/KafkaHandler.php | 4 ++-- includes/debug/logger/monolog/LineFormatter.php | 2 +- includes/diff/WordLevelDiff.php | 2 +- includes/libs/rdbms/exception/DBExpectedError.php | 2 +- includes/libs/stats/SamplingStatsdClient.php | 4 ++-- includes/media/Jpeg.php | 2 +- .../resourceloader/ResourceLoaderMediaWikiUtilModule.php | 6 +++--- includes/search/NullIndexField.php | 2 +- includes/search/SearchIndexFieldDefinition.php | 2 +- includes/specials/SpecialRecentchanges.php | 8 ++++---- includes/specials/SpecialRecentchangeslinked.php | 2 +- includes/specials/SpecialWatchlist.php | 8 ++++---- includes/upload/UploadFromChunks.php | 8 ++++---- 23 files changed, 46 insertions(+), 46 deletions(-) diff --git a/includes/api/ApiUsageException.php b/includes/api/ApiUsageException.php index fb49e2dbe2..17655ec1c3 100644 --- a/includes/api/ApiUsageException.php +++ b/includes/api/ApiUsageException.php @@ -186,7 +186,7 @@ class ApiUsageException extends UsageException implements ILocalizedException { /** * @deprecated Do not use. This only exists here because UsageException is in * the inheritance chain for backwards compatibility. - * @inheritdoc + * @inheritDoc */ public function getCodeString() { wfDeprecated( __METHOD__, '1.29' ); @@ -196,7 +196,7 @@ class ApiUsageException extends UsageException implements ILocalizedException { /** * @deprecated Do not use. This only exists here because UsageException is in * the inheritance chain for backwards compatibility. - * @inheritdoc + * @inheritDoc */ public function getMessageArray() { wfDeprecated( __METHOD__, '1.29' ); @@ -210,7 +210,7 @@ class ApiUsageException extends UsageException implements ILocalizedException { } /** - * @inheritdoc + * @inheritDoc */ public function getMessageObject() { return $this->status->getMessage(); diff --git a/includes/auth/AbstractAuthenticationProvider.php b/includes/auth/AbstractAuthenticationProvider.php index 9e38eccb3f..58cec118c8 100644 --- a/includes/auth/AbstractAuthenticationProvider.php +++ b/includes/auth/AbstractAuthenticationProvider.php @@ -50,7 +50,7 @@ abstract class AbstractAuthenticationProvider implements AuthenticationProvider } /** - * @inheritdoc + * @inheritDoc * @note Override this if it makes sense to support more than one instance */ public function getUniqueId() { diff --git a/includes/auth/AbstractPrimaryAuthenticationProvider.php b/includes/auth/AbstractPrimaryAuthenticationProvider.php index ea3dfa3bd6..ca947b61a8 100644 --- a/includes/auth/AbstractPrimaryAuthenticationProvider.php +++ b/includes/auth/AbstractPrimaryAuthenticationProvider.php @@ -46,7 +46,7 @@ abstract class AbstractPrimaryAuthenticationProvider extends AbstractAuthenticat } /** - * @inheritdoc + * @inheritDoc * @note Reimplement this if you do anything other than * User::getCanonicalName( $req->username ) to determine the user being * authenticated. @@ -57,7 +57,7 @@ abstract class AbstractPrimaryAuthenticationProvider extends AbstractAuthenticat } /** - * @inheritdoc + * @inheritDoc * @note Reimplement this if self::getAuthenticationRequests( AuthManager::ACTION_REMOVE ) * doesn't return requests that will revoke all access for the user. */ diff --git a/includes/auth/AbstractSecondaryAuthenticationProvider.php b/includes/auth/AbstractSecondaryAuthenticationProvider.php index 00493bc7a4..4a2accafcb 100644 --- a/includes/auth/AbstractSecondaryAuthenticationProvider.php +++ b/includes/auth/AbstractSecondaryAuthenticationProvider.php @@ -43,7 +43,7 @@ abstract class AbstractSecondaryAuthenticationProvider extends AbstractAuthentic } /** - * @inheritdoc + * @inheritDoc * @note Reimplement this if self::getAuthenticationRequests( AuthManager::ACTION_REMOVE ) * doesn't return requests that will revoke all access for the user. */ diff --git a/includes/auth/PrimaryAuthenticationProvider.php b/includes/auth/PrimaryAuthenticationProvider.php index 4033613f75..5d82f8995c 100644 --- a/includes/auth/PrimaryAuthenticationProvider.php +++ b/includes/auth/PrimaryAuthenticationProvider.php @@ -81,7 +81,7 @@ interface PrimaryAuthenticationProvider extends AuthenticationProvider { const TYPE_NONE = 'none'; /** - * {@inheritdoc} + * @inheritDoc * * Of the requests returned by this method, exactly one should have * {@link AuthenticationRequest::$required} set to REQUIRED. diff --git a/includes/changes/ChangesListBooleanFilter.php b/includes/changes/ChangesListBooleanFilter.php index 930269cab6..01e67f5079 100644 --- a/includes/changes/ChangesListBooleanFilter.php +++ b/includes/changes/ChangesListBooleanFilter.php @@ -157,14 +157,14 @@ class ChangesListBooleanFilter extends ChangesListFilter { } /** - * @inheritdoc + * @inheritDoc */ public function displaysOnUnstructuredUi() { return !!$this->showHide; } /** - * @inheritdoc + * @inheritDoc */ public function isFeatureAvailableOnStructuredUi() { return $this->isReplacedInStructuredUi || @@ -206,7 +206,7 @@ class ChangesListBooleanFilter extends ChangesListFilter { } /** - * @inheritdoc + * @inheritDoc */ public function getJsData() { $output = parent::getJsData(); @@ -217,7 +217,7 @@ class ChangesListBooleanFilter extends ChangesListFilter { } /** - * @inheritdoc + * @inheritDoc */ public function isSelected( FormOptions $opts ) { return !$opts[ $this->getName() ] && diff --git a/includes/changes/ChangesListBooleanFilterGroup.php b/includes/changes/ChangesListBooleanFilterGroup.php index 951c4077c2..0622211f0a 100644 --- a/includes/changes/ChangesListBooleanFilterGroup.php +++ b/includes/changes/ChangesListBooleanFilterGroup.php @@ -43,7 +43,7 @@ class ChangesListBooleanFilterGroup extends ChangesListFilterGroup { } /** - * @inheritdoc + * @inheritDoc */ protected function createFilter( array $filterDefinition ) { return new ChangesListBooleanFilter( $filterDefinition ); @@ -59,7 +59,7 @@ class ChangesListBooleanFilterGroup extends ChangesListFilterGroup { } /** - * @inheritdoc + * @inheritDoc */ public function isPerGroupRequestParameter() { return false; diff --git a/includes/changes/ChangesListStringOptionsFilter.php b/includes/changes/ChangesListStringOptionsFilter.php index 76d0bef155..930ba128f6 100644 --- a/includes/changes/ChangesListStringOptionsFilter.php +++ b/includes/changes/ChangesListStringOptionsFilter.php @@ -9,14 +9,14 @@ */ class ChangesListStringOptionsFilter extends ChangesListFilter { /** - * @inheritdoc + * @inheritDoc */ public function displaysOnUnstructuredUi() { return false; } /** - * @inheritdoc + * @inheritDoc */ public function isSelected( FormOptions $opts ) { $option = $opts[ $this->getGroup()->getName() ]; diff --git a/includes/changes/ChangesListStringOptionsFilterGroup.php b/includes/changes/ChangesListStringOptionsFilterGroup.php index 487120d8a2..59efd82bca 100644 --- a/includes/changes/ChangesListStringOptionsFilterGroup.php +++ b/includes/changes/ChangesListStringOptionsFilterGroup.php @@ -129,7 +129,7 @@ class ChangesListStringOptionsFilterGroup extends ChangesListFilterGroup { } /** - * @inheritdoc + * @inheritDoc */ public function isPerGroupRequestParameter() { return true; @@ -154,7 +154,7 @@ class ChangesListStringOptionsFilterGroup extends ChangesListFilterGroup { } /** - * @inheritdoc + * @inheritDoc */ protected function createFilter( array $filterDefinition ) { return new ChangesListStringOptionsFilter( $filterDefinition ); @@ -232,7 +232,7 @@ class ChangesListStringOptionsFilterGroup extends ChangesListFilterGroup { } /** - * @inheritdoc + * @inheritDoc */ public function getJsData() { $output = parent::getJsData(); diff --git a/includes/debug/logger/monolog/BufferHandler.php b/includes/debug/logger/monolog/BufferHandler.php index 331b718c18..650d01274b 100644 --- a/includes/debug/logger/monolog/BufferHandler.php +++ b/includes/debug/logger/monolog/BufferHandler.php @@ -34,7 +34,7 @@ use Monolog\Handler\BufferHandler as BaseBufferHandler; */ class BufferHandler extends BaseBufferHandler { /** - * {@inheritDoc} + * @inheritDoc */ public function handle( array $record ) { if ( !$this->initialized ) { diff --git a/includes/debug/logger/monolog/KafkaHandler.php b/includes/debug/logger/monolog/KafkaHandler.php index 6670fe932d..8e7113164a 100644 --- a/includes/debug/logger/monolog/KafkaHandler.php +++ b/includes/debug/logger/monolog/KafkaHandler.php @@ -128,7 +128,7 @@ class KafkaHandler extends AbstractProcessingHandler { } /** - * {@inheritDoc} + * @inheritDoc */ protected function write( array $record ) { if ( $record['formatted'] !== null ) { @@ -138,7 +138,7 @@ class KafkaHandler extends AbstractProcessingHandler { } /** - * {@inheritDoc} + * @inheritDoc */ public function handleBatch( array $batch ) { $channels = []; diff --git a/includes/debug/logger/monolog/LineFormatter.php b/includes/debug/logger/monolog/LineFormatter.php index 5a7ddb1ec5..cdc4da3aa0 100644 --- a/includes/debug/logger/monolog/LineFormatter.php +++ b/includes/debug/logger/monolog/LineFormatter.php @@ -60,7 +60,7 @@ class LineFormatter extends MonologLineFormatter { } /** - * {@inheritdoc} + * @inheritDoc */ public function format( array $record ) { // Drop the 'private' flag from the context diff --git a/includes/diff/WordLevelDiff.php b/includes/diff/WordLevelDiff.php index 9c9b1c9c57..0b318bdb39 100644 --- a/includes/diff/WordLevelDiff.php +++ b/includes/diff/WordLevelDiff.php @@ -33,7 +33,7 @@ use MediaWiki\Diff\WordAccumulator; */ class WordLevelDiff extends \Diff { /** - * @inheritdoc + * @inheritDoc */ protected $bailoutComplexity = 40000000; // Roughly 6K x 6K words changed diff --git a/includes/libs/rdbms/exception/DBExpectedError.php b/includes/libs/rdbms/exception/DBExpectedError.php index f6b9bd5ebe..4f65efae02 100644 --- a/includes/libs/rdbms/exception/DBExpectedError.php +++ b/includes/libs/rdbms/exception/DBExpectedError.php @@ -50,7 +50,7 @@ class DBExpectedError extends DBError implements MessageSpecifier, ILocalizedExc } /** - * @inheritdoc + * @inheritDoc * @since 1.29 */ public function getMessageObject() { diff --git a/includes/libs/stats/SamplingStatsdClient.php b/includes/libs/stats/SamplingStatsdClient.php index 526f12013d..4db2b6072c 100644 --- a/includes/libs/stats/SamplingStatsdClient.php +++ b/includes/libs/stats/SamplingStatsdClient.php @@ -47,7 +47,7 @@ class SamplingStatsdClient extends StatsdClient { * Sets sampling rate for all items in $data. * The sample rate specified in a StatsdData entity overrides the sample rate specified here. * - * {@inheritDoc} + * @inheritDoc */ public function appendSampleRate( $data, $sampleRate = 1 ) { $samplingRates = $this->samplingRates; @@ -147,7 +147,7 @@ class SamplingStatsdClient extends StatsdClient { } /** - * {@inheritDoc} + * @inheritDoc */ protected function throwException( Exception $exception ) { if ( !$this->getFailSilently() ) { diff --git a/includes/media/Jpeg.php b/includes/media/Jpeg.php index 29f0d7c606..287c198c57 100644 --- a/includes/media/Jpeg.php +++ b/includes/media/Jpeg.php @@ -175,7 +175,7 @@ class JpegHandler extends ExifBitmapHandler { } /** - * {@inheritdoc} + * @inheritDoc */ protected function transformImageMagick( $image, $params ) { global $wgUseTinyRGBForJPGThumbnails; diff --git a/includes/resourceloader/ResourceLoaderMediaWikiUtilModule.php b/includes/resourceloader/ResourceLoaderMediaWikiUtilModule.php index 166f1babf1..d16a4ff763 100644 --- a/includes/resourceloader/ResourceLoaderMediaWikiUtilModule.php +++ b/includes/resourceloader/ResourceLoaderMediaWikiUtilModule.php @@ -27,7 +27,7 @@ */ class ResourceLoaderMediaWikiUtilModule extends ResourceLoaderFileModule { /** - * @inheritdoc + * @inheritDoc */ public function getScript( ResourceLoaderContext $context ) { return ResourceLoader::makeConfigSetScript( @@ -38,14 +38,14 @@ class ResourceLoaderMediaWikiUtilModule extends ResourceLoaderFileModule { } /** - * @inheritdoc + * @inheritDoc */ public function supportsURLLoading() { return false; } /** - * @inheritdoc + * @inheritDoc */ public function enableModuleContentVersion() { return true; diff --git a/includes/search/NullIndexField.php b/includes/search/NullIndexField.php index 852e1d5a1b..32f60bcc67 100644 --- a/includes/search/NullIndexField.php +++ b/includes/search/NullIndexField.php @@ -44,7 +44,7 @@ class NullIndexField implements SearchIndexField { } /** - * {@inheritDoc} + * @inheritDoc */ public function getEngineHints( SearchEngine $engine ) { return []; diff --git a/includes/search/SearchIndexFieldDefinition.php b/includes/search/SearchIndexFieldDefinition.php index 87d6344bea..9a637d85c2 100644 --- a/includes/search/SearchIndexFieldDefinition.php +++ b/includes/search/SearchIndexFieldDefinition.php @@ -141,7 +141,7 @@ abstract class SearchIndexFieldDefinition implements SearchIndexField { } /** - * {@inheritDoc} + * @inheritDoc */ public function getEngineHints( SearchEngine $engine ) { return []; diff --git a/includes/specials/SpecialRecentchanges.php b/includes/specials/SpecialRecentchanges.php index 6ef75e07c0..41007e274a 100644 --- a/includes/specials/SpecialRecentchanges.php +++ b/includes/specials/SpecialRecentchanges.php @@ -255,7 +255,7 @@ class SpecialRecentChanges extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function transformFilterDefinition( array $filterDefinition ) { if ( isset( $filterDefinition['showHideSuffix'] ) ) { @@ -266,7 +266,7 @@ class SpecialRecentChanges extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function registerFilters() { parent::registerFilters(); @@ -380,7 +380,7 @@ class SpecialRecentChanges extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function buildQuery( &$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts @@ -404,7 +404,7 @@ class SpecialRecentChanges extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function doMainQuery( $tables, $fields, $conds, $query_options, $join_conds, FormOptions $opts diff --git a/includes/specials/SpecialRecentchangeslinked.php b/includes/specials/SpecialRecentchangeslinked.php index fee336e435..e353f0cbdd 100644 --- a/includes/specials/SpecialRecentchangeslinked.php +++ b/includes/specials/SpecialRecentchangeslinked.php @@ -47,7 +47,7 @@ class SpecialRecentChangesLinked extends SpecialRecentChanges { } /** - * @inheritdoc + * @inheritDoc */ protected function doMainQuery( $tables, $select, $conds, $query_options, $join_conds, FormOptions $opts diff --git a/includes/specials/SpecialWatchlist.php b/includes/specials/SpecialWatchlist.php index 9e01d2d450..d23625a165 100644 --- a/includes/specials/SpecialWatchlist.php +++ b/includes/specials/SpecialWatchlist.php @@ -109,7 +109,7 @@ class SpecialWatchlist extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function transformFilterDefinition( array $filterDefinition ) { if ( isset( $filterDefinition['showHideSuffix'] ) ) { @@ -120,7 +120,7 @@ class SpecialWatchlist extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function registerFilters() { parent::registerFilters(); @@ -250,7 +250,7 @@ class SpecialWatchlist extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function buildQuery( &$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts @@ -267,7 +267,7 @@ class SpecialWatchlist extends ChangesListSpecialPage { } /** - * @inheritdoc + * @inheritDoc */ protected function doMainQuery( $tables, $fields, $conds, $query_options, $join_conds, FormOptions $opts diff --git a/includes/upload/UploadFromChunks.php b/includes/upload/UploadFromChunks.php index c0c2cb5c31..68bcb9d9c7 100644 --- a/includes/upload/UploadFromChunks.php +++ b/includes/upload/UploadFromChunks.php @@ -64,7 +64,7 @@ class UploadFromChunks extends UploadFromFile { } /** - * {@inheritdoc} + * @inheritDoc */ public function tryStashFile( User $user, $isPartial = false ) { try { @@ -77,7 +77,7 @@ class UploadFromChunks extends UploadFromFile { } /** - * {@inheritdoc} + * @inheritDoc * @throws UploadChunkVerificationException * @deprecated since 1.28 Use tryStashFile() instead */ @@ -88,7 +88,7 @@ class UploadFromChunks extends UploadFromFile { } /** - * {@inheritdoc} + * @inheritDoc * @throws UploadChunkVerificationException * @deprecated since 1.28 */ @@ -99,7 +99,7 @@ class UploadFromChunks extends UploadFromFile { } /** - * {@inheritdoc} + * @inheritDoc * @throws UploadChunkVerificationException * @deprecated since 1.28 */ -- 2.20.1