From cc7365baa3424c6ee3339c4c1b390acf5aff3cd5 Mon Sep 17 00:00:00 2001 From: xjm <xjm@65776.no-reply.drupal.org> Date: Thu, 30 Apr 2020 11:10:49 -0500 Subject: [PATCH] Issue #3126957 by Suresh Prabhu Parkala, jungle, Neslee Canil Pinto, Kristen Pol, xjm: Add missing curly brackets around @inheritdoc --- core/modules/ckeditor/js/views/KeyboardView.es6.js | 2 +- .../contextual/js/toolbar/views/AuralView.es6.js | 2 +- .../contextual/js/toolbar/views/VisualView.es6.js | 2 +- core/modules/contextual/js/views/AuralView.es6.js | 2 +- core/modules/contextual/js/views/RegionView.es6.js | 2 +- core/modules/contextual/js/views/VisualView.es6.js | 2 +- .../editor/js/editor.formattedTextEditor.es6.js | 8 ++++---- core/modules/image/js/editors/image.es6.js | 10 +++++----- .../src/Kernel/Revisions/VersionNegotiatorTest.php | 4 +--- core/modules/migrate/src/Plugin/migrate/id_map/Sql.php | 2 +- .../migrate/tests/src/Unit/process/UrlEncodeTest.php | 2 +- .../migrate_drupal/src/Annotation/MigrateField.php | 2 +- .../src/Functional/Rest/PathAliasResourceTestBase.php | 2 +- core/modules/quickedit/js/editors/formEditor.es6.js | 8 ++++---- .../quickedit/js/editors/plainTextEditor.es6.js | 8 ++++---- core/modules/quickedit/js/models/EntityModel.es6.js | 2 +- core/modules/quickedit/js/models/FieldModel.es6.js | 2 +- core/modules/quickedit/js/views/EditorView.es6.js | 2 +- .../quickedit/js/views/EntityDecorationView.es6.js | 4 ++-- .../quickedit/js/views/EntityToolbarView.es6.js | 4 ++-- .../quickedit/js/views/FieldDecorationView.es6.js | 2 +- .../modules/quickedit/js/views/FieldToolbarView.es6.js | 2 +- core/modules/toolbar/js/models/ToolbarModel.es6.js | 2 +- core/modules/toolbar/js/views/BodyVisualView.es6.js | 2 +- core/modules/toolbar/js/views/MenuVisualView.es6.js | 2 +- core/modules/toolbar/js/views/ToolbarVisualView.es6.js | 2 +- core/modules/tour/js/tour.es6.js | 2 +- 27 files changed, 42 insertions(+), 44 deletions(-) diff --git a/core/modules/ckeditor/js/views/KeyboardView.es6.js b/core/modules/ckeditor/js/views/KeyboardView.es6.js index 4c9aead86983..9d2753907211 100644 --- a/core/modules/ckeditor/js/views/KeyboardView.es6.js +++ b/core/modules/ckeditor/js/views/KeyboardView.es6.js @@ -28,7 +28,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} */ render() {}, diff --git a/core/modules/contextual/js/toolbar/views/AuralView.es6.js b/core/modules/contextual/js/toolbar/views/AuralView.es6.js index 0fb25e17d8de..56c795333638 100644 --- a/core/modules/contextual/js/toolbar/views/AuralView.es6.js +++ b/core/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/core/modules/contextual/js/toolbar/views/VisualView.es6.js b/core/modules/contextual/js/toolbar/views/VisualView.es6.js index d168d5414ca1..accbfce9f4a1 100644 --- a/core/modules/contextual/js/toolbar/views/VisualView.es6.js +++ b/core/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/core/modules/contextual/js/views/AuralView.es6.js b/core/modules/contextual/js/views/AuralView.es6.js index f48082986695..ca278eeadf82 100644 --- a/core/modules/contextual/js/views/AuralView.es6.js +++ b/core/modules/contextual/js/views/AuralView.es6.js @@ -26,7 +26,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} */ render() { const isOpen = this.model.get('isOpen'); diff --git a/core/modules/contextual/js/views/RegionView.es6.js b/core/modules/contextual/js/views/RegionView.es6.js index 57048a77d68d..a7ab18531b14 100644 --- a/core/modules/contextual/js/views/RegionView.es6.js +++ b/core/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/core/modules/contextual/js/views/VisualView.es6.js b/core/modules/contextual/js/views/VisualView.es6.js index 57f68cacc379..31bc79292bed 100644 --- a/core/modules/contextual/js/views/VisualView.es6.js +++ b/core/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/core/modules/editor/js/editor.formattedTextEditor.es6.js b/core/modules/editor/js/editor.formattedTextEditor.es6.js index 31551648fd25..8ff2fd9731a7 100644 --- a/core/modules/editor/js/editor.formattedTextEditor.es6.js +++ b/core/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/core/modules/image/js/editors/image.es6.js b/core/modules/image/js/editors/image.es6.js index b43f75f0147f..df6a5e282c98 100644 --- a/core/modules/image/js/editors/image.es6.js +++ b/core/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/core/modules/jsonapi/tests/src/Kernel/Revisions/VersionNegotiatorTest.php b/core/modules/jsonapi/tests/src/Kernel/Revisions/VersionNegotiatorTest.php index 774b51ec51f4..057149ea87d7 100644 --- a/core/modules/jsonapi/tests/src/Kernel/Revisions/VersionNegotiatorTest.php +++ b/core/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/core/modules/migrate/src/Plugin/migrate/id_map/Sql.php b/core/modules/migrate/src/Plugin/migrate/id_map/Sql.php index d85c043dce5f..c881f51b3d9d 100644 --- a/core/modules/migrate/src/Plugin/migrate/id_map/Sql.php +++ b/core/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/core/modules/migrate/tests/src/Unit/process/UrlEncodeTest.php b/core/modules/migrate/tests/src/Unit/process/UrlEncodeTest.php index df41e8284097..7eb2aca4ef8c 100644 --- a/core/modules/migrate/tests/src/Unit/process/UrlEncodeTest.php +++ b/core/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/core/modules/migrate_drupal/src/Annotation/MigrateField.php b/core/modules/migrate_drupal/src/Annotation/MigrateField.php index 9e2804e3d909..f8ebadfa0b48 100644 --- a/core/modules/migrate_drupal/src/Annotation/MigrateField.php +++ b/core/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/core/modules/path_alias/tests/src/Functional/Rest/PathAliasResourceTestBase.php b/core/modules/path_alias/tests/src/Functional/Rest/PathAliasResourceTestBase.php index 78a2399d8135..a2ab0099ed3d 100644 --- a/core/modules/path_alias/tests/src/Functional/Rest/PathAliasResourceTestBase.php +++ b/core/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/core/modules/quickedit/js/editors/formEditor.es6.js b/core/modules/quickedit/js/editors/formEditor.es6.js index 8dcf5f3513a8..5708339c0ac9 100644 --- a/core/modules/quickedit/js/editors/formEditor.es6.js +++ b/core/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/core/modules/quickedit/js/editors/plainTextEditor.es6.js b/core/modules/quickedit/js/editors/plainTextEditor.es6.js index c509431b976e..5e8ba8e61efa 100644 --- a/core/modules/quickedit/js/editors/plainTextEditor.es6.js +++ b/core/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/core/modules/quickedit/js/models/EntityModel.es6.js b/core/modules/quickedit/js/models/EntityModel.es6.js index c3f10e95e050..0d129197afcc 100644 --- a/core/modules/quickedit/js/models/EntityModel.es6.js +++ b/core/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/core/modules/quickedit/js/models/FieldModel.es6.js b/core/modules/quickedit/js/models/FieldModel.es6.js index e07a9faa5f49..e7f47846d9f0 100644 --- a/core/modules/quickedit/js/models/FieldModel.es6.js +++ b/core/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/core/modules/quickedit/js/views/EditorView.es6.js b/core/modules/quickedit/js/views/EditorView.es6.js index f08d8bbab074..b31bcaaf55a3 100644 --- a/core/modules/quickedit/js/views/EditorView.es6.js +++ b/core/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/core/modules/quickedit/js/views/EntityDecorationView.es6.js b/core/modules/quickedit/js/views/EntityDecorationView.es6.js index 283bed33e992..824e37eb7cf1 100644 --- a/core/modules/quickedit/js/views/EntityDecorationView.es6.js +++ b/core/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/core/modules/quickedit/js/views/EntityToolbarView.es6.js b/core/modules/quickedit/js/views/EntityToolbarView.es6.js index eece46b5a11e..35f125ed9722 100644 --- a/core/modules/quickedit/js/views/EntityToolbarView.es6.js +++ b/core/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/core/modules/quickedit/js/views/FieldDecorationView.es6.js b/core/modules/quickedit/js/views/FieldDecorationView.es6.js index b3d0317beb9d..cb93caddb615 100644 --- a/core/modules/quickedit/js/views/FieldDecorationView.es6.js +++ b/core/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/core/modules/quickedit/js/views/FieldToolbarView.es6.js b/core/modules/quickedit/js/views/FieldToolbarView.es6.js index 76acb0d56d30..192f7598ded2 100644 --- a/core/modules/quickedit/js/views/FieldToolbarView.es6.js +++ b/core/modules/quickedit/js/views/FieldToolbarView.es6.js @@ -56,7 +56,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} * * @return {Drupal.quickedit.FieldToolbarView} * The current FieldToolbarView. diff --git a/core/modules/toolbar/js/models/ToolbarModel.es6.js b/core/modules/toolbar/js/models/ToolbarModel.es6.js index 2a18a6aee09f..16e507367a1a 100644 --- a/core/modules/toolbar/js/models/ToolbarModel.es6.js +++ b/core/modules/toolbar/js/models/ToolbarModel.es6.js @@ -131,7 +131,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} * * @param {object} attributes * Attributes for the toolbar. diff --git a/core/modules/toolbar/js/views/BodyVisualView.es6.js b/core/modules/toolbar/js/views/BodyVisualView.es6.js index 8a88c3ae23f0..c837846ba75f 100644 --- a/core/modules/toolbar/js/views/BodyVisualView.es6.js +++ b/core/modules/toolbar/js/views/BodyVisualView.es6.js @@ -34,7 +34,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} */ render() { $('body') diff --git a/core/modules/toolbar/js/views/MenuVisualView.es6.js b/core/modules/toolbar/js/views/MenuVisualView.es6.js index 4d95ac98987d..a3b5bfb6a415 100644 --- a/core/modules/toolbar/js/views/MenuVisualView.es6.js +++ b/core/modules/toolbar/js/views/MenuVisualView.es6.js @@ -18,7 +18,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} */ render() { const subtrees = this.model.get('subtrees'); diff --git a/core/modules/toolbar/js/views/ToolbarVisualView.es6.js b/core/modules/toolbar/js/views/ToolbarVisualView.es6.js index 6d9350a8313a..716c8e8d8847 100644 --- a/core/modules/toolbar/js/views/ToolbarVisualView.es6.js +++ b/core/modules/toolbar/js/views/ToolbarVisualView.es6.js @@ -102,7 +102,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} * * @return {Drupal.toolbar.ToolbarVisualView} * The `ToolbarVisualView` instance. diff --git a/core/modules/tour/js/tour.es6.js b/core/modules/tour/js/tour.es6.js index b4dcb7abdb3a..76fa12226360 100644 --- a/core/modules/tour/js/tour.es6.js +++ b/core/modules/tour/js/tour.es6.js @@ -125,7 +125,7 @@ }, /** - * @inheritdoc + * {@inheritdoc} * * @return {Drupal.tour.views.ToggleTourView} * The `ToggleTourView` view. -- GitLab