Ticket #5634 (closed enhancement: fixed)

Opened 4 years ago

Last modified 3 years ago

Inline Documentation for category-template.php

Reported by: darkdragon Owned by: jacobsantos
Priority: low Milestone: 2.7
Component: General Version:
Severity: trivial Keywords: phpdoc has-patch commit
Cc:

Description

PHPdoc effort for wp-includes/category-template.php seeks to complete phpdoc style inline documentation.

Needed to complete:

  1. Short and Long Descriptions.
  2. @since version info
  3. parameter type and description.
  4. return type and description.

Attachments

category-template.phpdoc.r6597.diff Download (8.4 KB) - added by darkdragon 4 years ago.
Incomplete documentation for category-template.php based off of r6597
5634.r8786.diff Download (10.7 KB) - added by jacobsantos 3 years ago.
Updated patch for r8786.
5634.r8947.diff Download (10.7 KB) - added by jacobsantos 3 years ago.
category-template.php skeleton inline documentation based off of r8947
5634.r8970.diff Download (19.1 KB) - added by jacobsantos 3 years ago.
Complete inline documentation for category-template.php based off of r8970

Change History

darkdragon — 4 years ago

Incomplete documentation for category-template.php based off of r6597

comment:1   santosj — 4 years ago

  • Owner changed from anonymous to jacobsantos
  • Milestone changed from 2.9 to 2.7

I have a patch for this, which starts and completes a lot of the documentation. I should have this completed before 2.7 is released.

jacobsantos — 3 years ago

Updated patch for r8786.

comment:2   jacobsantos — 3 years ago

  • Priority changed from normal to low
  • Severity changed from normal to trivial

comment:3   jacobsantos — 3 years ago

  • Summary changed from PHPdoc effort for category-template.php to Inline Documentation for category-template.php

jacobsantos — 3 years ago

category-template.php skeleton inline documentation based off of r8947

comment:4   jacobsantos — 3 years ago

Skeleton inline documentation for category-template.php. The patch is based off of r8947.

jacobsantos — 3 years ago

Complete inline documentation for category-template.php based off of r8970

comment:5   jacobsantos — 3 years ago

  • Keywords commit added

Has complete inline documentation.

comment:6   azaozz — 3 years ago

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

(In [8975]) Complete inline documentation for category-template.php, props jacobsantos, fixes #5634

Note: See TracTickets for help on using tickets.