WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

#5639 closed enhancement (fixed)

PHPdoc effort for functions.php

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

Download all attachments as: .zip

Change History (19)

@darkdragon7 years ago

Incomplete documentation for functions.php based off of r6597

comment:1 @darkdragon7 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.

@jacobsantos7 years ago

Partial file completion of functions.php based off of r8088

comment:2 @westi7 years ago

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

comment:3 @westi7 years ago

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

@jacobsantos7 years ago

PHPdoc inline documentation for functions.php based off of r8211

comment:4 @jacobsantos7 years ago

More functions are completed in the file.

comment:5 @ryan7 years ago

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

@jacobsantos7 years ago

PHPdoc inline documentation for functions.php based off of r8259

comment:6 @jacobsantos7 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.

comment:7 @ryan7 years ago

  • Milestone changed from 2.9 to 2.7

comment:8 @ryan7 years ago

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

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

@jacobsantos7 years ago

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

@jacobsantos7 years ago

Completes Functions.php inline documentation for trunk (r8605)

comment:9 @jacobsantos7 years ago

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

comment:10 @westi7 years ago

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

@jacobsantos7 years ago

Complete functions.php file based off of r8607.

comment:11 @jacobsantos7 years ago

Patch completes all of the functions in functions.php.

comment:12 @westi7 years ago

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