Opened 18 years ago
Closed 17 years ago
#3970 closed enhancement (wontfix)
admin-functions.php inline documentation
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Milestone: | Priority: | normal | |
| Severity: | normal | Version: | 2.1.2 |
| Component: | Optimization | Keywords: | phpdoc |
| Focuses: | Cc: |
Description
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).
+1 for the idea.
I don't think this should land till early 2.3
I would prefer splitting up admin-functions itself as well maybe the two tasks could be combined?