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 flag-remove_wrong_doc-2877097-2-8x.patch343 bytesmgoncalves

Comments

mgoncalves created an issue. See original summary.

mgoncalves’s picture

mgoncalves commented
Assigned: mgoncalves » Unassigned
Status: Active » Needs review
StatusFileSize
new flag-remove_wrong_doc-2877097-2-8x.patch343 bytes
riddhi.addweb’s picture

riddhi.addweb commented
Status: Needs review » Reviewed & tested by the community

Thanks mgoncalves for patch, after applying your patch @file tag is removed from the given file. patch works well for me.

joachim’s picture

joachim commented
Status: Reviewed & tested by the community » Fixed

Committed. Thanks for the patch and the review!

  • joachim committed 8ffe4a5 on 8.x-4.x authored by mgoncalves 
    Issue #2877097 by mgoncalves: Removed @file documentation from class...
riddhi.addweb’s picture

riddhi.addweb commented

@joachim Seems you missed providing me credit, can you please recommit and do the needful. Thanks!

joachim’s picture

joachim commented

It's not possible to recommit I'm afraid. Sorry!

Status: Fixed » Closed (fixed)

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