[wp-trac] [WordPress Trac] #25658: Handle duplicate hooks in inline documentation

[WordPress Trac]

#25658: Handle duplicate hooks in inline documentation
-------------------------+-----------------
 Reporter:  nacin        |      Owner:
     Type:  enhancement  |     Status:  new
 Priority:  normal       |  Milestone:  3.7
Component:  Inline Docs  |    Version:
 Severity:  normal       |   Keywords:
-------------------------+-----------------
 It looks like inline documentation efforts for hooks will continue well
 into 3.8, so rather than being able to rely on all hooks being documented
 and developer.wordpress.org being up and running, we should replace
 `//duplicate_hook` with something that is more human-parseable for
 release.

 My suggestion: `/** This hook is documented in {file} */`. Alternatively,
 replace 'hook' with 'action' or 'filter', respectively.

 Perhaps in the future, it would be a link to the hook's documentation on
 developer.wordpress.org instead (or in addition to).

 There's only 40 duplicate hooks, and it's pretty easy to generate a list
 of them with something like `ack -A 1 duplicate_hook`, which will return
 the line that follows the match. From there, we could look for each hook
 and look at the line before it, until we return `*/`, rather than the
 duplicate_hook comment. Then we would know where it is located. Or they
 could use a global project search in their editor. I imagine it would take
 someone about 20-30 minutes to do the whole thing?

--
Ticket URL: <http://core.trac.wordpress.org/ticket/25658>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software