Inline documentation corrections for 2.7

[santosj]

The inevitable inline documentation correction ticket for WordPress 2.7. Also inevitable that no one else will find this ticket, when they find corrections, but meh.

Corrections for TinyMCE Spellchecker plugin for adding @package phpdoc tags, based off of r8674

attachment 7550.r8674.diff added.
Corrections for TinyMCE Spellchecker plugin for adding @package phpdoc tags, based off of r8674

The patch has been sent upstream to the Moxiecode Sourceforge patch tracker. It is unknown when or if they are going to apply the patch. Including here to fix inclusion of some TinyMCE Spellchecker plugin classes into the WordPress phpdocumentor namespace.

Subpackage corrections to include install helper functions into the "Plugin" namespace, based off of r8674

attachment 7550.r8674.install-helper.diff added.

Patch added to apply the installer helper functions to the "Plugin" namespace, instead of the current "Plugins" namespace. It would make more sense to have it that way instead of the current way since Plugins are going to wait to use it and the "Plugin" namespace already exists.

(In [8686]) File level phpdoc for tinymcs spellchecker. See #7550 props santosj.

(In [8687]) phpdoc fixes for install-helper.php. See #7550 props santosj.

#7243 includes @since version corrections, which I do have a patch for, but haven't uploaded. I'm probably going to correct the short descriptions along with the patch in one go. Might as well create a patch for all of the corrections I have so far.

Corrections to since and short descriptions, among other based off of r8687

Massive corrections.

Massive corrections.

Massive corrections.

(In [8742]) phpDoc corrections for wp-includes. See #7550 props santosj.

More corrections based off of r8781

(In [8782]) phpDoc corrections for wp-includes. See #7550 props jacobsantos.

I have one more file: kses.php that I have corrections for before this ticket is complete. Probably reopen if there any more after that.

KSES corrections, based off of r8831.

Final corrections for WordPress 2.7, corrects KSES.php file.

(In [8837]) phpDoc corrections for KSES. Fixes #7550 props jacobsantos.

Have patch for http.php to correct inline documentation in that file as well.

corrections for http.php based off of r8841.

(In [8842]) phpDoc corrections for http.php, props jacobsantos fixes #7550

Fixes for general-template.php and update.php based off of r8927

Patch includes more fixes for two files.

(In [8929]) phpDoc fixes for general-template.php and update.php, props jacobsantos, see #7550

I'm not sure, leave this open for the rest of the inevitable corrections to late night ramblings and day time incoherency or keep reopening and closing until 2.7 roadmap is complete. I just don't want the ticket to be moved to 2.8 and then forget during the time that I'm not actively on inline documentation.

Completion and fixes for base file inline documentation based off of r8947

(In [8952]) Completion and fixes for wp-app, wp-login and xmlrpc inline documentation, props jacobsantos, fixes #7550

Corrections for comment.php based off of r8954

More corrections for comment.php

(In [8956]) phpDoc corrections for comment.php, props jacobsantos, fixes #7550

Completion of comment-template.php again based off of r8969

Patch completes new functions for comment-template.php. I would leave this ticket open because the patch after this will actually fix the @since phpdoc tags with the version numbers the code was introduced in.

(In [8970]) phpdoc for comments-template from jacobsantos. see #7550

New patch for file level inline documentation for default themes and plugins (Akismet patch has been sent up stream to plugins.trac.wordpress.org).

File level inline documentation for default themes and plugins to prevent injection into default WordPress namespace, based off of r8991

Theme, plugin, BackPress, javascript corrections based off of r8991

(In [8999]) phpdoc for the default and classic themes. See #7550 props jacobsantos.

(In [9001]) phpdoc for hello dolly. See #7550 props jacobsantos.

(In [9002]) phpdoc updates for wp-includes See #7550 props jacobsantos.

I think that covers all those changes.

Also merged the BackPress ones upstream - ​http://backpress.automattic.com/changeset/154

wp-admin file level phpdoc inline documentation based off of r9046

(In [9052]) File level phpdc from jacobsantos. see #7550

Fixes for setup-config.php to keep from poisoning the defines in wp-config-sample.php, based off of r9124

(In [9126]) phpdoc fixes for setup-config.php. See #7550 props jacobsantos.

Thanks!

Closing as fixed for 2.7. Any other corrections could probably wait for 2.8. There needs to be other testing to ensure that duplicate functions / constants / globals aren't poisoning the completed documented functions / constants / globals. That is quite a huge project, so should probably be done for 2.8.