Ticket #3970 (closed enhancement: wontfix)

Opened 5 years ago

Last modified 4 years ago

admin-functions.php inline documentation

Reported by: m0n5t3r Owned by: anonymous
Priority: normal Milestone:
Component: Optimization Version: 2.1.2
Severity: normal Keywords: phpdoc
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).

Attachments

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

Change History

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

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

  • Milestone set to 2.3

m0n5t3r5 years ago

admin-functions phpdoc take 2

fixed some typos and return types

comment:5   ryan4 years ago

  • Milestone changed from 2.3 to 2.4 (next)

comment:6   ryan4 years ago

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

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.