Opened 5 years ago
Closed 5 years ago
#5511 closed enhancement (fixed)
PHPdoc effort for cache.php
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| 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 (2)
Change History (8)
darkdragon — 5 years ago
comment:1
darkdragon — 5 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.
- Owner changed from anonymous to westi
- Status changed from new to assigned
comment:4
darkdragon — 5 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.
comment:5
darkdragon — 5 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.
Incomplete documentation for cache.php based off of r6473