Opened 8 years ago
Closed 8 years ago
#2367 closed enhancement (fixed)
Allow @see notation to reference classes
Reported by: | coffee2code | Owned by: | coffee2code |
---|---|---|---|
Milestone: | Priority: | normal | |
Component: | Developer Hub | Keywords: | |
Cc: |
Description
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.
In 4617: