Opened 17 years ago
Closed 17 years ago
#5572 closed enhancement (fixed)
PHPdoc effort for collective file level documentation
Reported by: |
|
Owned by: | |
---|---|---|---|
Milestone: | 2.5 | Priority: | low |
Severity: | trivial | Version: | |
Component: | Optimization | Keywords: | phpdoc has-patch commit |
Focuses: | Cc: |
Description
PHPdoc style documentation for the following files:
File and Global Levels
- version.php
- vars.php
File Level
- registration-functions.php
- rss-functions.php
- streams.php
- gettext.php
There needs to be some cleanup on the other external library file level documentation. I've found that specifying just the package for external libraries can be confusing to visitors looking at phpdocumentor sites.
I think using @package External
with the @subpackage
as the library name is a better for the user experience. A new user would immediately be able to see in a phpdocumentor site that the libraries belong to an outside source.
Kses was not updated, since it is fairly well integrated into WordPress therefore needs documentation.
Patch does not clean up other external files phpdoc documentation.
Attachments (1)
Change History (2)
Note: See
TracTickets for help on using
tickets.
Based off of r6542