WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 6 years ago

#7550 closed enhancement (fixed)

Inline documentation corrections for 2.7

Reported by: santosj Owned by: westi
Milestone: 2.7 Priority: low
Severity: trivial Version:
Component: General Keywords: phpdoc has-patch commit close-2.7
Focuses: Cc:

Description

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.

Attachments (17)

7550.r8674.diff (4.8 KB) - added by santosj 7 years ago.
Corrections for TinyMCE Spellchecker plugin for adding @package phpdoc tags, based off of r8674
7550.r8674.install-helper.diff (1.0 KB) - added by santosj 7 years ago.
Subpackage corrections to include install helper functions into the "Plugin" namespace, based off of r8674
7550.corrections.patch (66.9 KB) - added by jacobsantos 7 years ago.
Corrections to since and short descriptions, among other based off of r8687
7550.corrections.2.patch (63.9 KB) - added by santosj 7 years ago.
Massive corrections.
7550.corrections.diff (63.9 KB) - added by santosj 7 years ago.
Massive corrections.
7550.corrections.2.diff (23.0 KB) - added by santosj 7 years ago.
Massive corrections.
7550.corrections.r8781.patch (34.5 KB) - added by jacobsantos 7 years ago.
More corrections based off of r8781
7550.r8831.diff (14.4 KB) - added by jacobsantos 7 years ago.
KSES corrections, based off of r8831.
7550.r8841.diff (1.3 KB) - added by jacobsantos 7 years ago.
corrections for http.php based off of r8841.
7550.r8927.diff (2.6 KB) - added by jacobsantos 7 years ago.
Fixes for general-template.php and update.php based off of r8927
7550.r8947.diff (24.6 KB) - added by jacobsantos 7 years ago.
Completion and fixes for base file inline documentation based off of r8947
7550.r8954.diff (2.3 KB) - added by jacobsantos 7 years ago.
Corrections for comment.php based off of r8954
7550.r8969.diff (9.5 KB) - added by jacobsantos 7 years ago.
Completion of comment-template.php again based off of r8969
7550.r8991.diff (12.5 KB) - added by jacobsantos 7 years ago.
File level inline documentation for default themes and plugins to prevent injection into default WordPress namespace, based off of r8991
7550.r8991.2.diff (16.9 KB) - added by jacobsantos 7 years ago.
Theme, plugin, BackPress, javascript corrections based off of r8991
7550.r9046.diff (2.0 KB) - added by jacobsantos 6 years ago.
wp-admin file level phpdoc inline documentation based off of r9046
7550.r9124.diff (1.1 KB) - added by jacobsantos 6 years ago.
Fixes for setup-config.php to keep from poisoning the defines in wp-config-sample.php, based off of r9124

Download all attachments as: .zip

Change History (48)

@santosj7 years ago

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

comment:1 @santosj7 years ago

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.

@santosj7 years ago

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

comment:2 @santosj7 years ago

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.

comment:3 @westi7 years ago

  • Owner changed from anonymous to westi
  • Status changed from new to assigned

comment:4 @westi7 years ago

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

comment:5 @westi7 years ago

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

comment:6 @jacobsantos7 years ago

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

@jacobsantos7 years ago

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

@santosj7 years ago

Massive corrections.

@santosj7 years ago

Massive corrections.

@santosj7 years ago

Massive corrections.

comment:7 @westi7 years ago

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

comment:8 @santosj7 years ago

  • Keywords phpdoc added

@jacobsantos7 years ago

More corrections based off of r8781

comment:9 @westi7 years ago

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

comment:10 @jacobsantos7 years ago

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.

@jacobsantos7 years ago

KSES corrections, based off of r8831.

comment:11 @jacobsantos7 years ago

  • Keywords has-patch commit added

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

comment:12 @westi7 years ago

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

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

comment:13 @jacobsantos7 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

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

@jacobsantos7 years ago

corrections for http.php based off of r8841.

comment:14 @azaozz7 years ago

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

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

@jacobsantos7 years ago

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

comment:15 @jacobsantos7 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Patch includes more fixes for two files.

comment:16 @azaozz7 years ago

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

comment:17 @jacobsantos7 years ago

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.

@jacobsantos7 years ago

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

comment:18 @azaozz7 years ago

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

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

@jacobsantos7 years ago

Corrections for comment.php based off of r8954

comment:19 @jacobsantos7 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

More corrections for comment.php

comment:20 @azaozz7 years ago

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

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

@jacobsantos7 years ago

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

comment:21 @jacobsantos7 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

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.

comment:22 @ryan7 years ago

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

comment:23 @jacobsantos7 years ago

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

@jacobsantos7 years ago

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

@jacobsantos7 years ago

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

comment:24 @westi7 years ago

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

comment:25 @westi7 years ago

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

comment:26 @westi7 years ago

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

comment:27 @westi7 years ago

I think that covers all those changes.

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

@jacobsantos6 years ago

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

comment:28 @ryan6 years ago

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

@jacobsantos6 years ago

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

comment:29 @jacobsantos6 years ago

  • Keywords close-2.7 added

comment:30 @westi6 years ago

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

comment:31 @jacobsantos6 years ago

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

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.

Note: See TracTickets for help on using tickets.