Hi,

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

Thanks

CommentFileSizeAuthor
#2 redhen-remove_wrong_doc-2877014-2-8x.patch20.58 KBmgoncalves

Comments

mgoncalves created an issue. See original summary.

mgoncalves’s picture

mgoncalves commented
Assigned: mgoncalves » Unassigned
Status: Active » Needs review
StatusFileSize
new redhen-remove_wrong_doc-2877014-2-8x.patch20.58 KB
hgunicamp’s picture

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

After applying the 'redhen-remove_wrong_doc-2877014-2-8x.patch' patch and using the command

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

without any '@file' occurrences.

After that I reviewed visually the patch.

It's OK for me.

gcb’s picture

gcb
he/him
Location Portland, OR
commented
Status: Reviewed & tested by the community » Fixed

Thanks for your nice clean patch and dedication to proper coding standards! committed.

  • gcb committed 97bca2f on 8.x-1.x authored by mgoncalves 
    Issue #2877014 by mgoncalves: Remove @file documentation

Status: Fixed » Closed (fixed)

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