[wp-trac] [WordPress Trac] #5572: PHPdoc effort for collective file level documentation

[WordPress Trac]

#5572: PHPdoc effort for collective file level documentation
--------------------------+-------------------------------------------------
 Reporter:  darkdragon    |       Owner:  anonymous              
     Type:  enhancement   |      Status:  new                    
 Priority:  low           |   Milestone:  2.5                    
Component:  Optimization  |     Version:                         
 Severity:  trivial       |    Keywords:  phpdoc has-patch commit
--------------------------+-------------------------------------------------
 PHPdoc style documentation for the following files:

 File and Global Levels

  1. version.php
  1. vars.php

 File Level

  1. registration-functions.php
  1. rss-functions.php
  1. streams.php
  1. 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.

-- 
Ticket URL: <http://trac.wordpress.org/ticket/5572>
WordPress Trac <http://trac.wordpress.org/>
WordPress blogging software