mediawiki.js: Clean up and improve documentation
authorTimo Tijhof <krinklemail@gmail.com>
Tue, 13 Jan 2015 07:09:04 +0000 (23:09 -0800)
committerTimo Tijhof <krinklemail@gmail.com>
Tue, 13 Jan 2015 22:52:59 +0000 (14:52 -0800)
commit2cd0ff6d69644be71be8ff02d76aed070aafb091
treef15920ed00ec0eb8c2b6289bd545bc303885f508
parentd65c1bca72098ba89b0b1e52b79fa956566bf838
mediawiki.js: Clean up and improve documentation

* Consistently phrase one-line captions in the imperative mood.

* Consistently start parameter descriptions with a capital letter.

* Document a few missing parameters and callback parameters.

* Rewrite mw.Map example.

* Merge duplicate @return tags in mw.Map#set (only the first one
  is parsed by JSDuck).

* Fix mw.loader#registry code example. In order for the indented
  text to be parsed as a code block, an empty is required.

* Improve IE-support comments with more details.

* Remove redundant String() cast in newStyleTag(). Per its signature,
  it only supports strings. Other values don't make sense.

Change-Id: Iaaeaea4869f7869f5f4d29b27d11c0b05aad2ef5
resources/src/mediawiki/mediawiki.js