Issue #3327853 by Spokje, bbrala, longwave: Don't allow {@inheritDoc} annotation in PHPDocBlocks

core/lib/Drupal/Core/Entity/EntityAutocompleteMatcher.php

@@ -29,7 +29,7 @@ public function __construct(SelectionPluginManagerInterface $selection_manager)
   }
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   public function getMatches($target_type, $selection_handler, $selection_settings, $string = '') {
     $matches = [];

core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php

@@ -55,7 +55,7 @@ public function __construct(array $configuration, string $plugin_id, CKEditor5Pl
   }
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
     return new static(

core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/MediaLibrary.php

@@ -48,7 +48,7 @@ public function __construct(array $configuration, string $plugin_id, CKEditor5Pl
   }
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
     return new static(

core/modules/dblog/src/Plugin/views/filter/DblogTypes.php

@@ -23,7 +23,7 @@ public function getValueOptions() {
   }
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   protected function valueForm(&$form, FormStateInterface $form_state) {
     parent::valueForm($form, $form_state);

core/modules/file/tests/file_test/src/StreamWrapper/DummyExternalReadOnlyWrapper.php

@@ -13,28 +13,28 @@
 class DummyExternalReadOnlyWrapper extends ReadOnlyStream {
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public static function getType() {
     return StreamWrapperInterface::READ_VISIBLE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function getName() {
     return t('Dummy external stream wrapper (readonly)');
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function getDescription() {
     return t('Dummy external read-only stream wrapper for testing.');
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function getExternalUrl() {
     [, $target] = explode('://', $this->uri, 2);
@@ -42,105 +42,105 @@ public function getExternalUrl() {
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function realpath() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function dirname($uri = NULL) {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function dir_closedir() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function dir_opendir($path, $options) {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function dir_readdir() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function dir_rewinddir() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_cast($cast_as) {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_close() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_eof() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_read($count) {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_seek($offset, $whence = SEEK_SET) {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_set_option($option, $arg1, $arg2) {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_stat() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function stream_tell() {
     return FALSE;
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function url_stat($path, $flags) {
     return FALSE;

core/modules/jsonapi/tests/src/Kernel/Normalizer/LinkCollectionNormalizerTest.php

@@ -46,7 +46,7 @@ class LinkCollectionNormalizerTest extends KernelTestBase {
   protected $testUsers;
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   protected static $modules = [
     'jsonapi',
@@ -56,7 +56,7 @@ class LinkCollectionNormalizerTest extends KernelTestBase {
   ];
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   protected function setUp(): void {
     parent::setUp();

core/modules/migrate/src/Plugin/Migration.php

@@ -506,7 +506,7 @@ public function getIdMap() {
   }
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   public function getRequirements(): array {
     return $this->requirements;

core/modules/pgsql/src/Driver/Database/pgsql/Connection.php

@@ -364,7 +364,7 @@ public function rollbackSavepoint($savepoint_name = 'mimic_implicit_commit') {
   }
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   public function hasJson(): bool {
     try {

core/modules/system/tests/modules/js_interaction_test/src/Controller/JSInteractionTestForm.php

@@ -12,7 +12,7 @@
 class JSInteractionTestForm extends FormBase {
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function getFormId() {
     return __CLASS__;

core/modules/user/tests/src/Kernel/Controller/UserControllerTest.php

@@ -40,7 +40,7 @@ class UserControllerTest extends KernelTestBase {
   ];
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   protected function setUp(): void {
 

core/modules/views/tests/modules/views_config_entity_test/src/ViewsConfigEntityTestViewsData.php

@@ -18,7 +18,7 @@ public function getViewsData() {
   }
 
   /**
-   * @inheritDoc
+   * {@inheritdoc}
    */
   public function getViewsTableForEntityType(EntityTypeInterface $entity_type) {
     return 'views_config_entity_test';

core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php

@@ -93,7 +93,7 @@ public function onKernelRequest(RequestEvent $event) {
   }
 
   /**
-   * {@inheritDoc}
+   * {@inheritdoc}
    */
   public static function getSubscribedEvents(): array {
     // Use a priority of 190 in order to run after the generic core subscriber.

core/phpcs.xml.dist

@@ -251,6 +251,22 @@
   <rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
   <rule ref="PSR2.Namespaces.UseDeclaration"/>
 
+  <!-- SlevomatCodingStandard sniffs -->
+  <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
+    <properties>
+      <property name="forbiddenAnnotations" type="array">
+        <element value="@inheritDoc"/>
+      </property>
+    </properties>
+  </rule>
+  <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
+    <properties>
+       <property name="forbiddenCommentPatterns" type="array">
+         <element value="/@inheritDoc/"/>
+       </property>
+    </properties>
+  </rule>
+
   <!-- Squiz sniffs -->
   <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
   <rule ref="Squiz.Arrays.ArrayDeclaration">