Change @inheritdoc to @inheritDoc
authorUmherirrender <umherirrender_de.wp@web.de>
Fri, 11 Aug 2017 14:49:52 +0000 (16:49 +0200)
committerUmherirrender <umherirrender_de.wp@web.de>
Fri, 11 Aug 2017 14:49:52 +0000 (16:49 +0200)
Only @inheritDoc works for the Sniff
MediaWiki.Commenting.FunctionComment

Change-Id: I91fc02cda6701d790e4334fc2bc47f230955545c

23 files changed:
includes/api/ApiUsageException.php
includes/auth/AbstractAuthenticationProvider.php
includes/auth/AbstractPrimaryAuthenticationProvider.php
includes/auth/AbstractSecondaryAuthenticationProvider.php
includes/auth/PrimaryAuthenticationProvider.php
includes/changes/ChangesListBooleanFilter.php
includes/changes/ChangesListBooleanFilterGroup.php
includes/changes/ChangesListStringOptionsFilter.php
includes/changes/ChangesListStringOptionsFilterGroup.php
includes/debug/logger/monolog/BufferHandler.php
includes/debug/logger/monolog/KafkaHandler.php
includes/debug/logger/monolog/LineFormatter.php
includes/diff/WordLevelDiff.php
includes/libs/rdbms/exception/DBExpectedError.php
includes/libs/stats/SamplingStatsdClient.php
includes/media/Jpeg.php
includes/resourceloader/ResourceLoaderMediaWikiUtilModule.php
includes/search/NullIndexField.php
includes/search/SearchIndexFieldDefinition.php
includes/specials/SpecialRecentchanges.php
includes/specials/SpecialRecentchangeslinked.php
includes/specials/SpecialWatchlist.php
includes/upload/UploadFromChunks.php

index fb49e2d..17655ec 100644 (file)
@@ -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();
index 9e38ecc..58cec11 100644 (file)
@@ -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() {
index ea3dfa3..ca947b6 100644 (file)
@@ -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.
         */
index 00493bc..4a2acca 100644 (file)
@@ -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.
         */
index 4033613..5d82f89 100644 (file)
@@ -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.
index 930269c..01e67f5 100644 (file)
@@ -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() ] &&
index 951c407..0622211 100644 (file)
@@ -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;
index 76d0bef..930ba12 100644 (file)
@@ -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() ];
index 487120d..59efd82 100644 (file)
@@ -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();
index 331b718..650d012 100644 (file)
@@ -34,7 +34,7 @@ use Monolog\Handler\BufferHandler as BaseBufferHandler;
  */
 class BufferHandler extends BaseBufferHandler {
        /**
-        * {@inheritDoc}
+        * @inheritDoc
         */
        public function handle( array $record ) {
                if ( !$this->initialized ) {
index 6670fe9..8e71131 100644 (file)
@@ -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 = [];
index 5a7ddb1..cdc4da3 100644 (file)
@@ -60,7 +60,7 @@ class LineFormatter extends MonologLineFormatter {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function format( array $record ) {
                // Drop the 'private' flag from the context
index 9c9b1c9..0b318bd 100644 (file)
@@ -33,7 +33,7 @@ use MediaWiki\Diff\WordAccumulator;
  */
 class WordLevelDiff extends \Diff {
        /**
-        * @inheritdoc
+        * @inheritDoc
         */
        protected $bailoutComplexity = 40000000; // Roughly 6K x 6K words changed
 
index f6b9bd5..4f65efa 100644 (file)
@@ -50,7 +50,7 @@ class DBExpectedError extends DBError implements MessageSpecifier, ILocalizedExc
        }
 
        /**
-        * @inheritdoc
+        * @inheritDoc
         * @since 1.29
         */
        public function getMessageObject() {
index 526f120..4db2b60 100644 (file)
@@ -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() ) {
index 29f0d7c..287c198 100644 (file)
@@ -175,7 +175,7 @@ class JpegHandler extends ExifBitmapHandler {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        protected function transformImageMagick( $image, $params ) {
                global $wgUseTinyRGBForJPGThumbnails;
index 166f1ba..d16a4ff 100644 (file)
@@ -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;
index 852e1d5..32f60bc 100644 (file)
@@ -44,7 +44,7 @@ class NullIndexField implements SearchIndexField {
        }
 
        /**
-        * {@inheritDoc}
+        * @inheritDoc
         */
        public function getEngineHints( SearchEngine $engine ) {
                return [];
index 87d6344..9a637d8 100644 (file)
@@ -141,7 +141,7 @@ abstract class SearchIndexFieldDefinition implements SearchIndexField {
        }
 
        /**
-        * {@inheritDoc}
+        * @inheritDoc
         */
        public function getEngineHints( SearchEngine $engine ) {
                return [];
index 6ef75e0..41007e2 100644 (file)
@@ -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
index fee336e..e353f0c 100644 (file)
@@ -47,7 +47,7 @@ class SpecialRecentChangesLinked extends SpecialRecentChanges {
        }
 
        /**
-        * @inheritdoc
+        * @inheritDoc
         */
        protected function doMainQuery( $tables, $select, $conds, $query_options,
                $join_conds, FormOptions $opts
index 9e01d2d..d23625a 100644 (file)
@@ -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
index c0c2cb5..68bcb9d 100644 (file)
@@ -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
         */