[wp-meta] [Making WordPress.org] #1498: Developer code reference should include warnings for "@access private" functions

Making WordPress.org noreply at wordpress.org
Fri Jan 29 19:48:45 UTC 2016


#1498: Developer code reference should include warnings for "@access private"
functions
--------------------------+----------------------------------------------
  Reporter:  netweb       |      Owner:  DrewAPicture
      Type:  enhancement  |     Status:  accepted
  Priority:  normal       |  Component:  developer.wordpress.org
Resolution:               |   Keywords:  has-patch has-screenshots commit
--------------------------+----------------------------------------------

Comment (by drewapicture):

 In [changeset:"2431"]:
 {{{
 #!CommitTicketReference repository="" revision="2431"
 DevHub: Introduce a new template tag, `get_private_access_message()`,
 which generates a message for standalone functions or hooks marked with a
 private `@access` tag in their respective Docblocks.

 If the Handbook plugin is available, more specifically if the
 `WPorg_Handbook_Callout_Boxes` class is available, the message markup is
 generated as an 'alert'-type callout box. Otherwise, fall-back markup and
 styles are applied to the message.

 If an alternative function is referenced via an `@see` tag in the function
 or hook DocBlock, make a good-faith effort to try to link to the reference
 page for that element as an alternative within the access message text.

 See #1498.
 }}}

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/1498#comment:7>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list