Problem/Motivation

@ symbol is missing and prevents {@inheritdoc} from being properly parsed in 3 files:

core/lib/Drupal/Core/Entity/ContentEntityBase.php
332:   * {inheritdoc}

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithDependencies.php
33:   * {inheritdoc}

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItemWithPreconfiguredOptions.php
27:   * {inheritdoc}

Proposed resolution

Write a patch replacing {inheritdoc} with {@inheritdoc}.

Remaining tasks

User interface changes

None

API changes

None

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category Bug
Issue priority Minor
Unfrozen changes Unfrozen because it only changes API documentation
CommentFileSizeAuthor
#1 fix-typo-inheritdoc-2488156-1.patch1.85 KBandileco

Comments

andileco’s picture

andileco commented
StatusFileSize
new fix-typo-inheritdoc-2488156-1.patch1.85 KB

OK, this should do it.

andileco’s picture

andileco commented
Status: Active » Needs review
jonreid’s picture

jonreid commented
Status: Needs review » Reviewed & tested by the community

Looks good.

mradcliffe’s picture

mradcliffe
he/him
Primary language English
commented
Issue summary: View changes

Added beta evaluation.

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
commented
Issue tags: -Novice

I am removing the Novice Tag from this Issue because all tasks have been completed.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Nice catch and thanks for the patch! Committed to 8.0.x.

Beta eval: Just small API docs fix, allowed in beta.

  • jhodgdon committed e1a8219 on 8.0.x 
    Issue #2488156 by andile2012: Fix typos in @inheritdoc
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed
andileco’s picture

andileco commented

Thanks, all! This was my very first committed patch. Will this show up on my user profile?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

No... Core patches don't currently (sigh), but that's being worked on I think.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.