Improve mediawiki.js documentation
authorTimo Tijhof <krinklemail@gmail.com>
Wed, 15 Jan 2014 21:07:45 +0000 (22:07 +0100)
committerKrinkle <krinklemail@gmail.com>
Thu, 16 Jan 2014 18:27:13 +0000 (18:27 +0000)
commit4ef7fe14bf850b2314ef27eb41c67429ab4dc515
treefb79bc186fb47dd58193bb6d9873f2f87e75378a
parentf7ad294e9fdd05c9c766ddd5451bd3d86cdcfc07
Improve mediawiki.js documentation

Incorporate some of the edits made to the old documentation on
mediawiki.org at https://www.mediawiki.org/wiki/ResourceLoader/Default_modules

mw:
* Add note about the globals being added.

mw.Message:
* Add inline example.
* Revise documentation of related methods.

mw.loader:
* Add code samples for #addSource and #using.
* Document loadScript property for #addSource using @param syntax.
* Document "null" return value for #getVersion.

mw.html:
* Add code sample #escape.

mw.loader.store:
* Mark #update as method instead of the incorrectly inferred
  type "property" (the assignment is non-trivial, it can't
  infer the return type of the closure).

Change-Id: Id42a108066fac333a9253f2fa8908746b8a1ba8f
resources/mediawiki/mediawiki.js