Opened 5 years ago

Closed 5 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:

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 5 years ago.
Incomplete documentation for functions.php based off of r6597
functions.phpdoc.r8088.diff (20.8 KB) - added by jacobsantos 5 years ago.
Partial file completion of functions.php based off of r8088
functions.phpdoc.r8211.diff (12.0 KB) - added by jacobsantos 5 years ago.
PHPdoc inline documentation for functions.php based off of r8211
functions.phpdoc.r8259.diff (20.0 KB) - added by jacobsantos 5 years ago.
PHPdoc inline documentation for functions.php based off of r8259
5639.r8605.2.6.diff (26.3 KB) - added by jacobsantos 5 years ago.
Completes Functions.php inline documentation for 2.6 branch (r8605)
5639.r8605.diff (19.1 KB) - added by jacobsantos 5 years ago.
Completes Functions.php inline documentation for trunk (r8605)
5639.r8607.diff (672 bytes) - added by jacobsantos 5 years ago.
Complete functions.php file based off of r8607.

Download all attachments as: .zip

Change History (19)

Incomplete documentation for functions.php based off of r6597

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.

Partial file completion of functions.php based off of r8088

  • Milestone changed from 2.7 to 2.6
  • Owner changed from anonymous to westi
  • Status changed from new to assigned

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

PHPdoc inline documentation for functions.php based off of r8211

More functions are completed in the file.

comment:5   ryan5 years ago

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

PHPdoc inline documentation for functions.php based off of r8259

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.

comment:7   ryan5 years ago

  • Milestone changed from 2.9 to 2.7

comment:8   ryan5 years ago

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

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

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

Completes Functions.php inline documentation for trunk (r8605)

  • Resolution fixed deleted
  • Status changed from closed to reopened

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.

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

Complete functions.php file based off of r8607.

Patch completes all of the functions in functions.php.

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

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

Note: See TracTickets for help on using tickets.