Opened 5 years ago
Closed 5 years ago
#5509 closed enhancement (fixed)
PHPdoc effort for pluggable.php
| Reported by: |
|
Owned by: |
|
|---|---|---|---|
| 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 (4)
Change History (13)
darkdragon — 5 years ago
comment:1
darkdragon — 5 years ago
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.
- Owner changed from anonymous to westi
- Status changed from new to assigned
comment:4
darkdragon — 5 years ago
- Summary changed from PHPdoc for pluggable.php to PHPdoc effort for pluggable.php
comment:5
darkdragon — 5 years ago
Patch for r6597, just has completed function documentation or as close to complete as possible.
- Resolution set to fixed
- Status changed from assigned to closed
comment:7
darkdragon — 5 years ago
- Resolution fixed deleted
- Status changed from closed to reopened
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.
comment:8
darkdragon — 5 years ago
- Keywords commit added; documentation removed
- Milestone changed from 2.6 to 2.5
Last patch which completes ticket. All other corrections probably belong in #5611.

Incomplete documentation for pluggables.php based off of r6473