Merge "Improve clarity of diff-multi message"

[lhc/web/wiklou.git] / resources / mediawiki.language / mediawiki.cldr.js

diff --git a/resources/mediawiki.language/mediawiki.cldr.js b/resources/mediawiki.language/mediawiki.cldr.js
index 6660eca..f6fb8f1 100644 (file)
--- a/resources/mediawiki.language/mediawiki.cldr.js
+++ b/resources/mediawiki.language/mediawiki.cldr.js
@@ -1,28 +1,32 @@
-/**
- *  CLDR related utility methods
- */
-( function( mw ) {
-       "use strict";
+( function ( mw ) {
+       'use strict';
 
-       var cldr = {
+       /**
+        * Namespace for CLDR-related utility methods.
+        *
+        * @class
+        * @singleton
+        */
+       mw.cldr = {
                /**
-                * For the number, get the plural for index
-                * In case none of the rules passed, we return pluralRules.length
-                * That means it is the "other" form.
-                * @param number
-                * @param pluralRules
-                * @return plural form index
+                * Get the plural form index for the number.
+                *
+                * In case none of the rules passed, we return `pluralRules.length` -
+                * that means it is the "other" form.
+                *
+                * @param {number} number
+                * @param {Array} pluralRules
+                * @return {number} plural form index
                 */
-               getPluralForm: function( number, pluralRules ) {
-                       var pluralFormIndex = 0;
-                       for ( pluralFormIndex = 0; pluralFormIndex < pluralRules.length; pluralFormIndex++ ) {
-                               if ( mw.libs.pluralRuleParser( pluralRules[pluralFormIndex], number ) ) {
+               getPluralForm: function ( number, pluralRules ) {
+                       var i;
+                       for ( i = 0; i < pluralRules.length; i++ ) {
+                               if ( mw.libs.pluralRuleParser( pluralRules[i], number ) ) {
                                        break;
                                }
                        }
-                       return pluralFormIndex;
+                       return i;
                }
        };
 
-       mw.cldr = cldr;
-} )( mediaWiki );
+}( mediaWiki ) );