Opened 17 years ago
Closed 17 years ago
#5509 closed enhancement (fixed)
PHPdoc effort for pluggable.php
Reported by: | darkdragon | Owned by: | westi |
---|---|---|---|
Milestone: | 2.5 | Priority: | low |
Severity: | minor | Version: | |
Component: | Optimization | Keywords: | phpdoc has-patch commit |
Focuses: | 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)
#1
@
17 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.
#5
@
17 years ago
Patch for r6597, just has completed function documentation or as close to complete as possible.
#7
@
17 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.
Incomplete documentation for pluggables.php based off of r6473