[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 DrewAPicture):

 @mordauk:

 [attachment:comment-php.patch] — Per the
 [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/ inline docs standards]:
 * Need a period on the short description
 * A blank line after the `@since` line
 * A period at the end of the description on the `@param` line.

 [attachment:export-php.patch]:
 * Describe when the action fires and where. "Bottom of export filters
 form", should be more like "Fires after the export filters form"
 * Periods after short descriptions
 * Blank line after `@since` lines
 * `@since` value should follow the 3-digit, x.x.x style

 General comment: Clarity is preferred over succinctness.

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