Issue #3126957 by Suresh Prabhu Parkala, jungle, Neslee Canil Pinto, …

…Kristen Pol, xjm: Add missing curly brackets around @inheritdoc
drupal · Apr 30, 2020 · ab20a22 · ab20a22
1 parent 6118d5b
commit ab20a22
Show file tree

Hide file tree

Showing 27 changed files with 42 additions and 44 deletions.
diff --git a/modules/ckeditor/js/views/KeyboardView.es6.js b/modules/ckeditor/js/views/KeyboardView.es6.js
@@ -28,7 +28,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       render() {},
 

diff --git a/modules/contextual/js/toolbar/views/AuralView.es6.js b/modules/contextual/js/toolbar/views/AuralView.es6.js
@@ -34,7 +34,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.contextualToolbar.AuralView}
        *   The current contextual toolbar aural view.

diff --git a/modules/contextual/js/toolbar/views/VisualView.es6.js b/modules/contextual/js/toolbar/views/VisualView.es6.js
@@ -42,7 +42,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.contextualToolbar.VisualView}
        *   The current contextual toolbar visual view.

diff --git a/modules/contextual/js/views/AuralView.es6.js b/modules/contextual/js/views/AuralView.es6.js
@@ -26,7 +26,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       render() {
         const isOpen = this.model.get('isOpen');

diff --git a/modules/contextual/js/views/RegionView.es6.js b/modules/contextual/js/views/RegionView.es6.js
@@ -43,7 +43,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.contextual.RegionView}
        *   The current contextual region view.

diff --git a/modules/contextual/js/views/VisualView.es6.js b/modules/contextual/js/views/VisualView.es6.js
@@ -49,7 +49,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.contextual.VisualView}
        *   The current contextual visual view.

diff --git a/modules/editor/js/editor.formattedTextEditor.es6.js b/modules/editor/js/editor.formattedTextEditor.es6.js
@@ -73,7 +73,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {jQuery}
        *   The text element edited.
@@ -83,7 +83,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @param {object} fieldModel
        *   The field model.
@@ -179,7 +179,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {object}
        *   The settings for the quick edit UI.
