[wp-trac] [WordPress Trac] #20495: Update phpDoc to reflect post id or object is valid

[WordPress Trac]

#20495: Update phpDoc to reflect post id or object is valid
--------------------------+-----------------------------
 Reporter:  coffee2code   |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Future Release
Component:  Inline Docs   |     Version:  3.3.1
 Severity:  trivial       |  Resolution:
 Keywords:  needs-patch   |
--------------------------+-----------------------------

Comment (by DrewAPicture):

 In [changeset:"25567"]:
 {{{
 #!CommitTicketReference repository="" revision="25567"
 Inline documentation improvements for wp-includes/comment-template.php.

 Changes include:
 - Existing phpdoc block improvements
 - Inclusion of defaults for optional parameters
 - Hash-notated argument arrays
 - Removal of unnecessary or redundant tagging.

 Also standardization of int|WP_Post function parameters.

 These changes clear the way toward less redundancy for hook docs in a
 future ticket.

 Still left: Fully documented arguments in `comment_form()` and a pass
 through Walker_Comment.

 See #20495. See #25388.
 }}}

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