Ticket #5509 (closed enhancement: fixed)

Opened 5 months ago

Last modified 4 months ago

PHPdoc effort for pluggable.php

Reported by: darkdragon Assigned to: westi
Priority: low Milestone: 2.5
Component: Optimization Version:
Severity: minor Keywords: phpdoc has-patch commit
Cc:

Description

PHPdoc efforts for pluggable.php enhances the inline documentation of the file.

  • Adds @since information
  • Documents deprecated pluggable functions
  • Documents file level for xref and phpdocumentor sites.
  • Adds all functions to WordPress package
  • Has short and long descriptions
  • Documents parameters and return values

Attachments

pluggable.phpdoc.r6473.diff (15.5 kB) - added by darkdragon on 12/23/07 08:30:46.
Incomplete documentation for pluggables.php based off of r6473
pluggable.phpdoc.r6582.diff (18.8 kB) - added by darkdragon on 01/09/08 13:52:28.
Still incomplete phpdoc based off of 6582
pluggable.phpdoc.r6597.diff (15.1 kB) - added by darkdragon on 01/11/08 03:43:37.
Just finished documention for pluggable functions, based off of r6597
pluggable.phpdoc.r6636.diff (12.4 kB) - added by darkdragon on 01/20/08 06:42:22.
Completed phpdoc for pluggable.php based on r6636

Change History

12/23/07 08:30:46 changed by darkdragon

  • attachment pluggable.phpdoc.r6473.diff added.

Incomplete documentation for pluggables.php based off of r6473

12/23/07 08:38:35 changed by darkdragon

If you are wondering what relevance the patch has, most of the work is at the bottom and goes up, since I usually use Zend Studio to document the parameters and return values working down and then add the @since, short/long descriptions going back up.

Description is based on completed documentation, which this the current patch isn't there yet.

12/23/07 09:07:58 changed by westi

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

12/24/07 07:20:10 changed by westi

Good work . Won't commit until we have more info

12/26/07 04:31:28 changed by darkdragon

  • summary changed from PHPdoc for pluggable.php to PHPdoc effort for pluggable.php.

01/09/08 13:52:28 changed by darkdragon

  • attachment pluggable.phpdoc.r6582.diff added.

Still incomplete phpdoc based off of 6582

01/11/08 03:43:37 changed by darkdragon

  • attachment pluggable.phpdoc.r6597.diff added.

Just finished documention for pluggable functions, based off of r6597

01/11/08 03:44:45 changed by darkdragon

Patch for r6597, just has completed function documentation or as close to complete as possible.

01/11/08 20:51:39 changed by ryan

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

(In [6600]) phpdoc for pluggable from darkdragon. fixes #5509

01/12/08 02:39:45 changed by darkdragon

  • status changed from closed to reopened.
  • resolution deleted.

Committed phpdoc comments only covers a small portion of full file, but currently the only ones I have completed or almost completed portions.

It will allow for uploading a new template patch for anyone else who wishes to complete the file to have less work to do.

01/20/08 06:42:22 changed by darkdragon

  • attachment pluggable.phpdoc.r6636.diff added.

Completed phpdoc for pluggable.php based on r6636

01/20/08 06:44:46 changed by darkdragon

  • keywords changed from phpdoc documentation has-patch to phpdoc has-patch commit.
  • milestone changed from 2.6 to 2.5.

Last patch which completes ticket. All other corrections probably belong in #5611.

01/20/08 06:53:42 changed by ryan

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

(In [6637]) phpdoc for pluggable.php from darkdragon. fixes #5509