From 7460860c3bbbaec492c0966513025e7f943c0988 Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Mon, 28 Apr 2014 22:12:16 +0200 Subject: [PATCH] mediawiki.language.init: Clarify documentation Change-Id: If2b96ba2c835c9e6d14adfa84e0bea7981beda0e --- .../mediawiki.language/mediawiki.language.init.js | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/resources/src/mediawiki.language/mediawiki.language.init.js b/resources/src/mediawiki.language/mediawiki.language.init.js index fd77025b07..5b9afcf0c1 100644 --- a/resources/src/mediawiki.language/mediawiki.language.init.js +++ b/resources/src/mediawiki.language/mediawiki.language.init.js @@ -12,15 +12,16 @@ */ mw.language = { /** - * Language-related data (keyed by language, contains instances of mw.Map). Loaded dynamically - * (see ResourceLoaderLanguageDataModule in PHP docs, aka mediawiki.language.data module). + * Language-related data (keyed by language, contains instances of mw.Map). + * Loaded dynamically (see ResourceLoaderLanguageDataModule class in PHP, registered + * as mediawiki.language.data on the client). * * To set data: * * // Override, extend or create the language data object of 'nl' * mw.language.setData( 'nl', 'myKey', 'My value' ); * - * // Set multiple values at once + * // Set multiple key/values pairs at once * mw.language.setData( 'nl', { foo: 'X', bar: 'Y' } ); * * To get GrammarForms data for language 'nl': @@ -47,8 +48,8 @@ * * @param {string} langCode * @param {string} dataKey - * @return {Mixed} Value stored in the mw.Map (or `undefined` if there is no map for the specified - * langCode). + * @return {Mixed} Value stored in the mw.Map (or `undefined` if there is no map for the + * specified langCode) */ getData: function ( langCode, dataKey ) { var langData = mw.language.data; @@ -64,8 +65,8 @@ * Creates the data mw.Map if there isn't one for the specified language already. * * @param {string} langCode - * @param {string|Object} dataKey Key or object of key/values. - * @param {Mixed} value Value for dataKey, ignored if dataKey is an object. + * @param {string|Object} dataKey Key or object of key/values + * @param {Mixed} [value] Value for dataKey, omit if dataKey is an object */ setData: function ( langCode, dataKey, value ) { var langData = mw.language.data; -- 2.20.1