@@ -194,7 +194,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       revert() {
         this.$textElement.html(this.model.get('originalValue'));

diff --git a/modules/image/js/editors/image.es6.js b/modules/image/js/editors/image.es6.js
@@ -40,7 +40,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @param {Drupal.quickedit.FieldModel} fieldModel
        *   The field model that holds the state.
@@ -329,14 +329,14 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       revert() {
         this.$el.html(this.model.get('originalValue'));
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       getQuickEditUISettings() {
         return {
@@ -348,7 +348,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       showValidationErrors() {
         const errors = Drupal.theme('quickeditImageErrors', {
@@ -363,7 +363,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       removeValidationErrors() {
         $(`#${this.fieldModel.toolbarView.getMainWysiwygToolgroupId()}`)

diff --git a/modules/jsonapi/tests/src/Kernel/Revisions/VersionNegotiatorTest.php b/modules/jsonapi/tests/src/Kernel/Revisions/VersionNegotiatorTest.php
@@ -67,9 +67,7 @@ class VersionNegotiatorTest extends JsonapiKernelTestBase {
   ];
 
   /**
-   * Initialization tasks for the test.
-   *
-   * @inheritdoc
+   * {@inheritdoc}
    */
   protected function setUp() {
     parent::setUp();

diff --git a/modules/migrate/src/Plugin/migrate/id_map/Sql.php b/modules/migrate/src/Plugin/migrate/id_map/Sql.php
@@ -922,7 +922,7 @@ public function currentDestination() {
   }
 
   /**
-   * @inheritdoc
+   * {@inheritdoc}
    */
   public function currentSource() {
     if ($this->valid()) {

diff --git a/modules/migrate/tests/src/Unit/process/UrlEncodeTest.php b/modules/migrate/tests/src/Unit/process/UrlEncodeTest.php
@@ -14,7 +14,7 @@
 class UrlEncodeTest extends MigrateTestCase {
 
   /**
-   * @inheritdoc
+   * {@inheritdoc}
    */
   protected $migrationConfiguration = [
     'id' => 'test',

diff --git a/modules/migrate_drupal/src/Annotation/MigrateField.php b/modules/migrate_drupal/src/Annotation/MigrateField.php
@@ -20,7 +20,7 @@
 class MigrateField extends Plugin {
 
   /**
-   * @inheritdoc
+   * {@inheritdoc}
    */
   public function __construct($values) {
     parent::__construct($values);

diff --git a/modules/path_alias/tests/src/Functional/Rest/PathAliasResourceTestBase.php b/modules/path_alias/tests/src/Functional/Rest/PathAliasResourceTestBase.php
@@ -25,7 +25,7 @@ abstract class PathAliasResourceTestBase extends EntityResourceTestBase {
   protected static $entityTypeId = 'path_alias';
 
   /**
-   * @inheritdoc
+   * {@inheritdoc}
    */
   protected static $patchProtectedFieldNames = [];
 

diff --git a/modules/quickedit/js/editors/formEditor.es6.js b/modules/quickedit/js/editors/formEditor.es6.js
@@ -26,7 +26,7 @@
       formSaveAjax: null,
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @param {object} fieldModel
        *   The field model that holds the state.
@@ -76,7 +76,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {object}
        *   A settings object for the quick edit UI.
@@ -192,7 +192,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       save() {
         const $formContainer = this.$formContainer;
@@ -265,7 +265,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       showValidationErrors() {
         this.$formContainer

diff --git a/modules/quickedit/js/editors/plainTextEditor.es6.js b/modules/quickedit/js/editors/plainTextEditor.es6.js
@@ -45,7 +45,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {jQuery}
        *   The text element for the plain text editor.
@@ -55,7 +55,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @param {object} fieldModel
        *   The field model that holds the state.
@@ -115,7 +115,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {object}
        *   A settings object for the quick edit UI.
@@ -130,7 +130,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       revert() {
         this.$textElement.html(this.model.get('originalValue'));

diff --git a/modules/quickedit/js/models/EntityModel.es6.js b/modules/quickedit/js/models/EntityModel.es6.js
@@ -698,7 +698,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       sync() {
         // We don't use REST updates to sync.

diff --git a/modules/quickedit/js/models/FieldModel.es6.js b/modules/quickedit/js/models/FieldModel.es6.js
@@ -150,7 +150,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       sync() {
         // We don't use REST updates to sync.

diff --git a/modules/quickedit/js/views/EditorView.es6.js b/modules/quickedit/js/views/EditorView.es6.js
@@ -41,7 +41,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       remove() {
         // The el property is the field, which should not be removed. Remove the

diff --git a/modules/quickedit/js/views/EntityDecorationView.es6.js b/modules/quickedit/js/views/EntityDecorationView.es6.js
@@ -18,7 +18,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       render() {
         this.$el.toggleClass(
@@ -28,7 +28,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       remove() {
         this.setElement(null);

diff --git a/modules/quickedit/js/views/EntityToolbarView.es6.js b/modules/quickedit/js/views/EntityToolbarView.es6.js
@@ -88,7 +88,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.quickedit.EntityToolbarView}
        *   The entity toolbar view.
@@ -151,7 +151,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       remove() {
         // Remove additional DOM elements controlled by this View.

diff --git a/modules/quickedit/js/views/FieldDecorationView.es6.js b/modules/quickedit/js/views/FieldDecorationView.es6.js
@@ -44,7 +44,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       remove() {
         // The el property is the field, which should not be removed. Remove the

diff --git a/modules/quickedit/js/views/FieldToolbarView.es6.js b/modules/quickedit/js/views/FieldToolbarView.es6.js
@@ -56,7 +56,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.quickedit.FieldToolbarView}
        *   The current FieldToolbarView.

diff --git a/modules/toolbar/js/models/ToolbarModel.es6.js b/modules/toolbar/js/models/ToolbarModel.es6.js
@@ -131,7 +131,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @param {object} attributes
        *   Attributes for the toolbar.

diff --git a/modules/toolbar/js/views/BodyVisualView.es6.js b/modules/toolbar/js/views/BodyVisualView.es6.js
@@ -34,7 +34,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       render() {
         $('body')

diff --git a/modules/toolbar/js/views/MenuVisualView.es6.js b/modules/toolbar/js/views/MenuVisualView.es6.js
@@ -18,7 +18,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        */
       render() {
         const subtrees = this.model.get('subtrees');

diff --git a/modules/toolbar/js/views/ToolbarVisualView.es6.js b/modules/toolbar/js/views/ToolbarVisualView.es6.js
@@ -102,7 +102,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.toolbar.ToolbarVisualView}
        *   The `ToolbarVisualView` instance.

diff --git a/modules/tour/js/tour.es6.js b/modules/tour/js/tour.es6.js
@@ -125,7 +125,7 @@
       },
 
       /**
-       * @inheritdoc
+       * {@inheritdoc}
        *
        * @return {Drupal.tour.views.ToggleTourView}
        *   The `ToggleTourView` view.