WordPress.org

Make WordPress Core

Opened 12 years ago

Closed 12 years ago

#5511 closed enhancement (fixed)

PHPdoc effort for cache.php

Reported by: darkdragon Owned by: westi
Milestone: 2.5 Priority: low
Severity: minor Version:
Component: Optimization Keywords: phpdoc documentation has-patch commit
Focuses: Cc:
PR Number:

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 (2)

cache.phpdoc.r6473.diff (11.7 KB) - added by darkdragon 12 years ago.
Incomplete documentation for cache.php based off of r6473
cache.phpdoc.r6542.diff (10.8 KB) - added by darkdragon 12 years ago.
Complete phpdoc documentation for cache.php based off of r6542

Download all attachments as: .zip

Change History (8)

@darkdragon
12 years ago

Incomplete documentation for cache.php based off of r6473

#1 @darkdragon
12 years ago

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.

#2 @westi
12 years ago

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

#3 @westi
12 years ago

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

#4 @darkdragon
12 years ago

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.

@darkdragon
12 years ago

Complete phpdoc documentation for cache.php based off of r6542

#5 @darkdragon
12 years ago

  • Keywords commit added
  • Milestone changed from 2.6 to 2.5

r6539 totally pwns!

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

#6 @ryan
12 years ago

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

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

Note: See TracTickets for help on using tickets.