[wp-trac] [WordPress Trac] #3970: admin-functions.php inline documentation

[WordPress Trac]

#3970: admin-functions.php inline documentation
----------------------------+-----------------------------------------------
 Reporter:  m0n5t3r         |       Owner:  anonymous                          
     Type:  enhancement     |      Status:  new                                
 Priority:  normal          |   Milestone:                                     
Component:  Administration  |     Version:  2.1.2                              
 Severity:  normal          |    Keywords:  has-patch 2nd-opinion needs-testing
----------------------------+-----------------------------------------------
 Inline phpdoc-style documentation for most functions in admin-
 functions.php; I also added filters used in the docblocks of the functions
 they are used in with @filter filtername, for easy automatic parsing. If
 you feel this is inappropriate, {{{%s/^ \* @filter .*\n//cg}}} (adapt to
 your favourite editor) should do the trick :)

 Also, there are a couple of functions with some guys' names scribbled on
 them; I kept the names et al, although I feel they don't belong there
 (yeah, the author felt so proud for discovering the state machine that he
 felt the need to let people know, but come on... this means that I should
 add in every docblock "documentation by m0n5t3r"?). Since I received no
 feedback from wp-hackers, I am leaving this at the latitude of the
 committer.

 I hope I got all the return types correct. Sorry for posting such a big
 patch, but it's a big file (maybe it should be split, at least separating
 functions that output HTML from the ones handling communication from the
 ones handling database access and object manipulation).

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