Ticket #5635 (closed enhancement: fixed)

Opened 11 months ago

Last modified 2 months ago

PHPdoc effort for classes.php

Reported by: darkdragon Assigned to: anonymous
Priority: low Milestone: 2.7
Component: Optimization Version:
Severity: trivial Keywords: phpdoc has-patch
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

classes.phpdoc.r6597.diff (18.8 kB) - added by darkdragon on 01/11/08 03:00:59.
Incomplete documentation for classes.php based off of r6597
5635.r8889.diff (24.8 kB) - added by jacobsantos on 09/15/08 01:40:09.
Complete inline documentation for classes.php based off of r8889

Change History

01/11/08 03:00:59 changed by darkdragon

  • attachment classes.phpdoc.r6597.diff added.

Incomplete documentation for classes.php based off of r6597

01/11/08 03:02:05 changed by darkdragon

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

01/11/08 03:03:34 changed by darkdragon

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.

07/15/08 21:21:11 changed by santosj

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

09/15/08 00:55:25 changed by jacobsantos

  • milestone changed from 2.9 to 2.7.

09/15/08 01:40:09 changed by jacobsantos

  • attachment 5635.r8889.diff added.

Complete inline documentation for classes.php based off of r8889

09/16/08 00:37:06 changed by ryan

  • status changed from new to closed.
  • resolution set to fixed.

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