Ticket #5639 (closed enhancement: fixed)

Opened 8 months ago

Last modified 3 weeks ago

PHPdoc effort for functions.php

Reported by: darkdragon Assigned to: westi
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/functions.php.

Needed to complete:

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

Attachments

functions.phpdoc.r6597.diff (30.4 kB) - added by darkdragon on 01/11/08 03:18:54.
Incomplete documentation for functions.php based off of r6597
functions.phpdoc.r8088.diff (20.8 kB) - added by jacobsantos on 06/15/08 01:58:06.
Partial file completion of functions.php based off of r8088
functions.phpdoc.r8211.diff (12.0 kB) - added by jacobsantos on 06/28/08 20:19:20.
PHPdoc inline documentation for functions.php based off of r8211
functions.phpdoc.r8259.diff (20.0 kB) - added by jacobsantos on 07/05/08 19:09:11.
PHPdoc inline documentation for functions.php based off of r8259
5639.r8605.2.6.diff (26.3 kB) - added by jacobsantos on 08/10/08 16:28:44.
Completes Functions.php inline documentation for 2.6 branch (r8605)
5639.r8605.diff (19.1 kB) - added by jacobsantos on 08/10/08 16:29:16.
Completes Functions.php inline documentation for trunk (r8605)
5639.r8607.diff (0.7 kB) - added by jacobsantos on 08/10/08 20:10:14.
Complete functions.php file based off of r8607.

Change History

01/11/08 03:18:54 changed by darkdragon

  • attachment functions.phpdoc.r6597.diff added.

Incomplete documentation for functions.php based off of r6597

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

Will complete in the Summer, if no one else finishes this file.

Anyone looking to take ownership can apply the patch which has templates for most of the functions to revision r6597, then update.

06/15/08 01:58:06 changed by jacobsantos

  • attachment functions.phpdoc.r8088.diff added.

Partial file completion of functions.php based off of r8088

06/15/08 09:24:03 changed by westi

  • owner changed from anonymous to westi.
  • status changed from new to assigned.
  • milestone changed from 2.7 to 2.6.

06/15/08 09:38:32 changed by westi

(In [8092]) PHPDoc updates for functions.php. See #5639 props jacobsantos.

06/28/08 20:19:20 changed by jacobsantos

  • attachment functions.phpdoc.r8211.diff added.

PHPdoc inline documentation for functions.php based off of r8211

06/28/08 20:22:58 changed by jacobsantos

More functions are completed in the file.

06/30/08 03:23:45 changed by ryan

(In [8215]) phpdoc updates from jacobsantos. see #5639

07/05/08 19:09:11 changed by jacobsantos

  • attachment functions.phpdoc.r8259.diff added.

PHPdoc inline documentation for functions.php based off of r8259

08/09/08 03:49:20 changed by jacobsantos

functions.phpdoc.r8259.diff patch is ready to go with a few things to consider:

  1. I also include style formatting fixes, that might already have been committed already.
  2. I remove a global from the get_alloptions() function that doesn't appear to be used within the function.

08/09/08 04:51:43 changed by ryan

  • milestone changed from 2.9 to 2.7.

08/09/08 04:51:52 changed by ryan

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

(In [8598]) phpdoc for functions.php. Props jacobsantos. fixes #5639

08/10/08 16:28:44 changed by jacobsantos

  • attachment 5639.r8605.2.6.diff added.

Completes Functions.php inline documentation for 2.6 branch (r8605)

08/10/08 16:29:16 changed by jacobsantos

  • attachment 5639.r8605.diff added.

Completes Functions.php inline documentation for trunk (r8605)

08/10/08 16:33:58 changed by jacobsantos

  • status changed from closed to reopened.
  • resolution deleted.

Patches, complete functions.php for 2.6 and Trunk. Well, there is do_enclosed() function left, but I have no idea what it is for.

08/10/08 16:45:51 changed by westi

(In [8606]) phpdoc for general functions. See #5639 props jacobsantos.

08/10/08 20:10:14 changed by jacobsantos

  • attachment 5639.r8607.diff added.

Complete functions.php file based off of r8607.

08/10/08 20:10:39 changed by jacobsantos

Patch completes all of the functions in functions.php.

08/10/08 20:31:49 changed by westi

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

(In [8608]) Final phpdoc for functions. Fixes #5639 props jacobsantos.