[wp-meta] [Making WordPress.org] #2367: Allow @see notation to reference classes
Making WordPress.org
noreply at wordpress.org
Mon Jan 9 19:09:33 UTC 2017
#2367: Allow @see notation to reference classes
---------------------------+-----------------
Reporter: coffee2code | Owner:
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: Developer Hub | Keywords:
---------------------------+-----------------
The `{@see ???}` notation currently supports referencing functions (e.g.
`{@see get_posts()}`), class methods (e.g. `{@see WP_Query::get_posts()}`,
and hooks (e.g. `{@see 'body_class'}`). However, it does not support
referencing classes, which in its defense, it didn't need to do because
core had never made use of such a reference.
One such an instance was recently introduced into core, which currently
incorrectly links `{@see Requests_Response}` as if it were a function
(e.g.
`https://developer.wordpress.org/reference/functions/Requests_Response`).
See:
https://developer.wordpress.org/reference/classes/requests_exception_http_unknown/__construct
`link_internal_element()` should be extended to support references to
classes.
The change will likely see more usage in explanations and handbooks, where
the syntax is also supported.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/2367>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list