OpenLayers OpenLayers

Changeset 6829

Show
Ignore:
Timestamp:
04/09/08 08:33:26 (9 months ago)
Author:
tschaub
Message:

Dividing base types into namespaces (docs only). (see #1504)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/openlayers/lib/OpenLayers/BaseTypes.js

    r6512 r6829  
    1818 */ 
    1919 
    20 /********************* 
    21  *                   * 
    22  *      STRING       *  
    23  *                   *  
    24  *********************/ 
    25  
     20/** 
     21 * Namespace: OpenLayers.String 
     22 * Contains convenience functions for string manipulation. 
     23 */ 
    2624OpenLayers.String = { 
    2725 
    2826    /** 
    29      * APIFunction: OpenLayers.String.startsWith 
     27     * APIFunction: startsWith 
    3028     * Test whether a string starts with another string.  
    3129     *  
    …… 
    4240 
    4341    /** 
    44      * APIFunction: OpenLayers.String.contains 
     42     * APIFunction: contains 
    4543     * Test whether a string contains another string. 
    4644     *  
    …… 
    5755     
    5856    /** 
    59      * APIFunction: OpenLayers.String.trim 
     57     * APIFunction: trim 
    6058     * Removes leading and trailing whitespace characters from a string. 
    6159     *  
    …… 
    7371     
    7472    /** 
    75      * APIFunction: OpenLayers.String.camelize 
     73     * APIFunction: camelize 
    7674     * Camel-case a hyphenated string.  
    7775     *     Ex. "chicken-head" becomes "chickenHead", and 
    …… 
    9593     
    9694    /** 
    97      * APIFunction: OpenLayers.String.format 
     95     * APIFunction: format 
    9896     * Given a string with tokens in the form ${token}, return a string 
    9997     *     with tokens replaced with properties from the given context 
    …… 
    210208} 
    211209 
    212 /********************* 
    213  *                   * 
    214  *      NUMBER       *  
    215  *                   *  
    216  *********************/ 
    217  
     210/** 
     211 * Namespace: OpenLayers.Number 
     212 * Contains convenience functions for manipulating numbers. 
     213 */ 
    218214OpenLayers.Number = { 
    219215 
    220216    /** 
    221      * Property: OpenLayers.Number.decimalSeparator 
     217     * Property: decimalSeparator 
    222218     * Decimal separator to use when formatting numbers. 
    223219     */ 
    …… 
    225221     
    226222    /** 
    227      * Property: OpenLayers.Number.thousandsSeparator 
     223     * Property: thousandsSeparator 
    228224     * Thousands separator to use when formatting numbers. 
    229225     */ 
    …… 
    231227     
    232228    /** 
    233      * APIFunction: OpenLayers.Number.limitSigDigs 
     229     * APIFunction: limitSigDigs 
    234230     * Limit the number of significant digits on a float. 
    235231     *  
    …… 
    251247     
    252248    /** 
    253      * APIFunction: OpenLayers.Number.format 
     249     * APIFunction: format 
    254250     * Formats a number for output. 
    255251     *  
    …… 
    325321} 
    326322 
    327 /********************* 
    328  *                   * 
    329  *      FUNCTION     *  
    330  *                   *  
    331  *********************/ 
    332  
     323/** 
     324 * Namespace: OpenLayers.Function 
     325 * Contains convenience functions for function manipulation. 
     326 */ 
    333327OpenLayers.Function = { 
    334328    /** 
    335      * APIFunction: OpenLayers.Function.bind 
     329     * APIFunction: bind 
    336330     * Bind a function to an object.  Method to easily create closures with 
    337331     *     'this' altered. 
    …… 
    358352     
    359353    /** 
    360      * APIFunction: OpenLayers.Function.bindAsEventListener 
     354     * APIFunction: bindAsEventListener 
    361355     * Bind a function to an object, and configure it to receive the event 
    362356     *     object as first parameter when called.  
    …… 
    417411} 
    418412 
    419 /********************* 
    420  *                   * 
    421  *      ARRAY        *  
    422  *                   *  
    423  *********************/ 
    424  
     413/** 
     414 * Namespace: OpenLayers.Array 
     415 * Contains convenience functions for array manipulation. 
     416 */ 
    425417OpenLayers.Array = { 
    426418 
    427419    /** 
    428      * APIMethod: OpenLayers.Array.filter 
     420     * APIMethod: filter 
    429421     * Filter an array.  Provides the functionality of the 
    430422     *     Array.prototype.filter extension to the ECMA-262 standard.  Where