WordPress.org

Make WordPress Core

Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#5641 closed enhancement (fixed)

PHPdoc effort for updating kses.php

Reported by: darkdragon Owned by:
Milestone: 2.5 Priority: low
Severity: trivial Version:
Component: Optimization Keywords: phpdoc has-patch commit dev-feedback
Focuses: Cc:

Description

PHPdoc effort seeks to complete phpdoc style inline documentation for wp-includes/kses.php.

Needed to complete:

  1. Short and Long Descriptions.
  2. @since version info
  3. parameter type and description.
  4. return type and description.

Attachments (3)

kses.phpdoc.r6597.diff (24.1 KB) - added by darkdragon 11 years ago.
Almost complete documentation for kses.php external library based off of r6597
kses.phpdoc.r6603.diff (25.4 KB) - added by darkdragon 11 years ago.
Complete phpdoc documentation for kses.php based off of r6603
kses.phpdoc.r6617.diff (25.9 KB) - added by darkdragon 11 years ago.
Updated patch based on r6617, which might have caused previous patch to go stale.

Download all attachments as: .zip

Change History (8)

@darkdragon
11 years ago

Almost complete documentation for kses.php external library based off of r6597

#1 @darkdragon
11 years ago

New patch includes @since version numbers. Includes all of the parameter types and most of the descriptions. Includes all of the return types and most of the descriptions. Has most of the short and long descriptions based on the previous documentation.

Second patch should completely finish documentation for external Kses library. Perhaps the only external library worthy enough to get documentation.

I do understand that Kses is technically external to WordPress, but I think that as much as it is part of WordPress that documentation will help explain it to developers.

I will not submit documentation up stream to the original Kses library location.

@darkdragon
11 years ago

Complete phpdoc documentation for kses.php based off of r6603

#2 @darkdragon
11 years ago

New patch completes all of the Kses inline documentation.

@darkdragon
11 years ago

Updated patch based on r6617, which might have caused previous patch to go stale.

#3 @darkdragon
11 years ago

  • Keywords commit dev-feedback added

New patch updates completed patch based off of r6617, which might have caused the previous patch to go stale.

Is it possible given the scope of changes and support of Kses that has been made to have this patch go in?

#4 @ryan
11 years ago

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

(In [6630]) phpdoc for kses from darkdragon. fixes #5641

#5 @darkdragon
11 years ago

  • Milestone changed from 2.6 to 2.5
Note: See TracTickets for help on using tickets.