Documentation challenge: hooks

Topic: Documentation challenge: hooks (Read 2724 times) previous topic - next topic

0 Members and 1 Guest are viewing this topic.

Documentation challenge: hooks

March 30, 2014, 08:23:19 pm

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?

Re: Documentation challenge: hooks

Reply #1 – March 30, 2014, 08:27:26 pm

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.

Re: Documentation challenge: hooks

Reply #2 – March 30, 2014, 08:46:11 pm

@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

Re: Documentation challenge: hooks

Reply #3 – March 30, 2014, 10:50:55 pm

Quote from: groundup – March 30, 2014, 08:46:11 pmGreat idea. This is going to be a lot of work though

Fortunately eman loves loves loves to write docblocks

Re: Documentation challenge: hooks

Reply #4 – March 31, 2014, 01:07:53 pm

Indeed!!

emanuele looks around for a beer <= helps writing better docs!