Topic on Talk:Gadget kitchen/January 2012 training

Jump to navigation Jump to search

Self-generated documentation for JavaScript modules

1
Krinkle (talkcontribs)

Copied from the talk notes:

TODO: DKinzler: would be awesome if mw.* would be self-descriptive. mw.help .... or documentation

The current status quo is to document inline with Doxygen-like formatting. This is good for programmers in contact with those files, but for online access we have yet to find a good parser that understands JavaScript and can read the various files / modules and understand which objects extend eachother, what scopes exists etc. (like is done for PHP code at http://svn.wikimedia.org/docs/). Until that is figured out, we're manually documenting things at ResourceLoader/Default modules. Also Requests for comment/Documentation overhaul.

Reply to "Self-generated documentation for JavaScript modules"