This is probably the most challenging aspects of documentation I can think of: at the moment we have... I don't even know how many hooks (technically I can't even know LOL) in the code, but basically none of them is documented in any way.
Write documentation in the wiki is nice, but I don't think is doable for such critical thing like hooks.
A way to have them documented using phpDovumentor (or whatever is the one Spuds is using to publish it at github) would be wonderful, but as far as I remember it's not easily possible... :-\
Any idea?
Should we write our own doc-extractor?
Humm .. yeah let me see what if anything we can do with apigen to tag those, not really functions so not sure what can be done. The option to tag them with @hook and then write an extractor is always and option.
@event would be a more familiar name. Doing a search for it:
http://usejsdoc.org/tags-event.html
https://groups.google.com/forum/#!topic/php-fig/RdV06UsHD0o
Great idea. This is going to be a lot of work though :)
Fortunately eman loves loves loves to write docblocks :D
Indeed!! ;D
/me looks around for a beer <= helps writing better docs! :P