WordPress.org

Make WordPress Core

Opened 11 years ago

Closed 11 years ago

#5635 closed enhancement (fixed)

PHPdoc effort for classes.php

Reported by: darkdragon Owned by:
Milestone: 2.7 Priority: low
Severity: trivial Version:
Component: Optimization Keywords: phpdoc has-patch
Focuses: Cc:

Description

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

Needed to complete:

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

Attachments (2)

classes.phpdoc.r6597.diff (18.8 KB) - added by darkdragon 11 years ago.
Incomplete documentation for classes.php based off of r6597
5635.r8889.diff (24.8 KB) - added by jacobsantos 11 years ago.
Complete inline documentation for classes.php based off of r8889

Download all attachments as: .zip

Change History (7)

@darkdragon
11 years ago

Incomplete documentation for classes.php based off of r6597

#1 @darkdragon
11 years ago

  • Milestone changed from 2.6 to 2.7

Eh. Probably complete this during the summer. Patch is available for anyone who wants to take ownership of this file. Template covers everything that needs to be completed.

#2 @darkdragon
11 years ago

Remember, the revision has to match before you can apply the patch, unless there weren't too many changes. Checkout r6597, apply patch, and then update repository.

#3 @santosj
11 years ago

  • Milestone changed from 2.7 to 2.9

Yeah. There are a lot of places where inline documentation is needed and it isn't as quick as some other files. I won't be doing this until the end, because the file has difficult to understand sections of code which need more thought.

#4 @jacobsantos
11 years ago

  • Milestone changed from 2.9 to 2.7

@jacobsantos
11 years ago

Complete inline documentation for classes.php based off of r8889

#5 @ryan
11 years ago

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

(In [8900]) phpdoc for classes.php from jacobsantos. fixes #5635

Note: See TracTickets for help on using tickets.