WordPress.org
Get WordPress

Make WordPress Core

Opened 13 years ago

Closed 13 years ago

#25388 closed defect (bug) (fixed)

Functional Docs: wp-includes/comment-template.php

Reported by: DrewAPicture Owned by: DrewAPicture
Priority: normal Milestone: 3.7
Component: Inline Docs Version:
Severity: normal Keywords: has-patch
Cc: Focuses:

Description

Attached patch cleans up phpdocs throughout comment-template.php, excluding the Walker_Comment class.

Attachments (7)

25388.diff​ (38.2 KB ) - added by DrewAPicture 13 years ago.
25388.2.diff​ (38.5 KB ) - added by DrewAPicture 13 years ago.
2nd-pass
25388.3.diff​ (38.7 KB ) - added by DrewAPicture 13 years ago.
Third pass (current comment/post cleanup, wrapping defaults, mostly)
25388-comment_form.diff​ (2.2 KB ) - added by DrewAPicture 13 years ago.
Arg docs for comment_form()
25388-comment_form.2.diff​ (2.3 KB ) - added by DrewAPicture 13 years ago.
Language tweaks
25388-walker_comment.diff​ (5.1 KB ) - added by DrewAPicture 13 years ago.
Walker_Comment docs
25388-walker_comment.2.diff​ (5.3 KB ) - added by DrewAPicture 13 years ago.
Second pass

Download all attachments as: .zip

Change History (11)

@DrewAPicture
13 years ago

@DrewAPicture
13 years ago

2nd-pass

@DrewAPicture
13 years ago

Third pass (current comment/post cleanup, wrapping defaults, mostly)

#1 @DrewAPicture
13 years ago

In 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.

@DrewAPicture
13 years ago

Arg docs for comment_form()

@DrewAPicture
13 years ago

Language tweaks

#2 @DrewAPicture
13 years ago

In 25573:

Improve inline documentation of arguments for comment_form().

See #25388.

#3 @DrewAPicture
13 years ago

In 25575:

Inline documentation for comment_form() argument defaults missed in [25573].

See #25388.

@DrewAPicture
13 years ago

Walker_Comment docs

@DrewAPicture
13 years ago

Second pass

#4 @DrewAPicture
13 years ago

  • Owner set to DrewAPicture
  • Resolution → fixed
  • Status new → closed

In 25588:

Inline documentation for the Walker_Comment class in wp-includes/comment-template.php

Fixes #25388.

Note: See TracTickets for help on using tickets.