diff --git a/lib/OpenLayers/BaseTypes.js b/lib/OpenLayers/BaseTypes.js index 33ff2bb9d6..0b6f3aa939 100644 --- a/lib/OpenLayers/BaseTypes.js +++ b/lib/OpenLayers/BaseTypes.js @@ -25,7 +25,7 @@ OpenLayers.String = { * * Parameters: * str - {String} The string to test. - * sub - {Sring} The substring to look for. + * sub - {String} The substring to look for. * * Returns: * {Boolean} The first string starts with the second. @@ -204,7 +204,7 @@ if (!String.prototype.startsWith) { * *Deprecated*. Whether or not a string starts with another string. * * Parameters: - * sStart - {Sring} The string we're testing for. + * sStart - {String} The string we're testing for. * * Returns: * {Boolean} Whether or not this string starts with the string passed in. diff --git a/lib/OpenLayers/BaseTypes/Bounds.js b/lib/OpenLayers/BaseTypes/Bounds.js index 6818df2ec7..32493f85c9 100644 --- a/lib/OpenLayers/BaseTypes/Bounds.js +++ b/lib/OpenLayers/BaseTypes/Bounds.js @@ -260,7 +260,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * Default is center. * * Returns: - * {} A new bounds that is scaled by ratio + * {} A new bounds that is scaled by ratio * from origin. */ @@ -560,6 +560,8 @@ OpenLayers.Bounds = OpenLayers.Class({ * Parameters: * maxExtent - {} * options - {Object} Some possible options are: + * + * Allowed Options: * leftTolerance - {float} Allow for a margin of error * with the 'left' value of this * bound. diff --git a/lib/OpenLayers/Console.js b/lib/OpenLayers/Console.js index cc8cbae14b..9d62ac10af 100644 --- a/lib/OpenLayers/Console.js +++ b/lib/OpenLayers/Console.js @@ -101,7 +101,7 @@ OpenLayers.Console = { * Expects a single error message * * Parameters: - * object - {Object} + * error - {Object} */ userError: function(error) { alert(error); diff --git a/lib/OpenLayers/Control/SelectFeature.js b/lib/OpenLayers/Control/SelectFeature.js index c81e57ba19..e1d40bfe6f 100644 --- a/lib/OpenLayers/Control/SelectFeature.js +++ b/lib/OpenLayers/Control/SelectFeature.js @@ -132,7 +132,7 @@ OpenLayers.Control.SelectFeature = OpenLayers.Class(OpenLayers.Control, { /** * Property: layers - * {Array(} The layers this control will work on, + * {Array()} The layers this control will work on, * or null if the control was configured with a single layer */ layers: null, diff --git a/lib/OpenLayers/Control/Snapping.js b/lib/OpenLayers/Control/Snapping.js index d1042cd20b..ee58a9e725 100644 --- a/lib/OpenLayers/Control/Snapping.js +++ b/lib/OpenLayers/Control/Snapping.js @@ -372,7 +372,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, { * Method: considerSnapping * * Parameters: - * point - {} The vertex to be snapped (or * unsnapped). * loc - {} The location of the mouse in map * coords. diff --git a/lib/OpenLayers/Control/Split.js b/lib/OpenLayers/Control/Split.js index 521bfb780d..3dd823c1ba 100644 --- a/lib/OpenLayers/Control/Split.js +++ b/lib/OpenLayers/Control/Split.js @@ -297,7 +297,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { * Remove a feature from a list based on the given geometry. * * Parameters: - * features - {Array(} A list of features. + * features - {Array()} A list of features. * geometry - {} A geometry. */ removeByGeometry: function(features, geometry) { @@ -340,7 +340,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { * will be split if eligible. * * Parameters: - * feature - {} The newly created or modified * feature. * * Returns: diff --git a/lib/OpenLayers/Events.js b/lib/OpenLayers/Events.js index f043653f66..4b0dda5b5d 100644 --- a/lib/OpenLayers/Events.js +++ b/lib/OpenLayers/Events.js @@ -604,6 +604,9 @@ OpenLayers.Events = OpenLayers.Class({ * events.register("loadstart", object, loadStartListener); * events.register("loadstart", object, loadEndListener); * (end) + * + * Parameters: + * object - {Object} */ on: function(object) { for(var type in object) { diff --git a/lib/OpenLayers/Format/GML.js b/lib/OpenLayers/Format/GML.js index adcd7c7669..41a25210c6 100644 --- a/lib/OpenLayers/Format/GML.js +++ b/lib/OpenLayers/Format/GML.js @@ -582,7 +582,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, { * Method: parseAttributes * * Parameters: - * node - {} + * node - {DOMElement} * * Returns: * {Object} An attributes object. diff --git a/lib/OpenLayers/Format/GPX.js b/lib/OpenLayers/Format/GPX.js index 6496e67aea..63170feea3 100644 --- a/lib/OpenLayers/Format/GPX.js +++ b/lib/OpenLayers/Format/GPX.js @@ -134,7 +134,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, { * Method: extractSegment * * Parameters: - * segment - {} a trkseg or rte node to parse + * segment - {DOMElement} a trkseg or rte node to parse * segmentType - {String} nodeName of waypoints that form the line * * Returns: diff --git a/lib/OpenLayers/Format/GeoRSS.js b/lib/OpenLayers/Format/GeoRSS.js index 406cf42dec..44a71a9337 100644 --- a/lib/OpenLayers/Format/GeoRSS.js +++ b/lib/OpenLayers/Format/GeoRSS.js @@ -263,12 +263,12 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format.XML, { /** * APIMethod: read * Return a list of features from a GeoRSS doc - + * * Parameters: - * data - {Element} + * doc - {Element} * * Returns: - * An Array of s + * {Array()} */ read: function(doc) { if (typeof doc == "string") { diff --git a/lib/OpenLayers/Format/KML.js b/lib/OpenLayers/Format/KML.js index 07ba479adc..bcef2034bc 100644 --- a/lib/OpenLayers/Format/KML.js +++ b/lib/OpenLayers/Format/KML.js @@ -1125,7 +1125,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format.XML, { * Accept Feature Collection, and return a string. * * Parameters: - * features - {Array(} An array of features. + * features - {Array()} An array of features. * * Returns: * {String} A KML string. diff --git a/lib/OpenLayers/Geometry/Rectangle.js b/lib/OpenLayers/Geometry/Rectangle.js index 3481e23dfe..5f05cbedbb 100644 --- a/lib/OpenLayers/Geometry/Rectangle.js +++ b/lib/OpenLayers/Geometry/Rectangle.js @@ -50,7 +50,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, { * Constructor: OpenLayers.Geometry.Rectangle * * Parameters: - * points - {Array(} + * points - {Array()} */ initialize: function(x, y, width, height) { OpenLayers.Geometry.prototype.initialize.apply(this, arguments); diff --git a/lib/OpenLayers/Layer.js b/lib/OpenLayers/Layer.js index 6a59aeada9..01795b8c82 100644 --- a/lib/OpenLayers/Layer.js +++ b/lib/OpenLayers/Layer.js @@ -556,7 +556,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Method: moveTo * * Parameters: - * bound - {} + * bounds - {} * zoomChanged - {Boolean} Tells when zoom has changed, as layers have to * do some init work in that case. * dragging - {Boolean} @@ -715,7 +715,7 @@ OpenLayers.Layer = OpenLayers.Class({ * subverted. * * Parameters: - * visible - {Boolean} Whether or not to display the layer (if in range) + * visibility - {Boolean} Whether or not to display the layer (if in range) */ setVisibility: function(visibility) { if (visibility != this.visibility) { @@ -1079,7 +1079,7 @@ OpenLayers.Layer = OpenLayers.Class({ * APIMethod: getZoomForExtent * * Parameters: - * bounds - {} + * extent - {} * closest - {Boolean} Find the zoom level that most closely fits the * specified bounds. Note that this may result in a zoom that does * not exactly contain the entire extent. diff --git a/lib/OpenLayers/Layer/Grid.js b/lib/OpenLayers/Layer/Grid.js index 704dc0c2a8..6a916ff348 100644 --- a/lib/OpenLayers/Layer/Grid.js +++ b/lib/OpenLayers/Layer/Grid.js @@ -798,7 +798,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, { * * Parameters: * rows - {Integer} Maximum number of rows we want our grid to have. - * colums - {Integer} Maximum number of columns we want our grid to have. + * columns - {Integer} Maximum number of columns we want our grid to have. */ removeExcessTiles: function(rows, columns) { diff --git a/lib/OpenLayers/Map.js b/lib/OpenLayers/Map.js index 1767db2af9..53c8d4d02e 100644 --- a/lib/OpenLayers/Map.js +++ b/lib/OpenLayers/Map.js @@ -1591,7 +1591,7 @@ OpenLayers.Map = OpenLayers.Class({ * If the new lonlat is in the current extent the map will slide smoothly * * Parameters: - * lonlat - {} + * lonlat - {} */ panTo: function(lonlat) { if (this.panMethod && this.getExtent().scale(this.panRatio).containsLonLat(lonlat)) { @@ -2250,8 +2250,6 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: zoomIn * - * Parameters: - * zoom - {int} */ zoomIn: function() { this.zoomTo(this.getZoom() + 1); @@ -2260,8 +2258,6 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: zoomOut * - * Parameters: - * zoom - {int} */ zoomOut: function() { this.zoomTo(this.getZoom() - 1); diff --git a/lib/OpenLayers/Projection.js b/lib/OpenLayers/Projection.js index 6598feb031..7e652ba27d 100644 --- a/lib/OpenLayers/Projection.js +++ b/lib/OpenLayers/Projection.js @@ -30,7 +30,7 @@ OpenLayers.Projection = OpenLayers.Class({ /** * Property: titleRegEx - * {RegEx} regular expression to strip the title from a proj4js definition + * {RegExp} regular expression to strip the title from a proj4js definition */ titleRegEx: /\+title=[^\+]*/, @@ -174,10 +174,10 @@ OpenLayers.Projection.addTransform = function(from, to, method) { * the input point is transformed in place. * * Parameters: - * point - {{OpenLayers.Geometry.Point> | Object} An object with x and y + * point - { | Object} An object with x and y * properties representing coordinates in those dimensions. - * sourceProj - {OpenLayers.Projection} Source map coordinate system - * destProj - {OpenLayers.Projection} Destination map coordinate system + * source - {OpenLayers.Projection} Source map coordinate system + * dest - {OpenLayers.Projection} Destination map coordinate system * * Returns: * point - {object} A transformed coordinate. The original point is modified. diff --git a/lib/OpenLayers/Protocol/WFS/v1.js b/lib/OpenLayers/Protocol/WFS/v1.js index fc4ec5ae5c..98258c54f5 100644 --- a/lib/OpenLayers/Protocol/WFS/v1.js +++ b/lib/OpenLayers/Protocol/WFS/v1.js @@ -250,7 +250,7 @@ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, { * is used. * * Parameters: - * features - {Array(} + * features - {Array()} * * Returns: * {} A response object with a features diff --git a/lib/OpenLayers/Renderer/SVG.js b/lib/OpenLayers/Renderer/SVG.js index 3a0fcaa9e8..4b7f798a27 100644 --- a/lib/OpenLayers/Renderer/SVG.js +++ b/lib/OpenLayers/Renderer/SVG.js @@ -799,9 +799,9 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { * inside the valid range. * * Parameters: - * badComponent - {)} original geometry of the + * badComponent - {} original geometry of the * invalid point - * goodComponent - {)} original geometry of the + * goodComponent - {} original geometry of the * valid point * Returns * {String} the SVG coordinate pair of the clipped point (like diff --git a/lib/OpenLayers/Util.js b/lib/OpenLayers/Util.js index 4c9cd014da..45f19aa821 100644 --- a/lib/OpenLayers/Util.js +++ b/lib/OpenLayers/Util.js @@ -22,6 +22,11 @@ OpenLayers.Util = OpenLayers.Util || {}; /** * Function: getElement * This is the old $() from prototype + * + * Parameters: + * e - {String or DOMElement or Window} + * Return: + * {Array(DOMElement)} */ OpenLayers.Util.getElement = function() { var elements = []; @@ -105,7 +110,7 @@ OpenLayers.Util.clearArray = function(array) { * * Parameters: * array - {Array} - * obj - {Object} + * obj - {*} * * Returns: * {Integer} The index at, which the first object was found in the array. @@ -134,6 +139,7 @@ OpenLayers.Util.indexOf = function(array, obj) { * null to an individual parameter will avoid setting the attribute. * * Parameters: + * element - {DOMElement} DOM element to modify. * id - {String} The element id attribute to set. * px - {} The left and top style position. * sz - {} The width and height style attributes. @@ -404,6 +410,7 @@ OpenLayers.Util.alphaHack = function() { /** * Function: modifyAlphaImageDiv * + * Parameters: * div - {DOMElement} Div containing Alpha-adjusted Image * id - {String} * px - {} @@ -411,7 +418,7 @@ OpenLayers.Util.alphaHack = function() { * imgURL - {String} * position - {String} * border - {String} - * sizing {String} 'crop', 'scale', or 'image'. Default is "scale" + * sizing - {String} 'crop', 'scale', or 'image'. Default is "scale" * opacity - {Float} Fractional value (0.0 - 1.0) */ OpenLayers.Util.modifyAlphaImageDiv = function(div, id, px, sz, imgURL, @@ -452,6 +459,7 @@ OpenLayers.Util.modifyAlphaImageDiv = function(div, id, px, sz, imgURL, /** * Function: createAlphaImageDiv * + * Parameters: * id - {String} * px - {} * sz - {} @@ -938,7 +946,7 @@ OpenLayers.Util.distVincenty = function(p1, p2) { * lonlat - {} (or any object with both .lat, .lon * properties) The start point. * brng - {Float} The bearing (degrees). - * distance - {Float} The ground distance (meters). + * dist - {Float} The ground distance (meters). * * Returns: * {} The destination point. @@ -1663,6 +1671,8 @@ OpenLayers.Util.getBrowserName = function() { * useful in the case where we have a limit in one dimension and must * therefore meaure the flow in the other dimension. * options - {Object} + * + * Allowed Options: * displayClass - {String} Optional parameter. A CSS class name(s) string * to provide the CSS context of the rendered content. * containerElement - {DOMElement} Optional parameter. Insert the HTML to