[wp-meta] [Making WordPress.org] #3165: Expose top-level @see tag contents in code reference pages

[Making WordPress.org]

#3165: Expose top-level @see tag contents in code reference pages
---------------------------+------------------
 Reporter:  DrewAPicture   |       Owner:
     Type:  enhancement    |      Status:  new
 Priority:  normal         |   Milestone:
Component:  Developer Hub  |  Resolution:
 Keywords:  needs-patch    |
---------------------------+------------------

Comment (by DrewAPicture):

 Replying to [comment:3 mnelson4]:
 > > I'm thinking maybe we should just expose the contents of the top-level
 @see tags at the end of the description, rather than as part of the
 explanation (since it's parsed).
 >
 > Yeah I think that would be a great start; it would be ideal if whatever
 was after `@see` was actually a link to the relevant docs page.
 >
 > e.g., a PHPDoc of `@see WP_Http::request() For additional information on
 default arguments.` would become the HTML `See <a
 href="https://developer.wordpress.org/reference/classes/wp_http/request/">WP_HTTP::request()</a>
 For additional information on default arguments.` on
 developer.wordpress.org.
 >
 > But I suspect making that a link might be tricky, so just starting with
 an easier change would be good.

 `@see` is actually for referencing function, class, method, or hooks. If
 you're wanting to reference an external link like that, the best option is
 to use an inline `@link` tag, which !DevHub is already setup to handle.

 For an example of how that works in practice, check out the
 [https://developer.wordpress.org/reference/functions/register_meta/#changelog
 reference changleog] and DocBlock for `register_meta()`.

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