[wp-trac] [WordPress Trac] #16809: Inline Documentation Standard for Filters

[WordPress Trac]

#16809: Inline Documentation Standard for Filters
-----------------------------+-----------------------------
 Reporter:  CharlesClarkson  |      Owner:
     Type:  enhancement      |     Status:  new
 Priority:  normal           |  Milestone:  Awaiting Review
Component:  Inline Docs      |    Version:  3.1
 Severity:  trivial          |   Keywords:
-----------------------------+-----------------------------
 I was hoping to get some insight on how to document filters as they are
 applied in a function. I'm referring to the use of the apply_filter()
 function inside a WordPress function, not for the use of the add_filter()
 function.

 I thought to use something like one of these, but wanted some input on
 whether either was complete enough.

 {{{
  * @uses apply_filters() for 'wp_admin_bar_class' providing 'WP_Admin_Bar'
 as the default class.

  * @note Adds the 'wp_admin_bar_class' filter to allow changing the
 default 'WP_Admin_Bar' class.

  * @link
 http://codex.wordpress.org/index.php?title=Plugin_API/Filter_Reference/wp_admin_bar_class
 }}}
 (Note: The link doesn't work yet. it is established from the
 [http://codex.wordpress.org/Plugin_API/Filter_Reference#Admin_Bar Plugin
 API/Filter Reference])

 I tend to look at inline docs as I use them (to update the codex and to
 research solutions) and that may not fit with other uses. I would rather
 not have to go back (too many times) because the my standard was useless
 to other users.


 Thanks,

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