WordPress.org

Make WordPress Core

Opened 11 years ago

Closed 11 years ago

Last modified 9 years ago

#5640 closed enhancement (fixed)

Inline Documentation for general-template.php

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

Description

PHPdoc effort seeks to complete phpdoc style inline documentation for wp-includes/general-template.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)

general-template.phpdoc.r6597.diff (19.0 KB) - added by darkdragon 11 years ago.
Incomplete documentation for general-template.php based off of r6597
5640.r8681.diff (661 bytes) - added by jacobsantos 11 years ago.
Inline Documentation for wp_meta() based off of r8681
5640.r8786.diff (17.9 KB) - added by jacobsantos 11 years ago.
Updated patch based off of r8786
5640.r8831.diff (21.7 KB) - added by jacobsantos 11 years ago.
Corrections to trunk, based off of r8831
5640.r8852.diff (9.9 KB) - added by jacobsantos 11 years ago.
Completes with three functions left for inline documentation based off of r8852
5640.r8855.diff (10.7 KB) - added by jacobsantos 11 years ago.
Two functions left to document, based off of r8855.
5640.r8857.diff (15.5 KB) - added by jacobsantos 11 years ago.
Finished file inline documentation based off of r8857

Download all attachments as: .zip

Change History (20)

@darkdragon
11 years ago

Incomplete documentation for general-template.php based off of r6597

@jacobsantos
11 years ago

Inline Documentation for wp_meta() based off of r8681

@jacobsantos
11 years ago

Updated patch based off of r8786

#1 @jacobsantos
11 years ago

  • Milestone changed from 2.9 to 2.7

#2 @jacobsantos
11 years ago

  • Summary changed from PHPdoc effort for general-template.php to Inline Documentation for general-template.php

#3 @westi
11 years ago

(In [8822]) phpdoc for general template functions see #5640 props jacobsantos.

#4 @westi
11 years ago

  • Owner changed from anonymous to westi
  • Status changed from new to assigned

Updating these now myself.

#5 @jacobsantos
11 years ago

Do you mean documenting the entire file, or do you mean just the patches? I'm working on the easy functions and will be submitting a patch. I don't think I've done any more general-template.php functions. The *-template.php functions are pretty easy now that I think about it, I can't figure why I haven't done them sooner.

#6 @westi
11 years ago

documenting this file right now

#7 @westi
11 years ago

(In [8823]) Update the General Template phpdoc see #5640.

#8 @westi
11 years ago

That gets the file 80% complete.

Patches for the remaining functions and corrections of what I have already done welcome.

#9 @jacobsantos
11 years ago

  • Keywords needs-patch added; has-patch removed

Corrections incoming tonight, going to seriously conflict with what I have now.

I use "Display" instead of "Outputs" or "Echos". I use "Retrieve" instead of "Returns".

Awesome so far!

@jacobsantos
11 years ago

Corrections to trunk, based off of r8831

#10 @westi
11 years ago

(In [8835]) General Template function phpdoc updates. See #5640 props jacobsantos.

@jacobsantos
11 years ago

Completes with three functions left for inline documentation based off of r8852

@jacobsantos
11 years ago

Two functions left to document, based off of r8855.

@jacobsantos
11 years ago

Finished file inline documentation based off of r8857

#11 @jacobsantos
11 years ago

  • Keywords has-patch commit added; needs-patch removed

Latest patch completes inline documentation.

#12 @azaozz
11 years ago

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

(In [8874]) Inline Documentation for general-template.php, props jacobsantos, fixes #5640

#14 @jacobsantos
9 years ago

The previous comment is spam.

Note: See TracTickets for help on using tickets.