[wp-trac] [WordPress Trac] #25229: Add Inline Docs for Hooks

[WordPress Trac]

#25229: Add Inline Docs for Hooks
----------------------------+------------------
 Reporter:  rzen            |       Owner:
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  3.7
Component:  Inline Docs     |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |
----------------------------+------------------

Comment (by Faison):

 I have a couple of questions regarding the diff I submitted.

 First, regarding the `nav_menu_link_attributes` filter: the first argument
 is an array that I feel could benefit from having it's structure
 documented similar to the way Argument arrays are supposed to be
 documented. So I documented it like it was an Arguments array, but I
 wanted to know if that is how it should be done?

 Second, I wanted to know if I'm documenting the `$args` parameter
 properly, with a `@see` pointing towards the originating function.

 And last, do we have a standard for how to document a parameter that is a
 field in an object? For example, some actions  have a parameter like
 `$foo->bar`, so do we document it as `@param type $foo->bar description.`
 ?

 Thanks for all the help,
 Faison

--
Ticket URL: <http://core.trac.wordpress.org/ticket/25229#comment:24>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software