Inline Documentation for general-template.php

[darkdragon]

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.

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

Inline Documentation for wp_meta() based off of r8681

Updated patch based off of r8786

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

Updating these now myself.

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.

documenting this file right now

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

That gets the file 80% complete.

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

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!

Corrections to trunk, based off of r8831

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

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

Two functions left to document, based off of r8855.

Finished file inline documentation based off of r8857

Latest patch completes inline documentation.

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

The previous comment is spam.