Make WordPress Core

Opened 9 years ago

Closed 8 years ago

#3970 closed enhancement (wontfix)

admin-functions.php inline documentation

Reported by: m0n5t3r Owned by:
Milestone: Priority: normal
Severity: normal Version: 2.1.2
Component: Optimization Keywords: phpdoc
Focuses: Cc:


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).

Attachments (1)

admin-functions-phpdoc.diff (29.6 KB) - added by m0n5t3r 9 years ago.
admin-functions phpdoc take 2

Download all attachments as: .zip

Change History (9)

comment:1 @westi9 years ago

+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?

comment:2 @m0n5t3r9 years ago

I was talking about splitting admin-functions, not the patch ofc... :)

comment:3 @foolswisdom9 years ago

  • Milestone set to 2.3

@m0n5t3r9 years ago

admin-functions phpdoc take 2

comment:4 @m0n5t3r9 years ago

fixed some typos and return types

comment:5 @ryan8 years ago

  • Milestone changed from 2.3 to 2.4 (next)

comment:6 @ryan8 years ago

  • Keywords phpdoc added

comment:7 @darkdragon8 years ago

  • Milestone changed from 2.5 to 2.6

comment:8 @darkdragon8 years ago

  • Component changed from Administration to Optimization
  • Keywords has-patch 2nd-opinion needs-testing removed
  • Milestone 2.6 deleted
  • Resolution set to wontfix
  • Status changed from new to closed

This is actually deprecated, so I'm just going to close this. I can find it later.

Note: See TracTickets for help on using tickets.