[wp-trac] [WordPress Trac] #36921: Allow hooks referenced inline in Docblocks to be linked

WordPress Trac noreply at wordpress.org
Mon May 23 17:00:09 UTC 2016


#36921: Allow hooks referenced inline in Docblocks to be linked
----------------------------+-----------------
 Reporter:  DrewAPicture    |      Owner:
     Type:  task (blessed)  |     Status:  new
 Priority:  normal          |  Milestone:  4.6
Component:  General         |    Version:
 Severity:  normal          |   Keywords:
  Focuses:  docs            |
----------------------------+-----------------
 phpDocumentor doesn't support WordPress hooks out of the box. Our answer
 to this problem is using specially-formatted inline `@see` tags in
 DocBlocks which the [https://github.com/WordPress/phpdoc-parser parser]
 recognizes at hooks and parses them into internal Code Reference links.

 Many hooks are already given this treatment throughout core, but there are
 lots of others that aren't.

 Side note: We used to implement inline `@see` links for all functions,
 classes, and methods, but following #meta1483, known functions, classes,
 and methods are auto-linked which has freed up the need to handle for
 those cases within DocBlocks themselves.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/36921>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list