Ticket #5528 (closed enhancement: fixed)

Opened 4 years ago

Last modified 4 years ago

PHPdoc effort for comment-template.php

Reported by: darkdragon Owned by: anonymous
Priority: low Milestone: 2.5
Component: Optimization Version:
Severity: minor Keywords: phpdoc documentation has-patch
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

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

Change History

comment:1   darkdragon — 4 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 — 4 years ago

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

comment:2   darkdragon — 4 years ago

Latest patch completes all of the documentation in the file.

comment:3   ryan — 4 years ago

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

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

comment:4   santosj — 4 years ago

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