Create check to verify that @see internal function reference is valid

Created on 23 November 2015, over 9 years ago
Updated 12 February 2025, about 2 months ago

Problem/Motivation

There are @see references in Drupal core to something that no longer exists in core.

An @see reference that does not exit.
\Drupal\Core\TypedData\ListInterface has this line and that class does not exist.
* @see \Drupal\Core\TypedData\ListDefinitionInterface

An @see reference that does exit.
\Drupal\Tests\Core\Database\Stub\StubPDO has this line which does exist.

@see Drupal\Core\Database\Connection

Steps to reproduce

Proposed resolution

Create a code check or sniff to verify that within a @see reference that an internal reference to a function or class method actually exists. Because the code will need to perform the equivalent of calls to function_exists() or method_exists(), this may require an addition to the Coder Review rather than a code sniff.

Tests:

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

✨ Feature request
Status

Active

Version

2.0

Component

Coder Review

Created by

πŸ‡ΊπŸ‡ΈUnited States Lars Toomre

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024