WordPress.org

Make WordPress Core

Opened 12 years ago

Closed 11 years ago

Last modified 11 years ago

#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)

wp-settings.phpdoc.4.diff (7.3 KB) - added by darkdragon 12 years ago.
Added @Since to two missing blocks
vars-version.phpdoc.diff (1.6 KB) - added by darkdragon 12 years ago.
phpdoc documentation for vars.php and version.php
wp-settings.phpdoc.r6311.diff (6.8 KB) - added by darkdragon 11 years ago.
Updated previous patch for r6311, which caused conflicts.

Download all attachments as: .zip

Change History (9)

@darkdragon
12 years ago

Added @Since to two missing blocks

#1 @westi
12 years ago

  • Milestone changed from 2.5 to 2.4
  • Owner changed from anonymous to westi
  • Status changed from new to assigned

#2 @santosj
12 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."

@darkdragon
12 years ago

phpdoc documentation for vars.php and version.php

#3 @darkdragon
12 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.

@darkdragon
11 years ago

Updated previous patch for r6311, which caused conflicts.

#4 @westi
11 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [6434]) phpdoc for wp-settings.php. Fixes #5211 props darkdragon.

#5 @santosj
11 years ago

I didn't upload my newest patch! Need to change the timer_start and timer_stop @since information to 0.71 instead of 1.5. Pretty much the only change between the old patch and my most recent one.

Thanks for committing. That is sweet!

#6 @westi
11 years ago

(In [6437]) Fix @since for timer_start and timer_stop. See #5211.

Note: See TracTickets for help on using tickets.