[wp-meta] [Making WordPress.org] #1251: DevHub: Add support for inline @see and @link tags in return descriptions
Making WordPress.org
noreply at wordpress.org
Sun Sep 27 17:30:24 UTC 2015
#1251: DevHub: Add support for inline @see and @link tags in return descriptions
-------------------------+-------------------------------------
Reporter: DrewAPicture | Owner:
Type: enhancement | Status: new
Priority: normal | Component: developer.wordpress.org
Keywords: has-patch |
-------------------------+-------------------------------------
Currently, return descriptions are late-escaped on output with
`esc_html()` which doesn't allow for inline `@see` and `@link` tags to
display as expected. The links are parsed, but the respective `{@link` and
`}` parts are still present on output.
I spoke with @coffee2code about applying the `make_doclink_clickable()`
method on return descriptions instead and he agrees that should be fine.
As we move more and more toward adding extended documentation to
references via the Explanations module, linking parameter and return
descriptions to external resources is becoming more common.
--
Ticket URL: <https://meta.trac.wordpress.org/ticket/1251>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org
More information about the wp-meta
mailing list