Ticket #5641 (closed enhancement: fixed)

Opened 11 months ago

Last modified 10 months ago

PHPdoc effort for updating kses.php

Reported by: darkdragon Assigned to: anonymous
Priority: low Milestone: 2.5
Component: Optimization Version:
Severity: trivial Keywords: phpdoc has-patch commit dev-feedback
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

kses.phpdoc.r6597.diff (24.1 kB) - added by darkdragon on 01/11/08 06:25:55.
Almost complete documentation for kses.php external library based off of r6597
kses.phpdoc.r6603.diff (25.4 kB) - added by darkdragon on 01/12/08 19:31:40.
Complete phpdoc documentation for kses.php based off of r6603
kses.phpdoc.r6617.diff (25.9 kB) - added by darkdragon on 01/15/08 03:33:45.
Updated patch based on r6617, which might have caused previous patch to go stale.

Change History

01/11/08 06:25:55 changed by darkdragon

  • attachment kses.phpdoc.r6597.diff added.

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

01/11/08 06:29:40 changed by darkdragon

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.

01/12/08 19:31:40 changed by darkdragon

  • attachment kses.phpdoc.r6603.diff added.

Complete phpdoc documentation for kses.php based off of r6603

01/12/08 19:39:00 changed by darkdragon

New patch completes all of the Kses inline documentation.

01/15/08 03:33:45 changed by darkdragon

  • attachment kses.phpdoc.r6617.diff added.

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

01/15/08 03:35:19 changed by darkdragon

  • keywords changed from phpdoc has-patch to phpdoc has-patch commit dev-feedback.

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?

01/16/08 19:15:08 changed by ryan

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

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

01/20/08 21:14:07 changed by darkdragon

  • milestone changed from 2.6 to 2.5.