Ticket #5511 (closed enhancement: fixed)

Opened 7 months ago

Last modified 7 months ago

PHPdoc effort for cache.php

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

Description

PHPdoc effort for wp-includes/cache.php adds inline documentation for all functions, constants, properties, and methods.

  • @since version
  • Parameter and return value
  • Short and Long description

Attachments

cache.phpdoc.r6473.diff (11.7 kB) - added by darkdragon on 12/23/07 08:49:24.
Incomplete documentation for cache.php based off of r6473
cache.phpdoc.r6542.diff (10.8 kB) - added by darkdragon on 01/03/08 03:49:01.
Complete phpdoc documentation for cache.php based off of r6542

Change History

12/23/07 08:49:24 changed by darkdragon

  • attachment cache.phpdoc.r6473.diff added.

Incomplete documentation for cache.php based off of r6473

12/23/07 08:52:08 changed by darkdragon

The methods do not have @since information in the patch. The current source that was providing what version functions were added, does not accurately provide version information for methods and classes. Also does not provide information for properties and constants.

A new source is being developed that will remedy this problem and the documentation will be completed after that.

However, anyone who wants to finish the short and long descriptions can be my guest.

12/23/07 09:08:11 changed by westi

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

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

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

12/24/07 07:17:16 changed by darkdragon

I figured as much.

Patch is if anyone else wants to join the effort. In the mean time, I'm working on cache.php now. I might finish it up. Undecided at this point, I might move over to the tickets that already have documentation and try to complete those.

I move around a lot and the cache slightly more confusing the rest, so I'll most likely put if off until later.

01/03/08 03:49:01 changed by darkdragon

  • attachment cache.phpdoc.r6542.diff added.

Complete phpdoc documentation for cache.php based off of r6542

01/03/08 03:50:43 changed by darkdragon

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

r6539 totally pwns!

Finished the WordPress Cache API after it was greatly simplified in above revision.

01/03/08 04:35:48 changed by ryan

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

(In [6543]) phpdoc for cache.php from darkdragon. fixes #5511