Ticket #5640 (closed enhancement: fixed)

Opened 11 months ago

Last modified 2 months ago

Inline Documentation for general-template.php

Reported by: darkdragon Assigned to: westi
Priority: low Milestone: 2.7
Component: Optimization Version:
Severity: trivial Keywords: phpdoc has-patch commit
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

general-template.phpdoc.r6597.diff (19.0 kB) - added by darkdragon on 01/11/08 03:31:39.
Incomplete documentation for general-template.php based off of r6597
5640.r8681.diff (0.6 kB) - added by jacobsantos on 08/20/08 02:47:19.
Inline Documentation for wp_meta() based off of r8681
5640.r8786.diff (17.9 kB) - added by jacobsantos on 08/31/08 22:53:38.
Updated patch based off of r8786
5640.r8831.diff (21.7 kB) - added by jacobsantos on 09/06/08 01:23:42.
Corrections to trunk, based off of r8831
5640.r8852.diff (9.9 kB) - added by jacobsantos on 09/09/08 16:41:32.
Completes with three functions left for inline documentation based off of r8852
5640.r8855.diff (10.7 kB) - added by jacobsantos on 09/09/08 22:59:37.
Two functions left to document, based off of r8855.
5640.r8857.diff (15.5 kB) - added by jacobsantos on 09/10/08 23:14:09.
Finished file inline documentation based off of r8857

Change History

01/11/08 03:31:39 changed by darkdragon

  • attachment general-template.phpdoc.r6597.diff added.

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

08/20/08 02:47:19 changed by jacobsantos

  • attachment 5640.r8681.diff added.

Inline Documentation for wp_meta() based off of r8681

08/31/08 22:53:38 changed by jacobsantos

  • attachment 5640.r8786.diff added.

Updated patch based off of r8786

09/04/08 18:26:35 changed by jacobsantos

  • milestone changed from 2.9 to 2.7.

09/04/08 18:29:45 changed by jacobsantos

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

09/05/08 19:19:01 changed by westi

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

09/05/08 19:30:12 changed by westi

  • owner changed from anonymous to westi.
  • status changed from new to assigned.

Updating these now myself.

09/05/08 21:11:03 changed by jacobsantos

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.

09/05/08 21:24:44 changed by westi

documenting this file right now

09/05/08 21:47:56 changed by westi

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

09/05/08 21:48:33 changed by westi

That gets the file 80% complete.

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

09/05/08 22:09:27 changed by jacobsantos

  • keywords changed from phpdoc has-patch to phpdoc needs-patch.

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!

09/06/08 01:23:42 changed by jacobsantos

  • attachment 5640.r8831.diff added.

Corrections to trunk, based off of r8831

09/06/08 06:38:27 changed by westi

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

09/09/08 16:41:32 changed by jacobsantos

  • attachment 5640.r8852.diff added.

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

09/09/08 22:59:37 changed by jacobsantos

  • attachment 5640.r8855.diff added.

Two functions left to document, based off of r8855.

09/10/08 23:14:09 changed by jacobsantos

  • attachment 5640.r8857.diff added.

Finished file inline documentation based off of r8857

09/10/08 23:15:15 changed by jacobsantos

  • keywords changed from phpdoc needs-patch to phpdoc has-patch commit.

Latest patch completes inline documentation.

09/12/08 04:31:42 changed by azaozz

  • status changed from assigned to closed.
  • resolution set to fixed.

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