Ticket #5211 (closed enhancement: fixed)

Opened 9 months ago

Last modified 7 months ago

wp-settings.php documentation

Reported by: darkdragon Assigned to: westi
Priority: normal Milestone: 2.5
Component: Optimization Version: 2.5
Severity: normal Keywords: phpdoc documentation has-patch
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

wp-settings.phpdoc.4.diff (7.3 kB) - added by darkdragon on 10/16/07 04:44:46.
Added @Since to two missing blocks
vars-version.phpdoc.diff (1.6 kB) - added by darkdragon on 10/19/07 01:55:18.
phpdoc documentation for vars.php and version.php
wp-settings.phpdoc.r6311.diff (6.8 kB) - added by darkdragon on 11/04/07 01:35:24.
Updated previous patch for r6311, which caused conflicts.

Change History

10/16/07 04:44:46 changed by darkdragon

  • attachment wp-settings.phpdoc.4.diff added.

Added @Since to two missing blocks

10/16/07 08:08:00 changed by westi

  • owner changed from anonymous to westi.
  • status changed from new to assigned.
  • milestone changed from 2.5 to 2.4.

10/16/07 13:53:47 changed by santosj

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."

10/19/07 01:55:18 changed by darkdragon

  • attachment vars-version.phpdoc.diff added.

phpdoc documentation for vars.php and version.php

10/19/07 02:05:21 changed by darkdragon

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.

11/04/07 01:35:24 changed by darkdragon

  • attachment wp-settings.phpdoc.r6311.diff added.

Updated previous patch for r6311, which caused conflicts.

12/20/07 20:44:52 changed by westi

  • status changed from assigned to closed.
  • resolution set to fixed.

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

12/20/07 21:05:01 changed by santosj

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!

12/20/07 21:28:53 changed by westi

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