OpenLayers OpenLayers

Changeset 3829

Show
Ignore:
Timestamp:
07/31/07 16:02:03 (1 year ago)
Author:
euzuro
Message:

ND Update: make array's say what they're made of, and a few other small bits, like mistyped and a couple missing <>s

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r3814 r3829  
    481481 *  
    482482 * Parameters: 
    483  * bbox - {Array} Array of bounds values (ex. <i>[5,42,10,45]</i>) 
     483 * bbox - {Array(Float)} Array of bounds values (ex. <i>[5,42,10,45]</i>) 
    484484 * 
    485485 * Return: 

  • trunk/openlayers/lib/OpenLayers/Control/ArgParser.js

    r3787 r3829  
    2828    /** 
    2929     * Parameter: layers  
    30      * {Array} 
     30     * {Array(<OpenLayers.Layer>)} 
    3131     */ 
    3232    layers: null, 

  • trunk/openlayers/lib/OpenLayers/Control/LayerSwitcher.js

    r3815 r3829  
    3535    /**  
    3636     * Property: baseLayers 
    37      * {Array} 
     37     * {Array(<OpenLayers.Layer>)} 
    3838     */ 
    3939    baseLayers: null, 
    …… 
    5454    /**  
    5555     * Property: dataLayers 
    56      * {Array}  
     56     * {Array(<OpenLayers.Layer>)}  
    5757     */ 
    5858    dataLayers: null, 

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

    r3815 r3829  
    338338    /**  
    339339     * Constant: BROWSER_EVENTS 
    340      * {Array} supported events  
     340     * {Array(String)} supported events  
    341341     */ 
    342342    BROWSER_EVENTS: [ 
    …… 
    367367    /**  
    368368     * Property: eventTypes  
    369      * {Array}  list of support application events  
     369     * {Array(String)}  list of support application events  
    370370     */ 
    371371    eventTypes: null, 
    …… 
    390390     * object - {Object} The js object to which this Events object  is being 
    391391     * added element - {DOMElement} A dom element to respond to browser events 
    392      * eventTypes - {Array} Array of custom application events  
     392     * eventTypes - {Array(String)} Array of custom application events  
    393393     * fallThrough - {Boolean} Allow events to fall through after these have 
    394394     *                         been handled? 

  • trunk/openlayers/lib/OpenLayers/Format/WFS.js

    r3787 r3829  
    5353     * 
    5454     * Parameters: 
    55      * features - {Array}  
     55     * features - {Array(<OpenLayers.Feature.Vector>)}  
    5656     */ 
    5757    write: function(features) { 

  • trunk/openlayers/lib/OpenLayers/Geometry/Collection.js

    r3815 r3829  
    251251     * angle - {Float} Rotation angle in radians (measured counterclockwise 
    252252     *                 from the positive x-axis) 
    253      * origin - {OpenLayers.Geometry.Point} Center point for the rotation 
     253     * origin - {<OpenLayers.Geometry.Point>} Center point for the rotation 
    254254     */ 
    255255    rotate: function(angle, origin) { 
    …… 
    269269     *                 (lines, for example, will be twice as long, and polygons 
    270270     *                 will have four times the area). 
    271      * origin - {OpenLayers.Geometry.Point} Point of origin for resizing 
     271     * origin - {<OpenLayers.Geometry.Point>} Point of origin for resizing 
    272272     */ 
    273273    resize: function(scale, origin) { 

  • trunk/openlayers/lib/OpenLayers/Geometry/MultiLineString.js

    r3787 r3829  
    3030     * 
    3131     * Parameters:  
    32      * components - {Array(OpenLayers.Geometry.LineString)}  
     32     * components - {Array(<OpenLayers.Geometry.LineString>)}  
    3333     * 
    3434     */ 

  • trunk/openlayers/lib/OpenLayers/Geometry/Point.js

    r3787 r3829  
    138138     * angle - {Float} Rotation angle in radians (measured counterclockwise 
    139139     *                 from the positive x-axis) 
    140      * origin - {OpenLayers.Geometry.Point} Center point for the rotation 
     140     * origin - {<OpenLayers.Geometry.Point>} Center point for the rotation 
    141141     */ 
    142142    rotate: function(angle, origin) { 
    …… 
    157157     *                 distance from the origin.  A scale of 2 doubles the 
    158158     *                 distance between the point and origin. 
    159      * origin - {OpenLayers.Geometry.Point} Point of origin for resizing 
     159     * origin - {<OpenLayers.Geometry.Point>} Point of origin for resizing 
    160160     */ 
    161161    resize: function(scale, origin) { 

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

    r3787 r3829  
    184184    * name - {String} The key for the callback that is one of the properties 
    185185    *     of the handler's callbacks object. 
    186     * args - {Array} An array of arguments with which to call the callback 
    187     *     (defined by the control). 
     186    * args - {Array(*)} An array of arguments (any type) with which to call  
     187    *     the callback (defined by the control). 
    188188    */ 
    189189    callback: function (name, args) { 

  • trunk/openlayers/lib/OpenLayers/Handler/Feature.js

    r3787 r3829  
    3131     * Parameters: 
    3232     * control - {<OpenLayers.Control>}  
    33      * layers - {Array} List of OpenLayers.Layer.Vector 
    34      * callbacks - {Array} An object with a 'over' property whos value is 
    35      *                          a function to be called when the mouse is over 
    36      *                          a feature. The callback should expect to recieve 
    37      *                          a single argument, the feature. 
     33     * layers - {Array(<OpenLayers.Layer.Vector>)} 
     34     * callbacks - {Object} An object with a 'over' property whos value is 
     35     *     a function to be called when the mouse is over a feature. The  
     36     *     callback should expect to recieve a single argument, the feature. 
    3837     * options - {Object}  
    3938     */ 

  • trunk/openlayers/lib/OpenLayers/Handler/Path.js

    r3787 r3829  
    4848     * Parameters: 
    4949     * control - {<OpenLayers.Control>}  
    50      * callbacks - {Array} An object with a 'done' property whos value is a 
    51      *   function to be called when the path drawing is finished. The callback 
    52      *   should expect to recieve a single argument, the line string geometry. 
    53      *   If the callbacks object contains a 'point' property, this function will 
    54      *   be sent each point as they are added.  If the callbacks object contains 
    55      *   a 'cancel' property, this function will be called when the handler is 
    56      *   deactivated while drawing.  The cancel should expect to receive a 
    57      *   geometry. 
     50     * callbacks - {Object} An object with a 'done' property whos value is a 
     51     *     function to be called when the path drawing is finished. The  
     52     *     callback should expect to recieve a single argument, the line  
     53     *     string geometry. If the callbacks object contains a 'point'  
     54     *     property, this function will be sent each point as they are added.   
     55     *     If the callbacks object contains a 'cancel' property, this function  
     56     *     will be called when the handler is deactivated while drawing. The  
     57     *     cancel should expect to receive a geometry. 
    5858     * options - {Object} An optional object with properties to be set on the 
    5959     *           handler 

  • trunk/openlayers/lib/OpenLayers/Handler/Point.js

    r3787 r3829  
    6161     * Parameters: 
    6262     * control - {<OpenLayers.Control>} The control that owns this handler 
    63      * callbacks - {Array} An object with a 'done' property whos value is a 
     63     * callbacks - {Object} An object with a 'done' property whos value is a 
    6464     *             function to be called when the point drawing is finished. 
    6565     *             The callback should expect to recieve a single argument, 

  • trunk/openlayers/lib/OpenLayers/Handler/Polygon.js

    r3787 r3829  
    3030     * Parameters: 
    3131     * control - {<OpenLayers.Control>}  
    32      * callbacks - {Array} An object with a 'done' property whos value is 
     32     * callbacks - {Object} An object with a 'done' property whos value is 
    3333     *                          a function to be called when the path drawing is 
    3434     *                          finished. The callback should expect to recieve a 

  • trunk/openlayers/lib/OpenLayers/Layer/Grid.js

    r3815 r3829  
    2424    /** 
    2525     * Property: grid 
    26      * {Array} This is an array of rows, each row is an array of tiles 
     26     * {Array(Array(<OpenLayers.Tile>))} This is an array of rows, each row is  
     27     *     an array of tiles. 
    2728     */ 
    2829    grid: null, 

  • trunk/openlayers/lib/OpenLayers/Layer/TileCache.js

    r3770 r3829  
    8989     * 
    9090     * Parameters: 
    91      * bounds - {OpenLayers.Bounds}  
     91     * bounds - {<OpenLayers.Bounds>}  
    9292     *  
    9393     * Returns: 

  • trunk/openlayers/lib/OpenLayers/Layer/Vector.js

    r3815 r3829  
    344344     * 
    345345     * Parameters: 
    346      * features - {Array(OpenLayers.Feature.Vector)}  
     346     * features - {Array(<OpenLayers.Feature.Vector>)}  
    347347     */ 
    348348    eraseFeatures: function(features) { 

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

    r3815 r3829  
    2626    /** 
    2727     * Constant: EVENT_TYPES 
    28      * {Array} supported application event types 
     28     * {Array(String)} supported application event types 
    2929     */ 
    3030    EVENT_TYPES: [  
    …… 
    156156    /** 
    157157     * APIProperty: resolutions 
    158      * {Array} A list of map resolutions (map units per pixel) in descending 
    159      * order.  If this is not set in the layer constructor, it will be set 
    160      * based on other resolution related properties (maxExtent, maxResolution, 
    161      * maxScale, etc.). 
     158     * {Array(Float)} A list of map resolutions (map units per pixel) in  
     159     *     descending order.  If this is not set in the layer constructor, it  
     160     *     will be set based on other resolution related properties  
     161     *     (maxExtent, maxResolution, maxScale, etc.). 
    162162     */ 
    163163    resolutions: null, 

  • trunk/openlayers/lib/OpenLayers/Renderer/SVG.js

    r3787 r3829  
    511511     *  
    512512     * Parameters: 
    513      * components - {Array} Array of points 
     513     * components - {Array(<OpenLayers.Geometry.Point)} Array of points 
    514514     */ 
    515515    getComponentsString: function(components) { 

  • trunk/openlayers/lib/Rico/Corner.js

    r2541 r3829  
    9393    *                        supplied to the `round` method. 
    9494    * 
    95     * @param {Array} options - list of options 
     95    * @param {Object} options - list of options 
    9696    */ 
    9797    reRound: function(theDiv, options) {