Make WordPress Core

Opened 19 years ago

Closed 18 years ago

#5639 closed enhancement (fixed)

PHPdoc effort for functions.php

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

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 (7)

functions.phpdoc.r6597.diff (30.4 KB ) - added by darkdragon 19 years ago.
Incomplete documentation for functions.php based off of r6597
functions.phpdoc.r8088.diff (20.8 KB ) - added by jacobsantos 18 years ago.
Partial file completion of functions.php based off of r8088
functions.phpdoc.r8211.diff (12.0 KB ) - added by jacobsantos 18 years ago.
PHPdoc inline documentation for functions.php based off of r8211
functions.phpdoc.r8259.diff (20.0 KB ) - added by jacobsantos 18 years ago.
PHPdoc inline documentation for functions.php based off of r8259
5639.r8605.2.6.diff (26.3 KB ) - added by jacobsantos 18 years ago.
Completes Functions.php inline documentation for 2.6 branch (r8605)
5639.r8605.diff (19.1 KB ) - added by jacobsantos 18 years ago.
Completes Functions.php inline documentation for trunk (r8605)
5639.r8607.diff (672 bytes ) - added by jacobsantos 18 years ago.
Complete functions.php file based off of r8607.

Download all attachments as: .zip

Change History (19)

@darkdragon
19 years ago

Incomplete documentation for functions.php based off of r6597

#1 @darkdragon
19 years ago

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.

@jacobsantos
18 years ago

Partial file completion of functions.php based off of r8088

#2 @westi
18 years ago

  • Milestone 2.72.6
  • Owner changed from anonymous to westi
  • Status newassigned

#3 @westi
18 years ago

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

@jacobsantos
18 years ago

PHPdoc inline documentation for functions.php based off of r8211

#4 @jacobsantos
18 years ago

More functions are completed in the file.

#5 @ryan
18 years ago

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

@jacobsantos
18 years ago

PHPdoc inline documentation for functions.php based off of r8259

#6 @jacobsantos
18 years ago

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.

#7 @ryan
18 years ago

  • Milestone 2.92.7

#8 @ryan
18 years ago

  • Resolutionfixed
  • Status assignedclosed

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

@jacobsantos
18 years ago

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

@jacobsantos
18 years ago

Completes Functions.php inline documentation for trunk (r8605)

#9 @jacobsantos
18 years ago

  • Resolution fixed
  • Status closedreopened

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.

#10 @westi
18 years ago

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

@jacobsantos
18 years ago

Complete functions.php file based off of r8607.

#11 @jacobsantos
18 years ago

Patch completes all of the functions in functions.php.

#12 @westi
18 years ago

  • Resolutionfixed
  • Status reopenedclosed

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

Note: See TracTickets for help on using tickets.