The @file doc block MUST be present for all PHP files, with one exception: files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension, and whose file path is closely related to the namespace (under PSR-4 or a similar standard), SHOULD NOT have a @file documentation block.

Check Documentaion: API documentation and comment standards

CommentFileSizeAuthor
#4 file_entity-remove_wrong_doc-2876680-2-8x.patch18.53 KBmgoncalves
#2 file_entity-remove_wrong_doc-2876680-2-8x.patch18.53 KBmgoncalves

Comments

mgoncalves created an issue. See original summary.

mgoncalves’s picture

mgoncalves commented
Assigned: mgoncalves » Unassigned
Status: Active » Needs review
StatusFileSize
new file_entity-remove_wrong_doc-2876680-2-8x.patch18.53 KB

Status: Needs review » Needs work

The last submitted patch, 2: file_entity-remove_wrong_doc-2876680-2-8x.patch, failed testing.

mgoncalves’s picture

mgoncalves commented
Status: Needs work » Needs review
StatusFileSize
new file_entity-remove_wrong_doc-2876680-2-8x.patch18.53 KB
hgunicamp’s picture

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

After applying the 'file_entity-remove_wrong_doc-2876680-2-8x_0.patch' patch and using the command

grep --color=auto '@file' $(find . -type f -name '*.php' -exec grep namespace {} \+ | cut -f1 -d':' | uniq)

I only find '@file' references as string replacing points.

After that I reviewed visually the patch.

It's OK for me.

  • mgoncalves authored 52e0c97 on 8.x-2.x 
    Issue #2876680 by mgoncalves: Remove @file documentation
joseph.olstad’s picture

joseph.olstad
Primary language French
commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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