A little cleanup in gender
authorAmir E. Aharoni <amir.aharoni@mail.huji.ac.il>
Fri, 26 Oct 2012 21:26:12 +0000 (23:26 +0200)
committerAmir E. Aharoni <amir.aharoni@mail.huji.ac.il>
Fri, 26 Oct 2012 22:01:39 +0000 (00:01 +0200)
Documentation and whitespace.

Change-Id: Ia28ab9eee8d1fb6301532d820f7f8cfd2f8a5146

resources/mediawiki/mediawiki.jqueryMsg.js

index 86af31f..7364829 100644 (file)
                },
 
                /**
-                * Transform parsed structure into gender
-                * Usage {{gender:[gender| mw.user object ] | masculine|feminine|neutral}}.
-                * @param {Array} of nodes, [ {String|mw.User}, {String}, {String} , {String} ]
+                * Transform parsed structure according to gender.
+                * Usage {{gender:[ gender | mw.user object ] | masculine form|feminine form|neutral form}}.
+                * The first node is either a string, which can be "male" or "female",
+                * or a User object (not a username).
+                *
+                * @param {Array} of nodes, [ {String|mw.User}, {String}, {String}, {String} ]
                 * @return {String} selected gender form according to current language
                 */
                gender: function ( nodes ) {
-                       var gender;
-                       if  ( nodes[0] && nodes[0].options instanceof mw.Map ){
+                       var gender, forms;
+
+                       if  ( nodes[0] && nodes[0].options instanceof mw.Map ) {
                                gender = nodes[0].options.get( 'gender' );
                        } else {
                                gender = nodes[0];
                        }
-                       var forms = nodes.slice(1);
+
+                       forms = nodes.slice( 1 );
+
                        return this.language.gender( gender, forms );
                },