On the PoStreamInterface.php file and ThemeExtensionList.php file the @see tags referring to class/interface names don't use a fully qualified class name, as the Drupal coding standards (API documentation and comment standards, classes) says.

Immediately after an @tag (@param, @return, @var, etc.), class and interface names must always include the fully-qualified namespace.

CommentFileSizeAuthor
#9 see_tags_dont_use_fully_qualified_class_interface_names-3103803-9.patch15.25 KBhardik_patel_12
#7 interdiff-3103803-2-7.txt15.17 KBhardik_patel_12
#7 see_tags_dont_use_fully_qualified_class_interface_names-3103803-7.patch15.97 KBhardik_patel_12
#4 Patch.png18.02 KBshimpy
#2 see_tags_dont_use_fully_qualified_class_interface_names-3103803-2.patch1.4 KBhardik_patel_12

Comments

Hardik_Patel_12 created an issue. See original summary.

hardik_patel_12’s picture

hardik_patel_12 commented
Status: Needs work » Needs review
StatusFileSize
new see_tags_dont_use_fully_qualified_class_interface_names-3103803-2.patch1.4 KB

Kindly follow a new patch

hardik_patel_12’s picture

hardik_patel_12 commented
Assigned: hardik_patel_12 » Unassigned
shimpy’s picture

shimpy
Location India
commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Patch.png18.02 KB

This patch #2 applied cleanly . Looks great.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Needs work

There's also
// @see BrowserTestBase::initFrontPage()
@see Drupal\Component\Utility\Html::escape()
and plenty more.

I've tried to think if we could come up with a generic rule for coder to check and it's pretty tricky because @see can also link to URLs and global functions and vendor code or even code that might only optionally exist.

I think if this issue made an attempt to clean up core then I'd be inclined to commit it and move on but doing 3 out of 200 odd I found by doing a case sensitive grep for \@see [A-Z] doesn't feel like enough.

avpaderno’s picture

avpaderno
he/him
Primary language Italian
Location Brescia, 🇮🇹 🇪🇺
commented
Related issues: +#3102478: [PP-1] @see tags don't use fully qualified class/interface names, +#2662208: Fix @see documentation in core

@alexpott Before this issue, I opened #3102478: [PP-1] @see tags don't use fully qualified class/interface names where I stated The same issue is probably present in more files. If it's preferable to get a single issue for this, should not this issue be closed as duplicated?

hardik_patel_12’s picture

hardik_patel_12 commented
StatusFileSize
new see_tags_dont_use_fully_qualified_class_interface_names-3103803-7.patch15.97 KB
new interdiff-3103803-2-7.txt15.17 KB

Kindly review a new patch.

hardik_patel_12’s picture

hardik_patel_12 commented
Status: Needs work » Needs review
hardik_patel_12’s picture

hardik_patel_12 commented
StatusFileSize
new see_tags_dont_use_fully_qualified_class_interface_names-3103803-9.patch15.25 KB

Kindly review a new patch.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Needs review » Closed (duplicate)

@kiamlaluno you're right this issue is a duplicate of #3102478: [PP-1] @see tags don't use fully qualified class/interface names.

@Hardik_Patel_12 can you collaborate on the pre-existing issue. Thanks!