#5211 closed enhancement (fixed)
wp-settings.php documentation
Reported by: | darkdragon | Owned by: | westi |
---|---|---|---|
Milestone: | 2.5 | Priority: | normal |
Severity: | normal | Version: | 2.5 |
Component: | Optimization | Keywords: | phpdoc documentation has-patch |
Focuses: | Cc: |
Description
Documentation push for standardization of WordPress. Documents globals and defines, as well as all functions in wp-settings.php.
Might not be as high priority, since it is wp-settings.php, but it does have @since information which would make the defines and global information useful to those searching for such things and wanting to know which version without having to do as much research I as did.
Attachments (3)
Change History (9)
#1
@
16 years ago
- Milestone changed from 2.5 to 2.4
- Owner changed from anonymous to westi
- Status changed from new to assigned
#2
@
16 years ago
First paragraph should read:
"Documentation standardization push for WordPress mass documentation effort.
Patch adds documentation to defines, globals, and functions for wp-settings.php. Adds @since information and @deprecated information for all documented elements.
Committing isn't a high priority, but the patch should be used for reference of future documentation. Might be useful since it does document constants that are useful to plugin authors."
#3
@
16 years ago
Added documentation for vars.php and version.php. Don't know if core would want to add these, but it was pretty easy to write.
The argument for version.php is that it documents one global that is used throughout WordPress. That and @uses $wp_version
would work if it had phpdoc for the global.
Added
@Since
to two missing blocks