[wp-trac] [WordPress Trac] #31340: Use of the @subpackage tag in documentation

[WordPress Trac]

#31340: Use of the @subpackage tag in documentation
--------------------------+----------------------
 Reporter:  henry.wright  |       Owner:
     Type:  defect (bug)  |      Status:  closed
 Priority:  normal        |   Milestone:
Component:  General       |     Version:
 Severity:  normal        |  Resolution:  invalid
 Keywords:                |     Focuses:  docs
--------------------------+----------------------
Changes (by DrewAPicture):

 * status:  new => closed
 * resolution:   => invalid
 * milestone:  Awaiting Review =>


Comment:

 Hi Henry,

 I would encourage you to use or not use `@subpackage` tags at your
 discretion.

 Part of the issue we have in core is that our parser currently only
 supports phpDocumentor 1.0 in which name-spaced `@package` tags are not
 supported and `@subpackage` tags are not deprecated. Thus the note in the
 WordPress documentation standards.

 When we opted to write our standard, we heavily leaned toward historical
 precedence of the code base, and that's something that we've maintained
 through today. The benefit of approaching change in this way is that
 later, when the PSR-5 recommendations are finalized and approved, it will
 be that much simpler for us to adjust to those new recommendations.

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