[wp-trac] [WordPress Trac] #20588: phpdoc references to filters/actions

[WordPress Trac]

#20588: phpdoc references to filters/actions
-----------------------------+--------------------------------------
 Reporter:  bananastalktome  |      Owner:
     Type:  enhancement      |     Status:  new
 Priority:  normal           |  Milestone:  Awaiting Review
Component:  Inline Docs      |    Version:
 Severity:  minor            |   Keywords:  dev-feedback 2nd-opinion
-----------------------------+--------------------------------------
 I noticed that many of the {{{apply_filters}}} and {{{do_action}}} calls
 used in functions throughout the codebase are not reflected in the
 functions doc description. I was not sure if it was a worthwhile task of
 going through and adding these, or whether this was not really desirable.

 If so, is there any preferred syntax by which these should be documented?

 Is, for example, this snippet for {{{do_action}}} hooks taken from
 {{{do_feed()}}} ({{{@uses do_action() Calls 'do_feed_$feed' hook, if a
 hook exists for the feed.}}}) and, for {{{apply_filters}}}, this snippet
 from {{{wp_ext2type()}}} ({{{@uses apply_filters() Calls 'ext2type' hook
 on default supported types.}}}) acceptable template examples?

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