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

Making WordPress.org noreply at wordpress.org
Mon Oct 9 17:53:57 UTC 2017

#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 mnelson4):

 > @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.

 Oh ok, although that's not exactly what I was thinking. I was suggesting
 that the contents of the PHP doc could remain like `@see
 WP_Http::request()`, but when your script is parsing that and generating
 the HTML from it to display on developer.wordpress.org, it would be great
 if instead of just showing that exact string, it would basically go "Hey,
 this PHP doc comment is referencing another function. I know the link to
 that function/class is on developer.wordpress.org! So I'll provide a link
 to it, instead of just getting users to search for it themselves." ie,
 somehow translate the function/class/method/hook into the URL where that
 thing is documented on developer.wordpress.org, and then generate a link
 to it.

 Does that make sense? I think it would be good but it's probably dreaming.
 And sorry, where is the code that does this parsing?

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

More information about the wp-meta mailing list