As per coding standard documentation at https://www.drupal.org/coding-standards/docs#file, the @file docblock should not be there in the files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension.

CommentFileSizeAuthor
#3 file_table_formatter_file_docblock_search_results.png65.75 KBdhruveshdtripathi
#2 2875078-2.patch1.55 KBPavan B S
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Pavan B S created an issue. See original summary.

Pavan B S’s picture

Pavan B S CreditAttribution: Pavan B S at Valuebound commented
Assigned: Pavan B S » Unassigned
Status: Active » Needs review
FileSize
2875078-2.patch1.55 KB

Applying the patch, please review.

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda commented
FileSize
file_table_formatter_file_docblock_search_results.png65.75 KB

Patch applied cleanly. All the @file docblocks removed from .php files. Checked it manually. As you can see in the attached png file, earlier there were 5 @file docblocks, after applying patch there is 1. That 1 @file docblock is from .module file.

Good work!

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda commented
Status: Needs review » Reviewed & tested by the community

  • zengenuity committed ef1342a on 8.x-1.x authored by Pavan B S 
    Issue #2875079 and #2875078 by Pavan B S, dhruveshdtripathi: Coding...
zengenuity’s picture

zengenuity CreditAttribution: zengenuity at Zengenuity commented
Status: Reviewed & tested by the community » Fixed

Committed. Thanks.

Status: Fixed » Closed (fixed)

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