Ticket #5572 (closed enhancement: fixed)

Opened 11 months ago

Last modified 11 months ago

PHPdoc effort for collective file level documentation

Reported by: darkdragon Assigned to: anonymous
Priority: low Milestone: 2.5
Component: Optimization Version:
Severity: trivial Keywords: phpdoc has-patch commit
Cc:

Description

PHPdoc style documentation for the following files:

File and Global Levels

  1. version.php
  2. vars.php

File Level

  1. registration-functions.php
  2. rss-functions.php
  3. streams.php
  4. gettext.php

There needs to be some cleanup on the other external library file level documentation. I've found that specifying just the package for external libraries can be confusing to visitors looking at phpdocumentor sites.

I think using @package External with the @subpackage as the library name is a better for the user experience. A new user would immediately be able to see in a phpdocumentor site that the libraries belong to an outside source.

Kses was not updated, since it is fairly well integrated into WordPress therefore needs documentation.

Patch does not clean up other external files phpdoc documentation.

Attachments

collective.phpdoc.r6542.patch (3.8 kB) - added by darkdragon on 01/03/08 06:41:21.
Based off of r6542

Change History

01/03/08 06:41:21 changed by darkdragon

  • attachment collective.phpdoc.r6542.patch added.

Based off of r6542

01/04/08 20:05:07 changed by ryan

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

(In [6554]) Some file level phpdoc from darkdragon. fixes #5572