diff --git a/lib/OpenLayers/BaseTypes/Bounds.js b/lib/OpenLayers/BaseTypes/Bounds.js index a943aec55a..d8ac3a69aa 100644 --- a/lib/OpenLayers/BaseTypes/Bounds.js +++ b/lib/OpenLayers/BaseTypes/Bounds.js @@ -480,7 +480,7 @@ OpenLayers.Bounds.fromString = function(str) { * from an array * * Parameters: - * bbox - {Array} Array of bounds values (ex. [5,42,10,45]) + * bbox - {Array(Float)} Array of bounds values (ex. [5,42,10,45]) * * Return: * {} New object built from the diff --git a/lib/OpenLayers/Control/ArgParser.js b/lib/OpenLayers/Control/ArgParser.js index f96177c114..71c16fbc30 100644 --- a/lib/OpenLayers/Control/ArgParser.js +++ b/lib/OpenLayers/Control/ArgParser.js @@ -27,7 +27,7 @@ OpenLayers.Control.ArgParser = OpenLayers.Class(OpenLayers.Control, { /** * Parameter: layers - * {Array} + * {Array()} */ layers: null, diff --git a/lib/OpenLayers/Control/LayerSwitcher.js b/lib/OpenLayers/Control/LayerSwitcher.js index d808868e86..8e03aa59ed 100644 --- a/lib/OpenLayers/Control/LayerSwitcher.js +++ b/lib/OpenLayers/Control/LayerSwitcher.js @@ -34,7 +34,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, { /** * Property: baseLayers - * {Array} + * {Array()} */ baseLayers: null, @@ -53,7 +53,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, { /** * Property: dataLayers - * {Array} + * {Array()} */ dataLayers: null, diff --git a/lib/OpenLayers/Events.js b/lib/OpenLayers/Events.js index 1ed65ec6ca..ab0565b47f 100644 --- a/lib/OpenLayers/Events.js +++ b/lib/OpenLayers/Events.js @@ -337,7 +337,7 @@ OpenLayers.Events = OpenLayers.Class({ /** * Constant: BROWSER_EVENTS - * {Array} supported events + * {Array(String)} supported events */ BROWSER_EVENTS: [ "mouseover", "mouseout", @@ -366,7 +366,7 @@ OpenLayers.Events = OpenLayers.Class({ /** * Property: eventTypes - * {Array} list of support application events + * {Array(String)} list of support application events */ eventTypes: null, @@ -389,7 +389,7 @@ OpenLayers.Events = OpenLayers.Class({ * Parameters: * object - {Object} The js object to which this Events object is being * added element - {DOMElement} A dom element to respond to browser events - * eventTypes - {Array} Array of custom application events + * eventTypes - {Array(String)} Array of custom application events * fallThrough - {Boolean} Allow events to fall through after these have * been handled? */ diff --git a/lib/OpenLayers/Format/WFS.js b/lib/OpenLayers/Format/WFS.js index 813aa27e2f..55cdacc8db 100644 --- a/lib/OpenLayers/Format/WFS.js +++ b/lib/OpenLayers/Format/WFS.js @@ -52,7 +52,7 @@ OpenLayers.Format.WFS = OpenLayers.Class(OpenLayers.Format.GML, { * Takes a feature list, and generates a WFS-T Transaction * * Parameters: - * features - {Array} + * features - {Array()} */ write: function(features) { diff --git a/lib/OpenLayers/Geometry/Collection.js b/lib/OpenLayers/Geometry/Collection.js index e3e5181c49..53c106ec69 100644 --- a/lib/OpenLayers/Geometry/Collection.js +++ b/lib/OpenLayers/Geometry/Collection.js @@ -250,7 +250,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * Parameters: * angle - {Float} Rotation angle in radians (measured counterclockwise * from the positive x-axis) - * origin - {OpenLayers.Geometry.Point} Center point for the rotation + * origin - {} Center point for the rotation */ rotate: function(angle, origin) { for(var i=0; i} Point of origin for resizing */ resize: function(scale, origin) { for(var i=0; i)} * */ initialize: function(components) { diff --git a/lib/OpenLayers/Geometry/Point.js b/lib/OpenLayers/Geometry/Point.js index 77465bfa86..5265646d59 100644 --- a/lib/OpenLayers/Geometry/Point.js +++ b/lib/OpenLayers/Geometry/Point.js @@ -137,7 +137,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, { * Parameters: * angle - {Float} Rotation angle in radians (measured counterclockwise * from the positive x-axis) - * origin - {OpenLayers.Geometry.Point} Center point for the rotation + * origin - {} Center point for the rotation */ rotate: function(angle, origin) { var radius = this.distanceTo(origin); @@ -156,7 +156,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, { * scale - {Float} Ratio of the new distance from the origin to the old * distance from the origin. A scale of 2 doubles the * distance between the point and origin. - * origin - {OpenLayers.Geometry.Point} Point of origin for resizing + * origin - {} Point of origin for resizing */ resize: function(scale, origin) { this.x = origin.x + (scale * (this.x - origin.x)); diff --git a/lib/OpenLayers/Handler.js b/lib/OpenLayers/Handler.js index 6a47ecc0d8..ac3f5365b6 100644 --- a/lib/OpenLayers/Handler.js +++ b/lib/OpenLayers/Handler.js @@ -183,8 +183,8 @@ OpenLayers.Handler = OpenLayers.Class({ * Parameters: * name - {String} The key for the callback that is one of the properties * of the handler's callbacks object. - * args - {Array} An array of arguments with which to call the callback - * (defined by the control). + * args - {Array(*)} An array of arguments (any type) with which to call + * the callback (defined by the control). */ callback: function (name, args) { if (this.callbacks[name]) { diff --git a/lib/OpenLayers/Handler/Feature.js b/lib/OpenLayers/Handler/Feature.js index 0769d58a89..efbeae715c 100644 --- a/lib/OpenLayers/Handler/Feature.js +++ b/lib/OpenLayers/Handler/Feature.js @@ -30,11 +30,10 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, { * * Parameters: * control - {} - * layers - {Array} List of OpenLayers.Layer.Vector - * callbacks - {Array} An object with a 'over' property whos value is - * a function to be called when the mouse is over - * a feature. The callback should expect to recieve - * a single argument, the feature. + * layers - {Array()} + * callbacks - {Object} An object with a 'over' property whos value is + * a function to be called when the mouse is over a feature. The + * callback should expect to recieve a single argument, the feature. * options - {Object} */ initialize: function(control, layer, callbacks, options) { diff --git a/lib/OpenLayers/Handler/Path.js b/lib/OpenLayers/Handler/Path.js index 4c0dcd91da..85a0744c14 100644 --- a/lib/OpenLayers/Handler/Path.js +++ b/lib/OpenLayers/Handler/Path.js @@ -47,14 +47,14 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * * Parameters: * control - {} - * callbacks - {Array} An object with a 'done' property whos value is a - * function to be called when the path drawing is finished. The callback - * should expect to recieve a single argument, the line string geometry. - * If the callbacks object contains a 'point' property, this function will - * be sent each point as they are added. If the callbacks object contains - * a 'cancel' property, this function will be called when the handler is - * deactivated while drawing. The cancel should expect to receive a - * geometry. + * callbacks - {Object} An object with a 'done' property whos value is a + * function to be called when the path drawing is finished. The + * callback should expect to recieve a single argument, the line + * string geometry. If the callbacks object contains a 'point' + * property, this function will be sent each point as they are added. + * If the callbacks object contains a 'cancel' property, this function + * will be called when the handler is deactivated while drawing. The + * cancel should expect to receive a geometry. * options - {Object} An optional object with properties to be set on the * handler */ diff --git a/lib/OpenLayers/Handler/Point.js b/lib/OpenLayers/Handler/Point.js index e7e0c49740..b0ffacd85f 100644 --- a/lib/OpenLayers/Handler/Point.js +++ b/lib/OpenLayers/Handler/Point.js @@ -60,7 +60,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, { * * Parameters: * control - {} The control that owns this handler - * callbacks - {Array} An object with a 'done' property whos value is a + * callbacks - {Object} An object with a 'done' property whos value is a * function to be called when the point drawing is finished. * The callback should expect to recieve a single argument, * the point geometry. If the callbacks object contains a diff --git a/lib/OpenLayers/Handler/Polygon.js b/lib/OpenLayers/Handler/Polygon.js index cd93ba7137..fc956d2e48 100644 --- a/lib/OpenLayers/Handler/Polygon.js +++ b/lib/OpenLayers/Handler/Polygon.js @@ -29,7 +29,7 @@ OpenLayers.Handler.Polygon = OpenLayers.Class(OpenLayers.Handler.Path, { * * Parameters: * control - {} - * callbacks - {Array} An object with a 'done' property whos value is + * callbacks - {Object} An object with a 'done' property whos value is * a function to be called when the path drawing is * finished. The callback should expect to recieve a * single argument, the polygon geometry. diff --git a/lib/OpenLayers/Layer/Grid.js b/lib/OpenLayers/Layer/Grid.js index ae4bd7ce3e..e3a12174d5 100644 --- a/lib/OpenLayers/Layer/Grid.js +++ b/lib/OpenLayers/Layer/Grid.js @@ -23,7 +23,8 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, { /** * Property: grid - * {Array} This is an array of rows, each row is an array of tiles + * {Array(Array())} This is an array of rows, each row is + * an array of tiles. */ grid: null, diff --git a/lib/OpenLayers/Layer/TileCache.js b/lib/OpenLayers/Layer/TileCache.js index a15725b055..654839a880 100644 --- a/lib/OpenLayers/Layer/TileCache.js +++ b/lib/OpenLayers/Layer/TileCache.js @@ -88,7 +88,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * Method: getURL * * Parameters: - * bounds - {OpenLayers.Bounds} + * bounds - {} * * Returns: * A string with the layer's url and parameters and also the diff --git a/lib/OpenLayers/Layer/Vector.js b/lib/OpenLayers/Layer/Vector.js index 091f4d2a6b..a67a49fe6b 100644 --- a/lib/OpenLayers/Layer/Vector.js +++ b/lib/OpenLayers/Layer/Vector.js @@ -343,7 +343,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, { * Erase features from the layer. * * Parameters: - * features - {Array(OpenLayers.Feature.Vector)} + * features - {Array()} */ eraseFeatures: function(features) { this.renderer.eraseFeatures(features); diff --git a/lib/OpenLayers/Map.js b/lib/OpenLayers/Map.js index 769af6c54d..c5d07b3c66 100644 --- a/lib/OpenLayers/Map.js +++ b/lib/OpenLayers/Map.js @@ -25,7 +25,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * Constant: EVENT_TYPES - * {Array} supported application event types + * {Array(String)} supported application event types */ EVENT_TYPES: [ "addlayer", "removelayer", "changelayer", "movestart", "move", @@ -155,10 +155,10 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIProperty: resolutions - * {Array} A list of map resolutions (map units per pixel) in descending - * order. If this is not set in the layer constructor, it will be set - * based on other resolution related properties (maxExtent, maxResolution, - * maxScale, etc.). + * {Array(Float)} A list of map resolutions (map units per pixel) in + * descending order. If this is not set in the layer constructor, it + * will be set based on other resolution related properties + * (maxExtent, maxResolution, maxScale, etc.). */ resolutions: null, diff --git a/lib/OpenLayers/Renderer/SVG.js b/lib/OpenLayers/Renderer/SVG.js index 09a8cb1e06..2f74a4aafc 100644 --- a/lib/OpenLayers/Renderer/SVG.js +++ b/lib/OpenLayers/Renderer/SVG.js @@ -510,7 +510,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { * Method: getComponentString * * Parameters: - * components - {Array} Array of points + * components - {Array( that was * supplied to the `round` method. * - * @param {Array} options - list of options + * @param {Object} options - list of options */ reRound: function(theDiv, options) {