Changeset 12862

Timestamp:

03/03/08 18:09:37 (10 months ago)

Author:

peller

Message:

Improve docs and markdown. Refs #5962

Files:

• dojo/trunk/number.js (modified) (18 diffs)

dojo/trunk/number.js

@@ -12 +12 @@
 }
 
-dojo.number.__formatOptions = function(kwArgs){
+dojo.number.__FormatOptions = function(){
         //      pattern: String?
         //              override formatting pattern with this string (see
@@ -22 +22 @@
         //              fixed number of decimal places to show.  This overrides any
         //              information in the provided pattern.
-        //      round: NUmber?
+        //      round: Number?
         //              5 rounds to nearest .5; 0 rounds to nearest whole (default). -1
         //              means don't round.
@@ -31 +31 @@
         //      locale: String?
         //              override the locale used to determine formatting rules
+        this.pattern = pattern;
+        this.type = type;
+        this.places = places;
+        this.round = round;
+        this.currency = currency;
+        this.symbol = symbol;
+        this.locale = locale;
 }
 =====*/
 
-dojo.number.format = function(/*Number*/value, /*dojo.number.__formatOptions?*/options){
+dojo.number.format = function(/*Number*/value, /*dojo.number.__FormatOptions?*/options){
         // summary:
         //              Format a Number as a String, using locale-specific settings
@@ -40 +47 @@
         //              Create a string from a Number using a known localized pattern.
         //              Formatting patterns appropriate to the locale are chosen from the
-        //              CLDR http://unicode.org/cldr as well as the appropriate symbols and
-        //              delimiters.  See http://www.unicode.org/reports/tr35/#Number_Elements
+        //              [CLDR](http://unicode.org/cldr) as well as the appropriate symbols and
+        //              delimiters.  See <http://www.unicode.org/reports/tr35/#Number_Elements>
         // value:
         //              the number to be formatted.  If not a valid JavaScript number,
@@ -58 +65 @@
 dojo.number._numberPatternRE = /[#0,]*[#0](?:\.0*#*)?/; // not precise, but good enough
 
-dojo.number._applyPattern = function(/*Number*/value, /*String*/pattern, /*dojo.number.__formatOptions?*/options){
+dojo.number._applyPattern = function(/*Number*/value, /*String*/pattern, /*dojo.number.__FormatOptions?*/options){
         // summary:
         //              Apply pattern to format value as a string using options. Gives no
@@ -65 +72 @@
         //              the number to be formatted.
         // pattern:
-        //              a pattern string as described in
-        //              http://www.unicode.org/reports/tr35/#Number_Format_Patterns
-        // options: dojo.number.__formatOptions?
-        //              _applyPattern is usually called via dojo.number.format() which
+        //              a pattern string as described by
+        //              [unicode.org TR35](http://www.unicode.org/reports/tr35/#Number_Format_Patterns)
+        // options: dojo.number.__FormatOptions?
+        //              _applyPattern is usually called via `dojo.number.format()` which
         //              populates an extra property in the options parameter, "customs".
         //              The customs object specifies group and decimal parameters if set.
@@ -136 +143 @@
 
 /*=====
-dojo.number.__formatAbsoluteOptions = function(kwArgs){
+dojo.number.__FormatAbsoluteOptions = function(){
         //      decimal: String?
         //              the decimal separator
@@ -146 +153 @@
         //              5 rounds to nearest .5; 0 rounds to nearest whole (default). -1
         //              means don't round.
+        this.decimal = decimal;
+        this.group = group;
+        this.places = places;
+        this.round = round;
 }
 =====*/
 
-dojo.number._formatAbsolute = function(/*Number*/value, /*String*/pattern, /*dojo.number.__formatAbsoluteOptions?*/options){
+dojo.number._formatAbsolute = function(/*Number*/value, /*String*/pattern, /*dojo.number.__FormatAbsoluteOptions?*/options){
         // summary: 
         //              Apply numeric pattern to absolute value using options. Gives no
@@ -156 +167 @@
         //              the number to be formatted, ignores sign
         // pattern:
-        //              the number portion of a pattern (e.g. #,##0.00)
+        //              the number portion of a pattern (e.g. `#,##0.00`)
         options = options || {};
         if(options.places === true){options.places=0;}
@@ -229 +240 @@
 
 /*=====
-dojo.number.__regexpOptions = function(kwArgs){
+dojo.number.__RegexpOptions = function(){
         //      pattern: String?
         //              override pattern with this string.  Default is provided based on
@@ -243 +254 @@
         //              number of decimal places to accept: Infinity, a positive number, or
         //              a range "n,m".  By default, defined by pattern.
+        this.pattern = pattern;
+        this.type = type;
+        this.locale = locale;
+        this.strict = strict;
+        this.places = places;
 }
 =====*/
-dojo.number.regexp = function(/*dojo.number.__regexpOptions?*/options){
+dojo.number.regexp = function(/*dojo.number.__RegexpOptions?*/options){
         //      summary:
         //              Builds the regular needed to parse a number
@@ -295 +311 @@
                         if(parts.length == 1 || places === 0){flags.fractional = false;}
                         else{
-                                if(typeof places == "undefined"){ places = parts[1].lastIndexOf('0')+1; }
+                                if(places === undefined){ places = parts[1].lastIndexOf('0')+1; }
                                 if(places && options.fractional == undefined){flags.fractional = true;} // required fractional, unless otherwise specified
                                 if(!options.places && (places < parts[1].length)){ places += "," + parts[1].length; }
@@ -334 +350 @@
 
 /*=====
-dojo.number.__parseOptions = function(kwArgs){
+dojo.number.__ParseOptions = function(){
         //      pattern: String
         //              override pattern with this string.  Default is provided based on
@@ -347 +363 @@
         //      currency: Object
         //              object with currency information
+        this.pattern = pattern;
+        this.type = type;
+        this.locale = locale;
+        this.strict = strict;
+        this.currency = currency;
 }
 =====*/
-dojo.number.parse = function(/*String*/expression, /*dojo.number.__parseOptions?*/options){
+dojo.number.parse = function(/*String*/expression, /*dojo.number.__ParseOptions?*/options){
         // summary:
         //              Convert a properly formatted string to a primitive Number, using
@@ -355 +376 @@
         // description:
         //              Create a Number from a string using a known localized pattern.
-        //              Formatting patterns are chosen appropriate to the locale.
-        //              Formatting patterns are implemented using the syntax described at
-        //              *URL*
+        //              Formatting patterns are chosen appropriate to the locale
+        //              and follow the syntax described by
+        //              [unicode.org TR35](http://www.unicode.org/reports/tr35/#Number_Format_Patterns)
         // expression:
         //              A string representation of a Number
@@ -385 +406 @@
 
 /*=====
-dojo.number.__realNumberRegexpFlags = function(kwArgs){
+dojo.number.__RealNumberRegexpFlags = function(){
         //      places: Number?
         //              The integer number of decimal places or a range given as "n,m".  If
@@ -405 +426 @@
         //              match if it is signed or unsigned).  flags in regexp.integer can be
         //              applied.
+        this.places = places;
+        this.decimal = decimal;
+        this.fractional = fractional;
+        this.exponent = exponent;
+        this.eSigned = eSigned;
 }
 =====*/
 
-dojo.number._realNumberRegexp = function(/*dojo.number.__realNumberRegexpFlags?*/flags){
+dojo.number._realNumberRegexp = function(/*dojo.number.__RealNumberRegexpFlags?*/flags){
         // summary:
         //              Builds a regular expression to match a real number in exponential
         //              notation
-        // flags:
-        //              An object
 
         // assign default values to missing paramters
         flags = flags || {};
-        if(typeof flags.places == "undefined"){ flags.places = Infinity; }
+        //TODO: use mixin instead?
+        if(!("places" in flags)){ flags.places = Infinity; }
         if(typeof flags.decimal != "string"){ flags.decimal = "."; }
-        if(typeof flags.fractional == "undefined" || /^0/.test(flags.places)){ flags.fractional = [true, false]; }
-        if(typeof flags.exponent == "undefined"){ flags.exponent = [true, false]; }
-        if(typeof flags.eSigned == "undefined"){ flags.eSigned = [true, false]; }
+        if(!("fractional" in flags) || /^0/.test(flags.places)){ flags.fractional = [true, false]; }
+        if(!("exponent" in flags)){ flags.exponent = [true, false]; }
+        if(!("eSigned" in flags)){ flags.eSigned = [true, false]; }
 
         // integer RE
@@ -459 +484 @@
 
 /*=====
-dojo.number.__integerRegexpFlags = function(kwArgs){
+dojo.number.__IntegerRegexpFlags = function(){
         //      signed: Boolean?
-        //              The leading plus-or-minus sign. Can be true, false, or [true,
-        //              false]. Default is [true, false], (i.e. will match if it is signed
+        //              The leading plus-or-minus sign. Can be true, false, or `[true,false]`.
+        //              Default is `[true, false]`, (i.e. will match if it is signed
         //              or unsigned).
         //      separator: String?
         //              The character used as the thousands separator. Default is no
-        //              separator. For more than one symbol use an array, e.g. [",", ""],
+        //              separator. For more than one symbol use an array, e.g. `[",", ""]`,
         //              makes ',' optional.
         //      groupSize: Number?
         //              group size between separators
-        //      flags.groupSize2: Number?
-        //              second grouping (for India)
+        //      groupSize2: Number?
+        //              second grouping, where separators 2..n have a different interval than the first separator (for India)
+        this.signed = signed;
+        this.separator = separator;
+        this.groupSize = groupSize;
+        this.groupSize2 = groupSize2;
 }
 =====*/
 
-dojo.number._integerRegexp = function(/*dojo.number.__integerRegexpFlags?*/flags){
+dojo.number._integerRegexp = function(/*dojo.number.__IntegerRegexpFlags?*/flags){
         // summary: 
         //              Builds a regular expression that matches an integer
-        // flags: 
-        //              An object
 
         // assign default values to missing paramters
         flags = flags || {};
-        if(typeof flags.signed == "undefined"){ flags.signed = [true, false]; }
-        if(typeof flags.separator == "undefined"){
+        if(!("signed" in flags)){ flags.signed = [true, false]; }
+        if(!("separator" in flags)){
                 flags.separator = "";
-        }else if(typeof flags.groupSize == "undefined"){
+        }else if(!("groupSize" in flags)){
                 flags.groupSize = 3;
         }