Replace lowercase {@inheritdoc} with @inheritDoc
authorThiemo Kreuz <thiemo.kreuz@wikimedia.de>
Tue, 26 Feb 2019 12:57:24 +0000 (13:57 +0100)
committerUmherirrender <umherirrender_de.wp@web.de>
Fri, 1 Mar 2019 17:25:02 +0000 (17:25 +0000)
According to the coding standards we even enforce with a custom PHPCS sniff.
It currently does not pick these mistakes up because of the curly brackets.
I'm not sure if this is worth an update of the PHPCS sniff. I wanted to
suggest this fix anyway.

Change-Id: I9041ea7a00baf7f55e0ff0e56879a89fb74bb479

includes/block/Restriction/AbstractRestriction.php
includes/block/Restriction/NamespaceRestriction.php
includes/block/Restriction/PageRestriction.php
includes/htmlform/fields/HTMLExpiryField.php
includes/specials/formfields/Licenses.php
includes/widget/ExpiryInputWidget.php
tests/phpunit/includes/block/Restriction/NamespaceRestrictionTest.php
tests/phpunit/includes/block/Restriction/PageRestrictionTest.php
tests/phpunit/includes/specials/SpecialBlockTest.php

index c89ed72..20678ad 100644 (file)
@@ -57,28 +57,28 @@ abstract class AbstractRestriction implements Restriction {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public static function getType() {
                return static::TYPE;
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public static function getTypeId() {
                return static::TYPE_ID;
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getBlockId() {
                return $this->blockId;
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function setBlockId( $blockId ) {
                $this->blockId = (int)$blockId;
@@ -87,21 +87,21 @@ abstract class AbstractRestriction implements Restriction {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getValue() {
                return $this->value;
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public static function newFromRow( \stdClass $row ) {
                return new static( $row->ir_ipb_id, $row->ir_value );
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function toRow() {
                return [
@@ -112,14 +112,14 @@ abstract class AbstractRestriction implements Restriction {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function equals( Restriction $other ) {
                return $this->getHash() === $other->getHash();
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getHash() {
                return $this->getType() . '-' . $this->getValue();
index bf9769f..8d86853 100644 (file)
@@ -25,17 +25,17 @@ namespace MediaWiki\Block\Restriction;
 class NamespaceRestriction extends AbstractRestriction {
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        const TYPE = 'ns';
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        const TYPE_ID = 2;
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function matches( \Title $title ) {
                return $this->getValue() === $title->getNamespace();
index 5d3fabb..ea73d19 100644 (file)
@@ -25,12 +25,12 @@ namespace MediaWiki\Block\Restriction;
 class PageRestriction extends AbstractRestriction {
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        const TYPE = 'page';
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        const TYPE_ID = 1;
 
@@ -40,7 +40,7 @@ class PageRestriction extends AbstractRestriction {
        protected $title;
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function matches( \Title $title ) {
                if ( !$this->getTitle() ) {
@@ -84,7 +84,7 @@ class PageRestriction extends AbstractRestriction {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public static function newFromRow( \stdClass $row ) {
                $restriction = parent::newFromRow( $row );
index fb0ca77..5866d97 100644 (file)
@@ -25,7 +25,7 @@ class HTMLExpiryField extends HTMLFormField {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         *
         * Use whatever the relative field is as the standard HTML input.
         */
@@ -38,7 +38,7 @@ class HTMLExpiryField extends HTMLFormField {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        protected function getOOUIModules() {
                return array_merge(
@@ -50,7 +50,7 @@ class HTMLExpiryField extends HTMLFormField {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getInputOOUI( $value ) {
                return new ExpiryInputWidget(
@@ -63,7 +63,7 @@ class HTMLExpiryField extends HTMLFormField {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function loadDataFromRequest( $request ) {
                return $this->relativeField->loadDataFromRequest( $request );
index 51e63d9..204b033 100644 (file)
@@ -214,7 +214,7 @@ class Licenses extends HTMLFormField {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getInputHTML( $value ) {
                $this->selected = $value;
index 289cc85..be6e676 100644 (file)
@@ -54,7 +54,7 @@ class ExpiryInputWidget extends Widget {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        public function getConfig( &$config ) {
                $config['required'] = $this->required;
index 4356240..8f54789 100644 (file)
@@ -29,7 +29,7 @@ class NamespaceRestrictionTest extends RestrictionTestCase {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        protected function getClass() {
                return NamespaceRestriction::class;
index ff68e6f..c547878 100644 (file)
@@ -61,7 +61,7 @@ class PageRestrictionTest extends RestrictionTestCase {
        }
 
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        protected function getClass() {
                return PageRestriction::class;
index 8c8e270..91f12f4 100644 (file)
@@ -12,7 +12,7 @@ use Wikimedia\TestingAccessWrapper;
  */
 class SpecialBlockTest extends SpecialPageTestBase {
        /**
-        * {@inheritdoc}
+        * @inheritDoc
         */
        protected function newSpecialPage() {
                return new SpecialBlock();