[wp-trac] [WordPress Trac] #41452: Remove @access tags from core DocBlocks

WordPress Trac noreply at wordpress.org
Wed Jul 26 23:43:27 UTC 2017


#41452: Remove @access tags from core DocBlocks
----------------------------+-----------------------
 Reporter:  DrewAPicture    |      Owner:
     Type:  task (blessed)  |     Status:  new
 Priority:  normal          |  Milestone:  4.9
Component:  General         |    Version:
 Severity:  normal          |   Keywords:  has-patch
  Focuses:  docs            |
----------------------------+-----------------------
 Per discussion in #core-docs last week, we're finally to the point where
 we can remove `@access` notations from DocBlocks throughout core, with a
 few exceptions:

 * Any standalone core functions marked private
 * Any classes marked private (such as the List Table classes, for
 instance)

 The [https://github.com/WordPress/phpdoc-parser parser] that builds the
 [https://developer.wordpress.org/reference/ Code Reference] already
 references actual method visibility as derived with phpDocumentor, meaning
 that output will be unchanged following the removals.

 In terms of anything marked private (including the aforementioned
 exceptions) the Code Reference theme already handles displaying a
 specially-designed callout box.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/41452>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list