WordPress.org

Make WordPress Core

Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#5528 closed enhancement (fixed)

PHPdoc effort for comment-template.php

Reported by: darkdragon Owned by:
Milestone: 2.5 Priority: low
Severity: minor Version:
Component: Optimization Keywords: phpdoc documentation has-patch
Focuses: Cc:

Description

Based off patch by Pita in #2648. Applies and finishes that patch for the new wp-includes/comment-template.php.

PHPdoc inline documentation effort includes:

  • @since version information
  • Short and long (where applicable) descriptions
  • Parameter documentation
  • Return documentation

Attachments (1)

comment-template.phpdoc.r6494.diff (20.9 KB) - added by darkdragon 11 years ago.
Complete phpdoc documentation for comment-template.php based off of r6494

Download all attachments as: .zip

Change History (5)

#1 @darkdragon
11 years ago

Only two functions are missing long descriptions (or that I think should have long descriptions). I'll probably finish those up and upload a new patch.

Most of the patch used Pita's patch in #2648.

@darkdragon
11 years ago

Complete phpdoc documentation for comment-template.php based off of r6494

#2 @darkdragon
11 years ago

Latest patch completes all of the documentation in the file.

#3 @ryan
11 years ago

  • Resolution set to fixed
  • Status changed from new to closed

(In [6495]) phpdoc for comment-template.php from darkdragon. fixes #5528

#4 @santosj
11 years ago

  • Milestone changed from 2.5 to 2.4
Note: See TracTickets for help on using tickets.