[wp-trac] [WordPress Trac] #27200: Remove all @package and @subpackage tags from function DocBlocks (was: Remove all non-file-level @package/@subpackage tags)

WordPress Trac noreply at wordpress.org
Tue Feb 25 14:41:53 UTC 2014


#27200: Remove all @package and @subpackage tags from function DocBlocks
--------------------------+------------------------------
 Reporter:  DrewAPicture  |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+------------------------------

Comment (by GaryJ):

 Replying to [comment:1 Rarst]:
 > Of course if file header has package already repeating it in class is
 just redundant.

 As noted in (draft) PSR-5, and seen in general documentation generators,
 the `@package` tag is NOT inherited by classes from the file-level
 DocBlocks. Functions inherit it, but not classes, so `@package` is still
 needed on class DocBlocks, even if the class is the only thing in a file
 (as it should be) and the file has a matching `@package` tag as well.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/27200#comment:4>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list