From c2148651ed948f3dfc90f2b71d404f44c77889af Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Wed, 29 Aug 2007 18:44:10 +0000 Subject: [PATCH] Filling our log with cruft, adding meaningless conflicts for merges, and changing a comment style that ndocs could care less about, this commit changes Return to Returns (closes #945). git-svn-id: http://svn.openlayers.org/trunk/openlayers@4110 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf --- lib/OpenLayers.js | 2 +- lib/OpenLayers/Ajax.js | 18 ++++---- lib/OpenLayers/BaseTypes.js | 16 +++---- lib/OpenLayers/BaseTypes/Bounds.js | 44 +++++++++--------- lib/OpenLayers/BaseTypes/Class.js | 4 +- lib/OpenLayers/BaseTypes/Element.js | 8 ++-- lib/OpenLayers/BaseTypes/LonLat.js | 14 +++--- lib/OpenLayers/BaseTypes/Pixel.js | 12 ++--- lib/OpenLayers/BaseTypes/Size.js | 6 +-- lib/OpenLayers/Control.js | 6 +-- lib/OpenLayers/Control/DragFeature.js | 4 +- lib/OpenLayers/Control/LayerSwitcher.js | 4 +- lib/OpenLayers/Control/MouseDefaults.js | 2 +- lib/OpenLayers/Control/OverviewMap.js | 10 ++--- lib/OpenLayers/Control/PanZoom.js | 7 +-- lib/OpenLayers/Control/Panel.js | 3 +- lib/OpenLayers/Control/Permalink.js | 3 +- lib/OpenLayers/Control/Scale.js | 3 +- lib/OpenLayers/Events.js | 4 +- lib/OpenLayers/Feature.js | 8 ++-- lib/OpenLayers/Feature/Vector.js | 10 ++--- lib/OpenLayers/Feature/WFS.js | 2 +- lib/OpenLayers/Format.js | 6 +-- lib/OpenLayers/Format/GML.js | 8 ++-- lib/OpenLayers/Format/GeoJSON.js | 40 ++++++++--------- lib/OpenLayers/Format/GeoRSS.js | 2 +- lib/OpenLayers/Format/JSON.js | 22 ++++----- lib/OpenLayers/Format/KML.js | 2 +- lib/OpenLayers/Format/WKT.js | 6 +-- lib/OpenLayers/Format/XML.js | 16 +++---- lib/OpenLayers/Geometry.js | 12 ++--- lib/OpenLayers/Geometry/Collection.js | 12 ++--- lib/OpenLayers/Geometry/Curve.js | 2 +- lib/OpenLayers/Geometry/LinearRing.js | 4 +- lib/OpenLayers/Geometry/MultiPoint.js | 2 +- lib/OpenLayers/Geometry/Point.js | 6 +-- lib/OpenLayers/Geometry/Polygon.js | 2 +- lib/OpenLayers/Geometry/Rectangle.js | 4 +- lib/OpenLayers/Handler.js | 6 +-- lib/OpenLayers/Handler/Drag.js | 14 +++--- lib/OpenLayers/Handler/Feature.js | 7 +-- lib/OpenLayers/Handler/MouseWheel.js | 2 +- lib/OpenLayers/Handler/Path.js | 14 +++--- lib/OpenLayers/Handler/Point.js | 11 ++--- lib/OpenLayers/Handler/Polygon.js | 2 +- lib/OpenLayers/Icon.js | 4 +- lib/OpenLayers/Layer.js | 24 +++++----- lib/OpenLayers/Layer/EventPane.js | 14 +++--- lib/OpenLayers/Layer/FixedZoomLevels.js | 10 ++--- lib/OpenLayers/Layer/Google.js | 32 +++++++------- lib/OpenLayers/Layer/Grid.js | 6 +-- lib/OpenLayers/Layer/HTTPRequest.js | 6 +-- lib/OpenLayers/Layer/Image.js | 2 +- lib/OpenLayers/Layer/KaMap.js | 6 +-- lib/OpenLayers/Layer/MapServer.js | 8 ++-- lib/OpenLayers/Layer/Markers.js | 2 +- lib/OpenLayers/Layer/MultiMap.js | 22 ++++----- lib/OpenLayers/Layer/TMS.js | 6 +-- lib/OpenLayers/Layer/TileCache.js | 8 ++-- lib/OpenLayers/Layer/Vector.js | 6 +-- lib/OpenLayers/Layer/VirtualEarth.js | 22 ++++----- lib/OpenLayers/Layer/WFS.js | 2 +- lib/OpenLayers/Layer/WMS.js | 8 ++-- lib/OpenLayers/Layer/WorldWind.js | 2 +- lib/OpenLayers/Layer/Yahoo.js | 28 ++++++------ lib/OpenLayers/Map.js | 59 +++++++++++++------------ lib/OpenLayers/Marker.js | 6 +-- lib/OpenLayers/Marker/Box.js | 2 +- lib/OpenLayers/Popup.js | 4 +- lib/OpenLayers/Popup/Anchored.js | 6 +-- lib/OpenLayers/Popup/AnchoredBubble.js | 4 +- lib/OpenLayers/Renderer.js | 6 +-- lib/OpenLayers/Renderer/Elements.js | 6 +-- lib/OpenLayers/Renderer/SVG.js | 14 +++--- lib/OpenLayers/Renderer/VML.js | 12 ++--- lib/OpenLayers/Tile.js | 4 +- lib/OpenLayers/Tile/Image.js | 2 +- lib/OpenLayers/Util.js | 50 ++++++++++----------- 78 files changed, 397 insertions(+), 388 deletions(-) diff --git a/lib/OpenLayers.js b/lib/OpenLayers.js index 41b65b9864..c9033fbf65 100644 --- a/lib/OpenLayers.js +++ b/lib/OpenLayers.js @@ -31,7 +31,7 @@ * Function: _getScriptLocation * Return the path to this script. * - * Return: + * Returns: * Path to this script */ _getScriptLocation: function () { diff --git a/lib/OpenLayers/Ajax.js b/lib/OpenLayers/Ajax.js index 00b4ba4d2f..63a3651e89 100644 --- a/lib/OpenLayers/Ajax.js +++ b/lib/OpenLayers/Ajax.js @@ -80,7 +80,7 @@ OpenLayers.loadURL = function(uri, params, caller, * Parameters: * text - {String} * - * Return: + * Returns: * {?} Parsed AJAX Responsev */ OpenLayers.parseXMLString = function(text) { @@ -129,7 +129,7 @@ OpenLayers.Ajax = { /** * Method: getTransport * - * Return: + * Returns: * {Object} Transport mechanism for whichever browser we're in, or false if * none available. */ @@ -239,7 +239,7 @@ OpenLayers.Ajax.Base.prototype = { /** * Function: responseIsSuccess * - * Return: + * Returns: * {Boolean} */ responseIsSuccess: function() { @@ -251,7 +251,7 @@ OpenLayers.Ajax.Base.prototype = { /** * Function: responseIsFailure * - * Return: + * Returns: * {Boolean} */ responseIsFailure: function() { @@ -379,7 +379,7 @@ OpenLayers.Ajax.Request = OpenLayers.Class(OpenLayers.Ajax.Base, { /** * Method: header * - * Return: + * Returns: * {?} */ header: function(name) { @@ -391,7 +391,7 @@ OpenLayers.Ajax.Request = OpenLayers.Class(OpenLayers.Ajax.Base, { /** * Method: evalJSON * - * Return: + * Returns: * {?} */ evalJSON: function() { @@ -403,7 +403,7 @@ OpenLayers.Ajax.Request = OpenLayers.Class(OpenLayers.Ajax.Base, { /** * Method: evalResponse * - * Return: + * Returns: * {?} */ evalResponse: function() { @@ -495,7 +495,7 @@ OpenLayers.Ajax.Request.Events = * nsprefix - {?} * tagname - {?} * - * Return: + * Returns: * {?} */ OpenLayers.Ajax.getElementsByTagNameNS = function(parentnode, nsuri, @@ -519,7 +519,7 @@ OpenLayers.Ajax.getElementsByTagNameNS = function(parentnode, nsuri, * Parameters: * xmldom {XMLNode} xml dom to serialize * - * Return: + * Returns: * {?} */ OpenLayers.Ajax.serializeXMLToString = function(xmldom) { diff --git a/lib/OpenLayers/BaseTypes.js b/lib/OpenLayers/BaseTypes.js index 72e5748c5d..ccaf6728c1 100644 --- a/lib/OpenLayers/BaseTypes.js +++ b/lib/OpenLayers/BaseTypes.js @@ -21,7 +21,7 @@ * Parameters: * sStart - {Sring} The string we're testing for. * - * Return: + * Returns: * {Boolean} Whether or not this string starts with the string passed in. */ String.prototype.startsWith = function(sStart) { @@ -35,7 +35,7 @@ String.prototype.startsWith = function(sStart) { * Parameters: * str - {String} The string that we're testing for. * - * Return: + * Returns: * {Boolean} Whether or not this string contains with the string passed in. */ String.prototype.contains = function(str) { @@ -46,7 +46,7 @@ String.prototype.contains = function(str) { * APIMethod: String.trim * Removes leading and trailing whitespace characters from a string. * - * Return: + * Returns: * {String} A trimmed version of the string - all leading and * trailing spaces removed */ @@ -72,7 +72,7 @@ String.prototype.trim = function() { * Parameters: * object - {Object} Can be a string or a number * - * Return: + * Returns: * {Integer} The index of the encountered object, or -1 if not found. */ String.indexOf = function(object) { @@ -92,7 +92,7 @@ String.indexOf = function(object) { * Ex. "chicken-head" becomes "chickenHead", and * "-chicken-head" becomes "ChickenHead". * - * Return: + * Returns: * {String} The string, camelized */ String.prototype.camelize = function() { @@ -120,7 +120,7 @@ String.prototype.camelize = function() { * Parameters: * sig - {Integer} * - * Return: + * Returns: * {Integer} The number, rounded to the specified number of significant digits. * If null, 0, or negative value passed in, returns 0 */ @@ -153,7 +153,7 @@ Number.prototype.limitSigDigs = function(sig) { * Parameters: * object - {Object} the this parameter * - * Return: + * Returns: * {Function} A closure with 'this' altered to the first * argument. */ @@ -187,7 +187,7 @@ Function.prototype.bind = function() { * Parameters: * object - {Object} A reference to this. * - * Return: + * Returns: * {Function} */ Function.prototype.bindAsEventListener = function(object) { diff --git a/lib/OpenLayers/BaseTypes/Bounds.js b/lib/OpenLayers/BaseTypes/Bounds.js index 49a330512e..511e97868a 100644 --- a/lib/OpenLayers/BaseTypes/Bounds.js +++ b/lib/OpenLayers/BaseTypes/Bounds.js @@ -71,7 +71,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * Method: clone * Create a cloned instance of this bounds. * - * Return: + * Returns: * {} A fresh copy of the bounds */ clone:function() { @@ -86,7 +86,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * Parameters: * bounds - {} * - * Return: + * Returns: * {Boolean} The passed-in OpenLayers.Bounds object has the same left, * right, top, bottom components as this. Note that if bounds * passed in is null, returns false. @@ -105,7 +105,7 @@ OpenLayers.Bounds = OpenLayers.Class({ /** * APIMethod: toString * - * Return: + * Returns: * {String} String representation of OpenLayers.Bounds object. * (ex."left-bottom=(5,42) right-top=(10,45)") */ @@ -117,7 +117,7 @@ OpenLayers.Bounds = OpenLayers.Class({ /** * APIMethod: toArray * - * Return: + * Returns: * {Array} array of left, bottom, right, top */ toArray: function() { @@ -131,7 +131,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * decimal - {Integer} How many significant digits in the bbox coords? * Default is 6 * - * Return: + * Returns: * {String} Simple String representation of OpenLayers.Bounds object. * (ex. "5,42,10,45") */ @@ -151,7 +151,7 @@ OpenLayers.Bounds = OpenLayers.Class({ /** * APIMethod: getWidth * - * Return: + * Returns: * {Float} The width of the bounds */ getWidth:function() { @@ -161,7 +161,7 @@ OpenLayers.Bounds = OpenLayers.Class({ /** * APIMethod: getHeight * - * Return: + * Returns: * {Float} The height of the bounds */ getHeight:function() { @@ -171,7 +171,7 @@ OpenLayers.Bounds = OpenLayers.Class({ /** * APIMethod: getSize * - * Return: + * Returns: * {} An which represents the size of the box */ getSize:function() { @@ -181,7 +181,7 @@ OpenLayers.Bounds = OpenLayers.Class({ /** * APIMethod: getCenterPixel * - * Return: + * Returns: * {} An which represents the center * of the bounds */ @@ -193,7 +193,7 @@ OpenLayers.Bounds = OpenLayers.Class({ /** * APIMethod: getCenterLonLat * - * Return: + * Returns: * {} An which represents the center * of the bounds */ @@ -209,7 +209,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * x - {Float} * y - {Float} * - * Return: + * Returns: * {} A new whose coordinates are * the same as this, but shifted by the passed-in * x and y values @@ -276,7 +276,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * inclusive - {Boolean} Whether or not to include the border. * Default is true. * - * Return: + * Returns: * {Boolean} Whether or not the passed-in lonlat is within this bounds. */ containsLonLat:function(ll, inclusive) { @@ -291,7 +291,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * inclusive - {Boolean} Whether or not to include the border. * Default is true. * - * Return: + * Returns: * {Boolean} Whether or not the passed-in pixel is within this bounds. */ containsPixel:function(px, inclusive) { @@ -307,7 +307,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * inclusive - {Boolean} Whether or not to include the border. * Default is true. * - * Return: + * Returns: * {Boolean} Whether or not the passed-in coordinates are within this * bounds. */ @@ -337,7 +337,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * inclusive - {} Whether or not to include the border. * Default is true. * - * Return: + * Returns: * {Boolean} Whether or not the passed-in OpenLayers.Bounds object * intersects this bounds. Simple math just check if either * contains the other, allowing for partial. @@ -376,7 +376,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * inclusive - {} Whether or not to include the border. * Default is true. * - * Return: + * Returns: * {Boolean} Whether or not the passed-in OpenLayers.Bounds object is * contained within this bounds. */ @@ -417,7 +417,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * Parameters: * lonlat - {} * - * Return: + * Returns: * {String} The quadrant ("br" "tr" "tl" "bl") of the bounds in which * the coordinate lies. */ @@ -447,7 +447,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * this bound. * Default is 0. * - * Return: + * Returns: * {} A copy of this bounds, but wrapped around the * "dateline" (as specified by the borders of * maxExtent). Note that this function only returns @@ -494,7 +494,7 @@ OpenLayers.Bounds = OpenLayers.Class({ * Parameters: * str - {String}Comma-separated bounds string. (ex. "5,42,10,45") * - * Return: + * Returns: * {} New object built from the * passed-in String. */ @@ -511,7 +511,7 @@ OpenLayers.Bounds.fromString = function(str) { * Parameters: * bbox - {Array(Float)} Array of bounds values (ex. [5,42,10,45]) * - * Return: + * Returns: * {} New object built from the * passed-in Array. */ @@ -530,7 +530,7 @@ OpenLayers.Bounds.fromArray = function(bbox) { * Parameters: * size - {} * - * Return: + * Returns: * {} New object built from the * passed-in size. */ @@ -548,7 +548,7 @@ OpenLayers.Bounds.fromSize = function(size) { * Parameters: * quadrant - {String} two character quadrant shortstring * - * Return: + * Returns: * {String} The opposing quadrant ("br" "tr" "tl" "bl"). For Example, if * you pass in "bl" it returns "tr", if you pass in "br" it * returns "tl", etc. diff --git a/lib/OpenLayers/BaseTypes/Class.js b/lib/OpenLayers/BaseTypes/Class.js index b38e9d7e0d..664bbfb0b0 100644 --- a/lib/OpenLayers/BaseTypes/Class.js +++ b/lib/OpenLayers/BaseTypes/Class.js @@ -59,7 +59,7 @@ OpenLayers.Class.isPrototype = function () {}; * *Deprecated*. Old method to create an OpenLayers style class. Use the * constructor instead. * - * Return: + * Returns: * An OpenLayers class */ OpenLayers.Class.create = function() { @@ -78,7 +78,7 @@ OpenLayers.Class.create = function() { * Parameters: * class - One or more classes can be provided as arguments * - * Return: + * Returns: * An object prototype */ OpenLayers.Class.inherit = function () { diff --git a/lib/OpenLayers/BaseTypes/Element.js b/lib/OpenLayers/BaseTypes/Element.js index f976dd6cda..8b7dc2f267 100644 --- a/lib/OpenLayers/BaseTypes/Element.js +++ b/lib/OpenLayers/BaseTypes/Element.js @@ -13,7 +13,7 @@ OpenLayers.Element = { * Parameters: * element - {DOMElement} * - * Return: + * Returns: * {Boolean} Is the element visible? */ visible: function(element) { @@ -83,7 +83,7 @@ OpenLayers.Element = { * Parameters: * element - {DOMElement} * - * Return: + * Returns: * {Integer} The offset height of the element passed in */ getHeight: function(element) { @@ -97,7 +97,7 @@ OpenLayers.Element = { * Parameters: * element - {DOMElement} * - * Return: + * Returns: * {Object} Object with 'width' and 'height' properties which are the * dimensions of the element passed in. */ @@ -130,7 +130,7 @@ OpenLayers.Element = { * element - {DOMElement} * style - {?} * - * Return: + * Returns: * {?} */ getStyle: function(element, style) { diff --git a/lib/OpenLayers/BaseTypes/LonLat.js b/lib/OpenLayers/BaseTypes/LonLat.js index faece4b787..f881d65ee3 100644 --- a/lib/OpenLayers/BaseTypes/LonLat.js +++ b/lib/OpenLayers/BaseTypes/LonLat.js @@ -41,7 +41,7 @@ OpenLayers.LonLat = OpenLayers.Class({ * Method: toString * Return a readable string version of the lonlat * - * Return: + * Returns: * {String} String representation of OpenLayers.LonLat object. * (ex. "lon=5,lat=42") */ @@ -52,7 +52,7 @@ OpenLayers.LonLat = OpenLayers.Class({ /** * APIMethod: toShortString * - * Return: + * Returns: * {String} Shortened String representation of OpenLayers.LonLat object. * (ex. "5, 42") */ @@ -63,7 +63,7 @@ OpenLayers.LonLat = OpenLayers.Class({ /** * APIMethod: clone * - * Return: + * Returns: * {} New OpenLayers.LonLat object with the same lon * and lat values */ @@ -78,7 +78,7 @@ OpenLayers.LonLat = OpenLayers.Class({ * lon - {Float} * lat - {Float} * - * Return: + * Returns: * {} A new OpenLayers.LonLat object with the lon and * lat passed-in added to this's. */ @@ -98,7 +98,7 @@ OpenLayers.LonLat = OpenLayers.Class({ * Parameters: * ll - {} * - * Return: + * Returns: * {Boolean} Boolean value indicating whether the passed-in * object has the same lon and lat * components as this. @@ -119,7 +119,7 @@ OpenLayers.LonLat = OpenLayers.Class({ * Parameters: * maxExtent - {} * - * Return: + * Returns: * {} A copy of this lonlat, but wrapped around the * "dateline" (as specified by the borders of * maxExtent) @@ -155,7 +155,7 @@ OpenLayers.LonLat = OpenLayers.Class({ * str - {String} Comma-separated Lon,Lat coordinate string. * (ex. "5,40") * - * Return: + * Returns: * {} New object built from the * passed-in String. */ diff --git a/lib/OpenLayers/BaseTypes/Pixel.js b/lib/OpenLayers/BaseTypes/Pixel.js index 00a64091cb..028e16a959 100644 --- a/lib/OpenLayers/BaseTypes/Pixel.js +++ b/lib/OpenLayers/BaseTypes/Pixel.js @@ -28,7 +28,7 @@ OpenLayers.Pixel = OpenLayers.Class({ * x - {Number} The x coordinate * y - {Number} The y coordinate * - * Return: + * Returns: * An instance of OpenLayers.Pixel */ initialize: function(x, y) { @@ -40,7 +40,7 @@ OpenLayers.Pixel = OpenLayers.Class({ * Method: toString * Cast this object into a string * - * Return: + * Returns: * {String} The string representation of Pixel. ex: "x=200.4,y=242.2" */ toString:function() { @@ -51,7 +51,7 @@ OpenLayers.Pixel = OpenLayers.Class({ * APIMethod: clone * Return a clone of this pixel object * - * Return: + * Returns: * {} A clone pixel */ clone:function() { @@ -65,7 +65,7 @@ OpenLayers.Pixel = OpenLayers.Class({ * Parameters: * px - {} * - * Return: + * Returns: * {Boolean} The point passed in as parameter is equal to this. Note that * if px passed in is null, returns false. */ @@ -85,7 +85,7 @@ OpenLayers.Pixel = OpenLayers.Class({ * x - {Integer} * y - {Integer} * - * Return: + * Returns: * {} A new Pixel with this pixel's x&y augmented by the * values passed in. */ @@ -104,7 +104,7 @@ OpenLayers.Pixel = OpenLayers.Class({ * Parameters * px - {} * - * Return: + * Returns: * {} A new Pixel with this pixel's x&y augmented by the * x&y values of the pixel passed in. */ diff --git a/lib/OpenLayers/BaseTypes/Size.js b/lib/OpenLayers/BaseTypes/Size.js index a0d46f6110..9ff11a3d07 100644 --- a/lib/OpenLayers/BaseTypes/Size.js +++ b/lib/OpenLayers/BaseTypes/Size.js @@ -38,7 +38,7 @@ OpenLayers.Size = OpenLayers.Class({ * Method: toString * Return the string representation of a size object * - * Return: + * Returns: * {String} The string representation of OpenLayers.Size object. * (ex. "w=55,h=66") */ @@ -50,7 +50,7 @@ OpenLayers.Size = OpenLayers.Class({ * APIMethod: clone * Create a clone of this size object * - * Return: + * Returns: * {} A new OpenLayers.Size object with the same w and h * values */ @@ -66,7 +66,7 @@ OpenLayers.Size = OpenLayers.Class({ * Parameters: * sz - {} * - * Return: + * Returns: * {Boolean} The passed in size has the same h and w properties as this one. * Note that if sz passed in is null, returns false. * diff --git a/lib/OpenLayers/Control.js b/lib/OpenLayers/Control.js index 1287821cd0..03eb8f00fd 100644 --- a/lib/OpenLayers/Control.js +++ b/lib/OpenLayers/Control.js @@ -161,7 +161,7 @@ OpenLayers.Control = OpenLayers.Class({ * px - {} The top-left pixel position of the control * or null. * - * Return: + * Returns: * {DOMElement} A reference to the DIV DOMElement containing the control */ draw: function (px) { @@ -198,7 +198,7 @@ OpenLayers.Control = OpenLayers.Class({ * handler if one has been set. Controls can be * deactivated by calling the deactivate() method. * - * Return: + * Returns: * {Boolean} True if the control was successfully activated or * false if the control was already active. */ @@ -218,7 +218,7 @@ OpenLayers.Control = OpenLayers.Class({ * Deactivates a control and it's associated handler if any. The exact * effect of this depends on the control itself. * - * Return: + * Returns: * {Boolean} True if the control was effectively deactivated or false * if the control was already inactive. */ diff --git a/lib/OpenLayers/Control/DragFeature.js b/lib/OpenLayers/Control/DragFeature.js index 1e93abc9f4..9daf5b3b54 100644 --- a/lib/OpenLayers/Control/DragFeature.js +++ b/lib/OpenLayers/Control/DragFeature.js @@ -135,7 +135,7 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, { * APIMethod: activate * Activate the control and the feature handler. * - * Return: + * Returns: * {Boolean} Successfully activated the control and feature handler. */ activate: function() { @@ -147,7 +147,7 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, { * APIMethod: deactivate * Deactivate the control and all handlers. * - * Return: + * Returns: * {Boolean} Successfully deactivated the control. */ deactivate: function() { diff --git a/lib/OpenLayers/Control/LayerSwitcher.js b/lib/OpenLayers/Control/LayerSwitcher.js index 254f5b4e0a..d053eda69a 100644 --- a/lib/OpenLayers/Control/LayerSwitcher.js +++ b/lib/OpenLayers/Control/LayerSwitcher.js @@ -126,7 +126,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, { /** * Method: draw * - * Return: + * Returns: * {DOMElement} A reference to the DIV DOMElement containing the switcher * tabs */ @@ -175,7 +175,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, { * control to display that state. Groups base layers into a radio-button * group and lists each data layer with a checkbox. * - * Return: + * Returns: * {DOMElement} A reference to the DIV DOMElement containing the control */ redraw: function() { diff --git a/lib/OpenLayers/Control/MouseDefaults.js b/lib/OpenLayers/Control/MouseDefaults.js index 02f484872d..d4c92d2e49 100644 --- a/lib/OpenLayers/Control/MouseDefaults.js +++ b/lib/OpenLayers/Control/MouseDefaults.js @@ -98,7 +98,7 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, { * Parameters: * evt - {Event} * - * Return: + * Returns: * {Boolean} */ defaultClick: function (evt) { diff --git a/lib/OpenLayers/Control/OverviewMap.js b/lib/OpenLayers/Control/OverviewMap.js index d9b01618c8..df33085aa7 100644 --- a/lib/OpenLayers/Control/OverviewMap.js +++ b/lib/OpenLayers/Control/OverviewMap.js @@ -555,7 +555,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, { * Method: getRectPxBounds * Get extent rectangle pixel bounds * - * Return: + * Returns: * {} A bounds which is the extent rectangle's pixel * bounds (relative to the parent element) */ @@ -594,7 +594,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, { * Parameters: * lonLatBounds - {} * - * Return: + * Returns: * {}A bounds which is the passed-in map lon/lat extent * translated into pixel bounds for the overview map */ @@ -620,7 +620,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, { * Parameters: * pxBounds - {} * - * Return: + * Returns: * {} Bounds which is the passed-in overview rect bounds * translated into lon/lat bounds for the overview map */ @@ -642,7 +642,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, { * Parameters: * overviewMapPx - {} * - * Return: + * Returns: * {} Location which is the passed-in overview map * OpenLayers.Pixel, translated into lon/lat by the overview map */ @@ -665,7 +665,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, { * Parameters: * lonlat - {} * - * Return: + * Returns: * {} Location which is the passed-in OpenLayers.LonLat, * translated into overview map pixels */ diff --git a/lib/OpenLayers/Control/PanZoom.js b/lib/OpenLayers/Control/PanZoom.js index c1d8572e19..945ee0fd8d 100644 --- a/lib/OpenLayers/Control/PanZoom.js +++ b/lib/OpenLayers/Control/PanZoom.js @@ -60,7 +60,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, { * Parameters: * px - {} * - * Return: + * Returns: * {DOMElement} A reference to the container div for the PanZoom control */ draw: function(px) { @@ -98,7 +98,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, { * xy - {} * sz - {} * - * Return: + * Returns: * {DOMElement} A Div (an alphaImageDiv, to be precise) that contains the * image of the button, and has all the proper event handlers set. */ @@ -132,7 +132,8 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, { * Parameters: * evt - {Event} * - * Return: {Boolean} + * Returns: + * {Boolean} */ doubleClick: function (evt) { OpenLayers.Event.stop(evt); diff --git a/lib/OpenLayers/Control/Panel.js b/lib/OpenLayers/Control/Panel.js index 719d73d72b..5b3e2d0cd2 100644 --- a/lib/OpenLayers/Control/Panel.js +++ b/lib/OpenLayers/Control/Panel.js @@ -82,7 +82,8 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, { /** * Method: draw * - * Return: {DOMElement} + * Returns: + * {DOMElement} */ draw: function() { OpenLayers.Control.prototype.draw.apply(this, arguments); diff --git a/lib/OpenLayers/Control/Permalink.js b/lib/OpenLayers/Control/Permalink.js index b288f7c1dd..d22b945be4 100644 --- a/lib/OpenLayers/Control/Permalink.js +++ b/lib/OpenLayers/Control/Permalink.js @@ -78,7 +78,8 @@ OpenLayers.Control.Permalink = OpenLayers.Class(OpenLayers.Control, { /** * Method: draw * - * Return: {DOMElement} + * Returns: + * {DOMElement} */ draw: function() { OpenLayers.Control.prototype.draw.apply(this, arguments); diff --git a/lib/OpenLayers/Control/Scale.js b/lib/OpenLayers/Control/Scale.js index 6434aa2142..c8d8e3c9b8 100644 --- a/lib/OpenLayers/Control/Scale.js +++ b/lib/OpenLayers/Control/Scale.js @@ -34,7 +34,8 @@ OpenLayers.Control.Scale = OpenLayers.Class(OpenLayers.Control, { /** * Method: draw * - * Return: {DOMElemen} + * Returns: + * {DOMElemen} */ draw: function() { OpenLayers.Control.prototype.draw.apply(this, arguments); diff --git a/lib/OpenLayers/Events.js b/lib/OpenLayers/Events.js index 21d4dbc3d9..bbfb846302 100644 --- a/lib/OpenLayers/Events.js +++ b/lib/OpenLayers/Events.js @@ -138,7 +138,7 @@ OpenLayers.Event = { * event - {Event} * tagName - {String} * - * Return: + * Returns: * {DOMElement} The first node with the given tagName, starting from the * node the event was triggered on and traversing the DOM upwards */ @@ -252,7 +252,7 @@ OpenLayers.Event = { * observer - {function} * useCapture - {Boolean} * - * Return: + * Returns: * {Boolean} Whether or not the event observer was removed */ stopObserving: function(elementParam, name, observer, useCapture) { diff --git a/lib/OpenLayers/Feature.js b/lib/OpenLayers/Feature.js index 0bd84ddd50..2ab1a19020 100644 --- a/lib/OpenLayers/Feature.js +++ b/lib/OpenLayers/Feature.js @@ -58,7 +58,7 @@ OpenLayers.Feature = OpenLayers.Class({ * lonlat - {} * data - {Object} * - * Return: + * Returns: * {} */ initialize: function(layer, lonlat, data) { @@ -98,7 +98,7 @@ OpenLayers.Feature = OpenLayers.Class({ /** * Method: onScreen * - * Return: + * Returns: * {Boolean} Whether or not the feature is currently visible on screen * (based on its 'lonlat' property) */ @@ -117,7 +117,7 @@ OpenLayers.Feature = OpenLayers.Class({ * Method: createMarker * Based on the data associated with the Feature, create and return a marker object. * - * Return: + * Returns: * {} A Marker Object created from the 'lonlat' and 'icon' properties * set in this.data. If no 'lonlat' is set, returns null. If no * 'icon' is set, OpenLayers.Marker() will load the default image. @@ -157,7 +157,7 @@ OpenLayers.Feature = OpenLayers.Class({ * Parameters: * closeBox - {Boolean} create popup with closebox or not * - * Return: + * Returns: * {} * */ diff --git a/lib/OpenLayers/Feature/Vector.js b/lib/OpenLayers/Feature/Vector.js index 0b54dca09f..431038c59f 100644 --- a/lib/OpenLayers/Feature/Vector.js +++ b/lib/OpenLayers/Feature/Vector.js @@ -101,7 +101,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { * Create a clone of this vector feature. Does not set any non-standard * properties. * - * Return: + * Returns: * {} An exact clone of this vector feature. */ clone: function () { @@ -114,7 +114,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { * Method: onScreen * HACK - we need to rewrite this for non-point geometry * - * Return: + * Returns: * {Boolean} For now just returns null */ onScreen:function() { @@ -126,7 +126,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { * HACK - we need to decide if all vector features should be able to * create markers * - * Return: + * Returns: * {} For now just returns null */ createMarker: function() { @@ -150,7 +150,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { * HACK - we need to decide if all vector features should be able to * create popups * - * Return: + * Returns: * {} For now just returns null */ createPopup: function() { @@ -166,7 +166,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { * toleranceLon - {float} Optional tolerance in Geometric Coords * toleranceLat - {float} Optional tolerance in Geographic Coords * - * Return: + * Returns: * {Boolean} Whether or not the feature is at the specified location */ atPoint: function(lonlat, toleranceLon, toleranceLat) { diff --git a/lib/OpenLayers/Feature/WFS.js b/lib/OpenLayers/Feature/WFS.js index f84fe93cd4..b2b974e32e 100644 --- a/lib/OpenLayers/Feature/WFS.js +++ b/lib/OpenLayers/Feature/WFS.js @@ -54,7 +54,7 @@ OpenLayers.Feature.WFS = OpenLayers.Class(OpenLayers.Feature, { * Parameters: * xmlNode - {XMLNode} * - * Return: + * Returns: * {Object} Data Object with 'id', 'lonlat', and private properties set */ processXMLNode: function(xmlNode) { diff --git a/lib/OpenLayers/Format.js b/lib/OpenLayers/Format.js index 87b2a0cbfd..2339aa11f7 100644 --- a/lib/OpenLayers/Format.js +++ b/lib/OpenLayers/Format.js @@ -19,7 +19,7 @@ OpenLayers.Format = OpenLayers.Class({ * options - {Object} An optional object with properties to set on the * format * - * Return: + * Returns: * An instance of OpenLayers.Format */ initialize: function(options) { @@ -34,7 +34,7 @@ OpenLayers.Format = OpenLayers.Class({ * Parameters: * data - {string} Data to read/parse. * - * Return: + * Returns: * Depends on the subclass */ read: function(data) { @@ -48,7 +48,7 @@ OpenLayers.Format = OpenLayers.Class({ * Parameters: * object - {Object} Object to be serialized * - * Return: + * Returns: * {String} A string representation of the object. */ write: function(object) { diff --git a/lib/OpenLayers/Format/GML.js b/lib/OpenLayers/Format/GML.js index d937f89647..c339ad201b 100644 --- a/lib/OpenLayers/Format/GML.js +++ b/lib/OpenLayers/Format/GML.js @@ -264,7 +264,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * xmlNode - {XMLNode} * - * Return: + * Returns: * {} polygon geometry */ parsePolygonNode: function(polygonNode) { @@ -291,7 +291,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * xmlNode - {} * - * Return: + * Returns: * An array of points. */ parseCoords: function(xmlNode) { @@ -365,7 +365,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * feature - {} * - * Return: + * Returns: * {DOMElement} */ createFeatureXML: function(feature) { @@ -475,7 +475,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * geometry - {} * - * Return: + * Returns: * {XmlNode} created xmlNode */ buildCoordinatesNode: function(geometry) { diff --git a/lib/OpenLayers/Format/GeoJSON.js b/lib/OpenLayers/Format/GeoJSON.js index 8156dbfd88..90987b34f0 100644 --- a/lib/OpenLayers/Format/GeoJSON.js +++ b/lib/OpenLayers/Format/GeoJSON.js @@ -42,7 +42,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * reform generic objects into instances of classes, or to transform * date strings into Date objects. * - * Return: + * Returns: * {Object} The return depends on the value of the type argument. If type * is "FeatureCollection" (the default), the return will be an array * of . If type is "Geometry", the input json @@ -147,7 +147,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Method: isValidType * Check if a GeoJSON object is a valid representative of the given type. * - * Return: + * Returns: * {Boolean} The object is valid GeoJSON object of the given type. */ isValidType: function(obj, type) { @@ -188,7 +188,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * obj - {Object} An object created from a GeoJSON object * - * Return: + * Returns: * {} A feature. */ parseFeature: function(obj) { @@ -214,7 +214,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * obj - {Object} An object created from a GeoJSON object * - * Return: + * Returns: * {} A geometry. */ parseGeometry: function(obj) { @@ -248,7 +248,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array - {Object} The coordinates array from the GeoJSON fragment. * - * Return: + * Returns: * {} A geometry. */ "point": function(array) { @@ -266,7 +266,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array {Object} The coordinates array from the GeoJSON fragment. * - * Return: + * Returns: * {} A geometry. */ "multipoint": function(array) { @@ -291,7 +291,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array - {Object} The coordinates array from the GeoJSON fragment. * - * Return: + * Returns: * {} A geometry. */ "linestring": function(array) { @@ -316,7 +316,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array - {Object} The coordinates array from the GeoJSON fragment. * - * Return: + * Returns: * {} A geometry. */ "multilinestring": function(array) { @@ -338,7 +338,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Convert a coordinate array from GeoJSON into an * . * - * Return: + * Returns: * {} A geometry. */ "polygon": function(array) { @@ -364,7 +364,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array - {Object} The coordinates array from the GeoJSON fragment. * - * Return: + * Returns: * {} A geometry. */ "multipolygon": function(array) { @@ -389,7 +389,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array - {Object} The coordinates array from the GeoJSON fragment. * - * Return: + * Returns: * {} A geometry. */ "box": function(array) { @@ -420,7 +420,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * pretty - {Boolean} Structure the output with newlines and indentation. * Default is false. * - * Return: + * Returns: * {String} The GeoJSON string representation of the input geometry, * features, array of geometries, or array of features. */ @@ -494,7 +494,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * feature - {} * - * Return: + * Returns: * {Object} An object representing the point. */ 'feature': function(feature) { @@ -514,7 +514,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * geometry - {} * - * Return: + * Returns: * {Object} An object representing the geometry. */ 'geometry': function(geometry) { @@ -533,7 +533,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * point - {} * - * Return: + * Returns: * {Array} An array of coordinates representing the point. */ 'point': function(point) { @@ -547,7 +547,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * multipoint - {} * - * Return: + * Returns: * {Array} An array of point coordinate arrays representing * the multipoint. */ @@ -566,7 +566,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * linestring - {} * - * Return: + * Returns: * {Array} An array of coordinate arrays representing * the linestring. */ @@ -585,7 +585,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * linestring - {} * - * Return: + * Returns: * {Array} An array of linestring arrays representing * the multilinestring. */ @@ -604,7 +604,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * polygon - {} * - * Return: + * Returns: * {Array} An array of linear ring arrays representing the polygon. */ 'polygon': function(polygon) { @@ -622,7 +622,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * multipolygon - {} * - * Return: + * Returns: * {Array} An array of polygon arrays representing * the multipolygon */ diff --git a/lib/OpenLayers/Format/GeoRSS.js b/lib/OpenLayers/Format/GeoRSS.js index bb55974fb1..047d91f4f7 100644 --- a/lib/OpenLayers/Format/GeoRSS.js +++ b/lib/OpenLayers/Format/GeoRSS.js @@ -67,7 +67,7 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format, { * Parameters: * feature - {} * - * Return: + * Returns: * {DOMElement} */ createFeatureXML: function(feature) { diff --git a/lib/OpenLayers/Format/JSON.js b/lib/OpenLayers/Format/JSON.js index a93f1bc82c..e79e16912b 100644 --- a/lib/OpenLayers/Format/JSON.js +++ b/lib/OpenLayers/Format/JSON.js @@ -80,7 +80,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * reform generic objects into instances of classes, or to transform * date strings into Date objects. * - * Return: + * Returns: * {Object} An object, array, string, or number . */ read: function(json, filter) { @@ -141,7 +141,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * pretty - {Boolean} Structure the output with newlines and indentation. * Default is false. * - * Return: + * Returns: * {String} The JSON string representation of the input value. */ write: function(value, pretty) { @@ -158,7 +158,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Method: writeIndent * Output an indentation string depending on the indentation level. * - * Return: + * Returns: * {String} An appropriate indentation string. */ writeIndent: function() { @@ -175,7 +175,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Method: writeNewline * Output a string representing a newline if in pretty printing mode. * - * Return: + * Returns: * {String} A string representing a new line. */ writeNewline: function() { @@ -186,7 +186,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Method: writeSpace * Output a string representing a space if in pretty printing mode. * - * Return: + * Returns: * {String} A space. */ writeSpace: function() { @@ -206,7 +206,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Parameters: * object - {Object} The object to be serialized. * - * Return: + * Returns: * {String} A JSON string representing the object. */ 'object': function(object) { @@ -255,7 +255,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Parameters: * array - {Array} The array to be serialized * - * Return: + * Returns: * {String} A JSON string representing the array. */ 'array': function(array) { @@ -287,7 +287,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Parameters * string - {String} The string to be serialized * - * Return: + * Returns: * {String} A JSON string representing the string. */ 'string': function(string) { @@ -326,7 +326,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Parameters: * number - {Number} The number to be serialized. * - * Return: + * Returns: * {String} A JSON string representing the number. */ 'number': function(number) { @@ -340,7 +340,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Parameters: * bool - {Boolean} The boolean to be serialized. * - * Return: + * Returns: * {String} A JSON string representing the boolean. */ 'boolean': function(bool) { @@ -354,7 +354,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Parameters: * date - {Date} The date to be serialized. * - * Return: + * Returns: * {String} A JSON string representing the date. */ 'date': function(date) { diff --git a/lib/OpenLayers/Format/KML.js b/lib/OpenLayers/Format/KML.js index ad068d4b40..a2aaa7b3ec 100644 --- a/lib/OpenLayers/Format/KML.js +++ b/lib/OpenLayers/Format/KML.js @@ -148,7 +148,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * xmlNode - {} * - * Return: + * Returns: * An array of points. */ parseCoords: function(xmlNode) { diff --git a/lib/OpenLayers/Format/WKT.js b/lib/OpenLayers/Format/WKT.js index 0dc36a2983..18f2925726 100644 --- a/lib/OpenLayers/Format/WKT.js +++ b/lib/OpenLayers/Format/WKT.js @@ -22,7 +22,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, { * options - {Object} An optional object whose properties will be set on * this instance * - * Return: + * Returns: * {} A new WKT parser. */ initialize: function(options) { @@ -46,7 +46,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, { * Parameters: * wkt - {String} A WKT string * - * Return: + * Returns: * {|Array} A feature or array of features for * GEOMETRYCOLLECTION WKT. */ @@ -71,7 +71,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, { * features - {|Array} A feature or array of * features * - * Return: + * Returns: * {String} The WKT string representation of the input geometries */ write: function(features) { diff --git a/lib/OpenLayers/Format/XML.js b/lib/OpenLayers/Format/XML.js index 754d5eb795..3d90c837b8 100644 --- a/lib/OpenLayers/Format/XML.js +++ b/lib/OpenLayers/Format/XML.js @@ -53,7 +53,7 @@ OpenLayers.Format.XML.prototype = * Parameters: * text - {String} A XML string - * Return: + * Returns: * {DOMElement} A DOM node */ read: function(text) { @@ -101,7 +101,7 @@ OpenLayers.Format.XML.prototype = * Parameters: * node - {DOMElement} A DOM node. * - * Return: + * Returns: * {String} The XML string representation of the input node. */ write: function(node) { @@ -126,7 +126,7 @@ OpenLayers.Format.XML.prototype = * uri - {String} Namespace URI for the element. * name - {String} The qualified name of the element (prefix:localname). * - * Return: + * Returns: * {Element} A DOM element with namespace. */ createElementNS: function(uri, name) { @@ -148,7 +148,7 @@ OpenLayers.Format.XML.prototype = * Parameters: * text - {String} The text of the node. * - * Return: + * Returns: * {DOMElement} A DOM text node. */ createTextNode: function(text) { @@ -173,7 +173,7 @@ OpenLayers.Format.XML.prototype = * uri - {String} Namespace URI. * name - {String} Local name of the tag (without the prefix). * - * Return: + * Returns: * {NodeList} A node list or array of elements. */ getElementsByTagNameNS: function(node, uri, name) { @@ -207,7 +207,7 @@ OpenLayers.Format.XML.prototype = * uri - {String} Namespace URI. * name - {String} Local name of the attribute (without the prefix). * - * Return: + * Returns: * {DOMElement} An attribute node or null if none found. */ getAttributeNodeNS: function(node, uri, name) { @@ -241,7 +241,7 @@ OpenLayers.Format.XML.prototype = * uri - {String} Namespace URI. * name - {String} Local name of the attribute (without the prefix). * - * Return: + * Returns: * {String} An attribute value or and empty string if none found. */ getAttributeNS: function(node, uri, name) { @@ -267,7 +267,7 @@ OpenLayers.Format.XML.prototype = * uri - {String} Namespace URI. * name - {String} Local name of the attribute (without the prefix). * - * Return: + * Returns: * {Boolean} The node has an attribute matching the name and namespace. */ hasAttributeNS: function(node, uri, name) { diff --git a/lib/OpenLayers/Geometry.js b/lib/OpenLayers/Geometry.js index d1c5af7cca..481c3e2da5 100644 --- a/lib/OpenLayers/Geometry.js +++ b/lib/OpenLayers/Geometry.js @@ -54,7 +54,7 @@ OpenLayers.Geometry = OpenLayers.Class({ * Create a clone of this geometry. Does not set any non-standard * properties of the cloned geometry. * - * Return: + * Returns: * {} An exact clone of this geometry. */ clone: function() { @@ -106,7 +106,7 @@ OpenLayers.Geometry = OpenLayers.Class({ * Get the bounds for this Geometry. If bounds is not set, it * is calculated again, this makes queries faster. * - * Return: + * Returns: * {} */ getBounds: function() { @@ -136,7 +136,7 @@ OpenLayers.Geometry = OpenLayers.Class({ * toleranceLon - {float} Optional tolerance in Geometric Coords * toleranceLat - {float} Optional tolerance in Geographic Coords * - * Return: + * Returns: * {Boolean} Whether or not the geometry is at the specified location */ atPoint: function(lonlat, toleranceLon, toleranceLat) { @@ -163,7 +163,7 @@ OpenLayers.Geometry = OpenLayers.Class({ * Calculate the length of this geometry. This method is defined in * subclasses. * - * Return: + * Returns: * {Float} The length of the collection by summing its parts */ getLength: function() { @@ -176,7 +176,7 @@ OpenLayers.Geometry = OpenLayers.Class({ * Method: getArea * Calculate the area of this geometry. This method is defined in subclasses. * - * Return: + * Returns: * {Float} The area of the collection by summing its parts */ getArea: function() { @@ -189,7 +189,7 @@ OpenLayers.Geometry = OpenLayers.Class({ * Method: toString * Returns the Well-Known Text representation of a geometry * - * Return: + * Returns: * {String} Well-Known Text */ toString: function() { diff --git a/lib/OpenLayers/Geometry/Collection.js b/lib/OpenLayers/Geometry/Collection.js index 0ba547380f..537f1776a5 100644 --- a/lib/OpenLayers/Geometry/Collection.js +++ b/lib/OpenLayers/Geometry/Collection.js @@ -67,7 +67,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * APIMethod: clone * Clone this geometry. * - * Return: + * Returns: * {} An exact clone of this collection */ clone: function() { @@ -86,7 +86,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * Method: getComponentsString * Get a string representing the components for this collection * - * Return: + * Returns: * {String} A string representation of the components of this geometry */ getComponentsString: function(){ @@ -139,7 +139,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * component - {} A geometry to add * index - {int} Optional index into the array to insert the component * - * Return: + * Returns: * {Boolean} The component geometry was successfully added */ addComponent: function(component, index) { @@ -202,7 +202,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * APIMethod: getLength * Calculate the length of this geometry * - * Return: + * Returns: * {Float} The length of the geometry */ getLength: function() { @@ -218,7 +218,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * Calculate the area of this geometry. Note how this function is overridden * in . * - * Return: + * Returns: * {Float} The area of the collection by summing its parts */ getArea: function() { @@ -283,7 +283,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * Parameters: * geometry - {} * - * Return: + * Returns: * {Boolean} The coordinates are equivalent */ equals: function(geometry) { diff --git a/lib/OpenLayers/Geometry/Curve.js b/lib/OpenLayers/Geometry/Curve.js index a27ab4a491..5a618031f2 100644 --- a/lib/OpenLayers/Geometry/Curve.js +++ b/lib/OpenLayers/Geometry/Curve.js @@ -37,7 +37,7 @@ OpenLayers.Geometry.Curve = OpenLayers.Class(OpenLayers.Geometry.MultiPoint, { /** * APIMethod: getLength * - * Return: + * Returns: * {Float} The length of the curve */ getLength: function() { diff --git a/lib/OpenLayers/Geometry/LinearRing.js b/lib/OpenLayers/Geometry/LinearRing.js index 1981cd9e6c..5fab92e419 100644 --- a/lib/OpenLayers/Geometry/LinearRing.js +++ b/lib/OpenLayers/Geometry/LinearRing.js @@ -58,7 +58,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class( * point - {} * index - {Integer} Index into the array to insert the component * - * Return: + * Returns: * {Boolean} Was the Point successfully added? */ addComponent: function(point, index) { @@ -157,7 +157,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class( * Note - The area is positive if the ring is oriented CW, otherwise * it will be negative. * - * Return: + * Returns: * {Float} The signed area for a ring. */ getArea: function() { diff --git a/lib/OpenLayers/Geometry/MultiPoint.js b/lib/OpenLayers/Geometry/MultiPoint.js index 81deabf244..4c851343db 100644 --- a/lib/OpenLayers/Geometry/MultiPoint.js +++ b/lib/OpenLayers/Geometry/MultiPoint.js @@ -31,7 +31,7 @@ OpenLayers.Geometry.MultiPoint = OpenLayers.Class( * Parameters: * components - Array({}) * - * Return: + * Returns: * {} */ initialize: function(components) { diff --git a/lib/OpenLayers/Geometry/Point.js b/lib/OpenLayers/Geometry/Point.js index 917251a462..9136a05b73 100644 --- a/lib/OpenLayers/Geometry/Point.js +++ b/lib/OpenLayers/Geometry/Point.js @@ -44,7 +44,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, { /** * APIMethod: clone * - * Return: + * Returns: * {} An exact clone of this OpenLayers.Geometry.Point */ clone: function(obj) { @@ -91,7 +91,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, { * Parameters: * xy - {} * - * Return: + * Returns: * {Boolean} Boolean value indicating whether the passed-in * {} object has the same components as this * note that if ll passed in is null, returns false @@ -109,7 +109,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, { /** * Method: toShortString * - * Return: + * Returns: * {String} Shortened String representation of Point object. * (ex. "5, 42") */ diff --git a/lib/OpenLayers/Geometry/Polygon.js b/lib/OpenLayers/Geometry/Polygon.js index 319a7746cc..cc54d6be6c 100644 --- a/lib/OpenLayers/Geometry/Polygon.js +++ b/lib/OpenLayers/Geometry/Polygon.js @@ -43,7 +43,7 @@ OpenLayers.Geometry.Polygon = OpenLayers.Class( * Calculated by subtracting the areas of the internal holes from the * area of the outer hole. * - * Return: + * Returns: * {float} The area of the geometry */ getArea: function() { diff --git a/lib/OpenLayers/Geometry/Rectangle.js b/lib/OpenLayers/Geometry/Rectangle.js index 1d6db440a6..dbf02b31ab 100644 --- a/lib/OpenLayers/Geometry/Rectangle.js +++ b/lib/OpenLayers/Geometry/Rectangle.js @@ -70,7 +70,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, { /** * APIMethod: getLength * - * Return: + * Returns: * {Float} The length of the geometry */ getLength: function() { @@ -81,7 +81,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, { /** * APIMethod: getArea * - * Return: + * Returns: * {Float} The area of the geometry */ getArea: function() { diff --git a/lib/OpenLayers/Handler.js b/lib/OpenLayers/Handler.js index 252589d0c3..a0176b6d45 100644 --- a/lib/OpenLayers/Handler.js +++ b/lib/OpenLayers/Handler.js @@ -124,7 +124,7 @@ OpenLayers.Handler = OpenLayers.Class({ * returns true. If a is set and it matches the combination * of keys down on an event, this returns true. * - * Return: + * Returns: * {Boolean} The keyMask matches the keys down on an event. */ checkModifiers: function (evt) { @@ -146,7 +146,7 @@ OpenLayers.Handler = OpenLayers.Class({ * APIMethod: activate * Turn on the handler. Returns false if the handler was already active. * - * Return: + * Returns: * {Boolean} The handler was activated. */ activate: function() { @@ -168,7 +168,7 @@ OpenLayers.Handler = OpenLayers.Class({ * APIMethod: deactivate * Turn off the handler. Returns false if the handler was already inactive. * - * Return: + * Returns: * {Boolean} The handler was deactivated. */ deactivate: function() { diff --git a/lib/OpenLayers/Handler/Drag.js b/lib/OpenLayers/Handler/Drag.js index 86fbee92fe..4257cd7dc7 100644 --- a/lib/OpenLayers/Handler/Drag.js +++ b/lib/OpenLayers/Handler/Drag.js @@ -139,7 +139,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} * - * Return: + * Returns: * {Boolean} Let the event propagate. */ mousedown: function (evt) { @@ -165,7 +165,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} * - * Return: + * Returns: * {Boolean} Let the event propagate. */ mousemove: function (evt) { @@ -191,7 +191,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} * - * Return: + * Returns: * {Boolean} Let the event propagate. */ mouseup: function (evt) { @@ -215,7 +215,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} * - * Return: + * Returns: * {Boolean} Let the event propagate. */ mouseout: function (evt) { @@ -243,7 +243,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} * - * Return: + * Returns: * {Boolean} Let the event propagate. */ click: function (evt) { @@ -260,7 +260,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, { * Method: activate * Activate the handler. * - * Return: + * Returns: * {Boolean} The handler was successfully activated. */ activate: function() { @@ -276,7 +276,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, { * Method: deactivate * Deactivate the handler. * - * Return: + * Returns: * {Boolean} The handler was successfully deactivated. */ deactivate: function() { diff --git a/lib/OpenLayers/Handler/Feature.js b/lib/OpenLayers/Handler/Feature.js index fd147449d0..f07ff29582 100644 --- a/lib/OpenLayers/Handler/Feature.js +++ b/lib/OpenLayers/Handler/Feature.js @@ -100,7 +100,7 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * type - {String} Callback key * - * Return: + * Returns: * {Boolean} A feature was selected */ select: function(type, evt) { @@ -133,7 +133,8 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, { * Method: activate * Turn on the handler. Returns false if the handler was already active. * - * Return: {Boolean} + * Returns: + * {Boolean} */ activate: function() { if(OpenLayers.Handler.prototype.activate.apply(this, arguments)) { @@ -149,7 +150,7 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, { * Method: activate * Turn of the handler. Returns false if the handler was already active. * - * Return: + * Returns: * {Boolean} */ deactivate: function() { diff --git a/lib/OpenLayers/Handler/MouseWheel.js b/lib/OpenLayers/Handler/MouseWheel.js index 2abcdcd558..719751ee53 100644 --- a/lib/OpenLayers/Handler/MouseWheel.js +++ b/lib/OpenLayers/Handler/MouseWheel.js @@ -123,7 +123,7 @@ OpenLayers.Handler.MouseWheel = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ mousemove: function (evt) { diff --git a/lib/OpenLayers/Handler/Path.js b/lib/OpenLayers/Handler/Path.js index 936df89eaa..50f6f6eee1 100644 --- a/lib/OpenLayers/Handler/Path.js +++ b/lib/OpenLayers/Handler/Path.js @@ -98,7 +98,8 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * Method: freehandMode * Determine whether to behave in freehand mode or not. * - * Return: {Boolean} + * Returns: + * {Boolean} */ freehandMode: function(evt) { return (this.freehandToggle && evt[this.freehandToggle]) ? @@ -129,7 +130,8 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * Method: geometryClone * Return a clone of the relevant geometry. * - * Return: {} + * Returns: + * {} */ geometryClone: function() { return this.line.geometry.clone(); @@ -143,7 +145,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ mousedown: function(evt) { @@ -175,7 +177,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ mousemove: function (evt) { @@ -201,7 +203,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ mouseup: function (evt) { @@ -228,7 +230,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ dblclick: function(evt) { diff --git a/lib/OpenLayers/Handler/Point.js b/lib/OpenLayers/Handler/Point.js index 964e90ba34..f74a86c6bd 100644 --- a/lib/OpenLayers/Handler/Point.js +++ b/lib/OpenLayers/Handler/Point.js @@ -164,7 +164,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ dblclick: function(evt) { @@ -184,7 +184,8 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, { * Method: geometryClone * Return a clone of the relevant geometry. * - * Return: {} + * Returns: + * {} */ geometryClone: function() { return this.point.geometry.clone(); @@ -198,7 +199,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ mousedown: function(evt) { @@ -230,7 +231,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ mousemove: function (evt) { @@ -252,7 +253,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, { * Parameters: * evt - {Event} The browser event * - * Return: + * Returns: * {Boolean} Allow event propagation */ mouseup: function (evt) { diff --git a/lib/OpenLayers/Handler/Polygon.js b/lib/OpenLayers/Handler/Polygon.js index a3374af8f4..554eb6e7bd 100644 --- a/lib/OpenLayers/Handler/Polygon.js +++ b/lib/OpenLayers/Handler/Polygon.js @@ -93,7 +93,7 @@ OpenLayers.Handler.Polygon = OpenLayers.Class(OpenLayers.Handler.Path, { * Method: geometryClone * Return a clone of the relevant geometry. * - * Return: + * Returns: * {} */ geometryClone: function() { diff --git a/lib/OpenLayers/Icon.js b/lib/OpenLayers/Icon.js index 57eda50762..6fbc0ca149 100644 --- a/lib/OpenLayers/Icon.js +++ b/lib/OpenLayers/Icon.js @@ -85,7 +85,7 @@ OpenLayers.Icon = OpenLayers.Class({ /** * Method: clone * - * Return: + * Returns: * {} A fresh copy of the icon. */ clone: function() { @@ -114,7 +114,7 @@ OpenLayers.Icon = OpenLayers.Class({ * Parameters: * px - {} * - * Return: + * Returns: * {DOMElement} A new DOM Image of this icon set at the location passed-in */ draw: function(px) { diff --git a/lib/OpenLayers/Layer.js b/lib/OpenLayers/Layer.js index e1736d88bb..c94703a46d 100644 --- a/lib/OpenLayers/Layer.js +++ b/lib/OpenLayers/Layer.js @@ -277,7 +277,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Parameters: * obj - {} The layer to be cloned * - * Return: + * Returns: * {} An exact clone of this */ clone: function (obj) { @@ -344,7 +344,7 @@ OpenLayers.Layer = OpenLayers.Class({ * APIMethod: redraw * Redraws the layer. Returns true if the layer was redrawn, false if not. * - * Return: + * Returns: * {Boolean} The layer was redrawn. */ redraw: function() { @@ -437,7 +437,7 @@ OpenLayers.Layer = OpenLayers.Class({ /** * APIMethod: getImageSize * - * Return: + * Returns: * {} The size that the image should be, taking into * account gutters. */ @@ -474,7 +474,7 @@ OpenLayers.Layer = OpenLayers.Class({ /** * APIMethod: getVisibility * - * Return: + * Returns: * {Boolean} The layer should be displayed (if in range). */ getVisibility: function() { @@ -525,7 +525,7 @@ OpenLayers.Layer = OpenLayers.Class({ /** * Method: calculateInRange * - * Return: + * Returns: * {Boolean} The layer is displayable at the current map's current * resolution. */ @@ -695,7 +695,7 @@ OpenLayers.Layer = OpenLayers.Class({ /** * APIMethod: getResolution * - * Return: + * Returns: * {Float} The currently selected resolution of the map, taken from the * resolutions array, indexed by current zoom level. */ @@ -707,7 +707,7 @@ OpenLayers.Layer = OpenLayers.Class({ /** * APIMethod: getExtent * - * Return: + * Returns: * {} A Bounds object which represents the lon/lat * bounds of the current viewPort. */ @@ -724,7 +724,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Parameters: * bounds - {} * - * Return: + * Returns: * {Integer} The index of the zoomLevel (entry in the resolutions array) * that still contains the passed-in extent. We do this by calculating * the ideal resolution for the given exteng (based on the map size) @@ -744,7 +744,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Calculates the max extent which includes all of the data for the layer. * This function is to be implemented by subclasses. * - * Return: + * Returns: * {} */ getDataExtent: function () { @@ -757,7 +757,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Parameters: * resolution - {Float} * - * Return: + * Returns: * {Integer} The index of the zoomLevel (entry in the resolutions array) * that is the smallest resolution that is greater than the passed-in * resolution. @@ -778,7 +778,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Parameters: * viewPortPx - {} * - * Return: + * Returns: * {} An OpenLayers.LonLat which is the passed-in * view port , translated into lon/lat by the layer. */ @@ -810,7 +810,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Parameters: * lonlat - {} * - * Return: + * Returns: * {} An which is the passed-in * ,translated into view port pixels. */ diff --git a/lib/OpenLayers/Layer/EventPane.js b/lib/OpenLayers/Layer/EventPane.js index 9530c2ee71..893205f5d6 100644 --- a/lib/OpenLayers/Layer/EventPane.js +++ b/lib/OpenLayers/Layer/EventPane.js @@ -163,7 +163,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, { * Method: getWarningHTML * To be implemented by subclasses. * - * Return: + * Returns: * {String} String with information on why layer is broken, how to get * it working. */ @@ -246,7 +246,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * viewPortPx - {} * - * Return: + * Returns: * {} An OpenLayers.LonLat which is the passed-in view * port OpenLayers.Pixel, translated into lon/lat by map lib * If the map lib is not loaded or not centered, returns null @@ -270,7 +270,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * lonlat - {} * - * Return: + * Returns: * {} An OpenLayers.Pixel which is the passed-in * OpenLayers.LonLat, translated into view port pixels by map lib * If map lib is not loaded or not centered, returns null @@ -308,7 +308,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, { * Parameters * moLonLat - {Object} * - * Return: + * Returns: * {} An OpenLayers.LonLat, translated from the passed in * MapObject LonLat * Returns null if null value is passed in @@ -330,7 +330,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * olLonLat - {} * - * Return: + * Returns: * {Object} A MapObject LonLat, translated from the passed in * OpenLayers.LonLat * Returns null if null value is passed in @@ -356,7 +356,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * moPixel - {Object} * - * Return: + * Returns: * {} An OpenLayers.Pixel, translated from the passed in * MapObject Pixel * Returns null if null value is passed in @@ -378,7 +378,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * olPixel - {} * - * Return: + * Returns: * {Object} A MapObject Pixel, translated from the passed in * OpenLayers.Pixel * Returns null if null value is passed in diff --git a/lib/OpenLayers/Layer/FixedZoomLevels.js b/lib/OpenLayers/Layer/FixedZoomLevels.js index 71e7bf4108..2900aaea36 100644 --- a/lib/OpenLayers/Layer/FixedZoomLevels.js +++ b/lib/OpenLayers/Layer/FixedZoomLevels.js @@ -115,7 +115,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({ * APIMethod: getResolution * Get the current map resolution * - * Return: + * Returns: * {Float} Map units per Pixel */ getResolution: function() { @@ -141,7 +141,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({ * Calculates using px-> lonlat translation functions on tl and br * corners of viewport * - * Return: + * Returns: * {} A Bounds object which represents the lon/lat * bounds of the current viewPort. */ @@ -174,7 +174,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({ * Parameters: * resolution - {Float} * - * Return: + * Returns: * {Integer} A suitable zoom level for the specified resolution. * If no baselayer is set, returns null. */ @@ -214,7 +214,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({ * Parameters: * moZoom - {Integer} * - * Return: + * Returns: * {Integer} An OpenLayers Zoom level, translated from the passed in zoom * Returns null if null value is passed in */ @@ -233,7 +233,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({ * Parameters: * olZoom - {Integer} * - * Return: + * Returns: * {Integer} A MapObject level, translated from the passed in olZoom * Returns null if null value is passed in */ diff --git a/lib/OpenLayers/Layer/Google.js b/lib/OpenLayers/Layer/Google.js index e16a835e58..87857128a8 100644 --- a/lib/OpenLayers/Layer/Google.js +++ b/lib/OpenLayers/Layer/Google.js @@ -158,7 +158,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * bounds - {} * - * Return: + * Returns: * {Integer} Corresponding zoom level for a specified Bounds. * If mapObject is not loaded or not centered, returns null * @@ -189,7 +189,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moBounds - {Object} * - * Return: + * Returns: * {} An , translated from the * passed-in MapObject Bounds. * Returns null if null value is passed in. @@ -213,7 +213,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * olBounds - {} * - * Return: + * Returns: * {Object} A MapObject Bounds, translated from olBounds * Returns null if null value is passed in */ @@ -238,7 +238,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * gLatLng - {GLatLng} * - * Return: + * Returns: * {GPoint} A GPoint specifying gLatLng translated into "Container" coords */ addContainerPxFunction: function() { @@ -265,7 +265,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, /** * APIMethod: getWarningHTML * - * Return: + * Returns: * {String} String with information on why layer is broken, how to get * it working. */ @@ -315,7 +315,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, /** * APIMethod: getMapObjectCenter * - * Return: + * Returns: * {Object} The mapObject's current center in Map Object format */ getMapObjectCenter: function() { @@ -325,7 +325,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, /** * APIMethod: getMapObjectZoom * - * Return: + * Returns: * {Integer} The mapObject's current zoom, in Map Object format */ getMapObjectZoom: function() { @@ -341,7 +341,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Object} MapObject LonLat translated from MapObject Pixel */ getMapObjectLonLatFromMapObjectPixel: function(moPixel) { @@ -354,7 +354,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Object} MapObject Pixel transtlated from MapObject LonLat */ getMapObjectPixelFromMapObjectLonLat: function(moLonLat) { @@ -370,7 +370,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moBounds - {Object} MapObject Bounds format * - * Return: + * Returns: * {Object} MapObject Zoom for specified MapObject Bounds */ getMapObjectZoomFromMapObjectBounds: function(moBounds) { @@ -392,7 +392,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Longitude of the given MapObject LonLat */ getLongitudeFromMapObjectLonLat: function(moLonLat) { @@ -405,7 +405,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Latitude of the given MapObject LonLat */ getLatitudeFromMapObjectLonLat: function(moLonLat) { @@ -419,7 +419,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * lon - {Float} * lat - {Float} * - * Return: + * Returns: * {Object} MapObject LonLat built from lon and lat params */ getMapObjectLonLatFromLonLat: function(lon, lat) { @@ -434,7 +434,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} X value of the MapObject Pixel */ getXFromMapObjectPixel: function(moPixel) { @@ -447,7 +447,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} Y value of the MapObject Pixel */ getYFromMapObjectPixel: function(moPixel) { @@ -461,7 +461,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane, * x - {Integer} * y - {Integer} * - * Return: + * Returns: * {Object} MapObject Pixel from x and y parameters */ getMapObjectPixelFromXY: function(x, y) { diff --git a/lib/OpenLayers/Layer/Grid.js b/lib/OpenLayers/Layer/Grid.js index 33e6931eb4..5d7c8d1a32 100644 --- a/lib/OpenLayers/Layer/Grid.js +++ b/lib/OpenLayers/Layer/Grid.js @@ -118,7 +118,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, { * Parameters: * obj - {Object} Is this ever used? * - * Return: + * Returns: * {} An exact clone of this OpenLayers.Layer.Grid */ clone: function (obj) { @@ -216,7 +216,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, { * Deprecated. This function will be removed in 3.0. Please use * getTilesBounds() instead. * - * Return: + * Returns: * {} A Bounds object representing the bounds of all the * currently loaded tiles (including those partially or not at all seen * onscreen) @@ -471,7 +471,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, { * Parameters * bounds - {} * - * Return: + * Returns: * {} The added OpenLayers.Tile */ addTile:function(bounds, position) { diff --git a/lib/OpenLayers/Layer/HTTPRequest.js b/lib/OpenLayers/Layer/HTTPRequest.js index d82e96ef7e..50bd287175 100644 --- a/lib/OpenLayers/Layer/HTTPRequest.js +++ b/lib/OpenLayers/Layer/HTTPRequest.js @@ -74,7 +74,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * obj - {Object} * - * Return: + * Returns: * {} An exact clone of this * */ @@ -128,7 +128,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, { * paramString - {String} * urls - {Array(String)} * - * Return: + * Returns: * {String} An entry from the urls array, deterministically selected based * on the paramString. */ @@ -157,7 +157,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, { * newParams - {Object} * altUrl - {String} Use this as the url instead of the layer's url * - * Return: + * Returns: * {String} */ getFullRequestString:function(newParams, altUrl) { diff --git a/lib/OpenLayers/Layer/Image.js b/lib/OpenLayers/Layer/Image.js index 6601f30a4f..31b1890756 100644 --- a/lib/OpenLayers/Layer/Image.js +++ b/lib/OpenLayers/Layer/Image.js @@ -91,7 +91,7 @@ OpenLayers.Layer.Image = OpenLayers.Class(OpenLayers.Layer, { * Paramters: * obj - {Object} An optional layer (is this ever used?) * - * Return: + * Returns: * {} An exact copy of this layer */ clone: function(obj) { diff --git a/lib/OpenLayers/Layer/KaMap.js b/lib/OpenLayers/Layer/KaMap.js index da9dbc3c91..243949e3c1 100644 --- a/lib/OpenLayers/Layer/KaMap.js +++ b/lib/OpenLayers/Layer/KaMap.js @@ -77,7 +77,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {String} A string with the layer's url and parameters and also the * passed-in bounds and appropriate tile size specified as * parameters @@ -102,7 +102,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, { * bounds - {} * position - {} * - * Return: + * Returns: * {} */ addTile:function(bounds,position) { @@ -200,7 +200,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * obj - {Object} * - * Return: + * Returns: * {} An exact clone of this OpenLayers.Layer.KaMap */ clone: function (obj) { diff --git a/lib/OpenLayers/Layer/MapServer.js b/lib/OpenLayers/Layer/MapServer.js index a90e67969c..27492810be 100644 --- a/lib/OpenLayers/Layer/MapServer.js +++ b/lib/OpenLayers/Layer/MapServer.js @@ -59,7 +59,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, { * Method: clone * Create a clone of this layer * - * Return: + * Returns: * {} An exact clone of this layer */ clone: function (obj) { @@ -84,7 +84,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {} The added OpenLayers.Tile.Image */ addTile:function(bounds,position) { @@ -100,7 +100,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, { * bounds - {} A bounds representing the bbox * for the request * - * Return: + * Returns: * {String} A string with the layer's url and parameters and also * the passed-in bounds and appropriate tile size specified * as parameters. @@ -135,7 +135,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, { * altUrl - {String} (optional) Replace the URL in the full request * string with the provided URL. * - * Return: + * Returns: * {String} A string with the layer's url and parameters embedded in it. */ getFullRequestString:function(newParams, altUrl) { diff --git a/lib/OpenLayers/Layer/Markers.js b/lib/OpenLayers/Layer/Markers.js index cdc5d70ba5..c5c891271e 100644 --- a/lib/OpenLayers/Layer/Markers.js +++ b/lib/OpenLayers/Layer/Markers.js @@ -144,7 +144,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, { * APIMethod: getDataExtent * Calculates the max extent which includes all of the markers. * - * Return: + * Returns: * {} */ getDataExtent: function () { diff --git a/lib/OpenLayers/Layer/MultiMap.js b/lib/OpenLayers/Layer/MultiMap.js index f508251d41..7465f9a049 100644 --- a/lib/OpenLayers/Layer/MultiMap.js +++ b/lib/OpenLayers/Layer/MultiMap.js @@ -83,7 +83,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( /** * APIMethod: getWarningHTML * - * Return: + * Returns: * {String} String with information on why layer is broken, how to get * it working. */ @@ -133,7 +133,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( /** * APIMethod: getMapObjectCenter * - * Return: + * Returns: * {Object} The mapObject's current center in Map Object format */ getMapObjectCenter: function() { @@ -143,7 +143,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( /** * APIMethod: getMapObjectZoom * - * Return: + * Returns: * {Integer} The mapObject's current zoom, in Map Object format */ getMapObjectZoom: function() { @@ -159,7 +159,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Object} MapObject LonLat translated from MapObject Pixel */ getMapObjectLonLatFromMapObjectPixel: function(moPixel) { @@ -174,7 +174,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Object} MapObject Pixel transtlated from MapObject LonLat */ getMapObjectPixelFromMapObjectLonLat: function(moLonLat) { @@ -197,7 +197,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Longitude of the given MapObject LonLat */ getLongitudeFromMapObjectLonLat: function(moLonLat) { @@ -210,7 +210,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Latitude of the given MapObject LonLat */ getLatitudeFromMapObjectLonLat: function(moLonLat) { @@ -224,7 +224,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * lon - {Float} * lat - {Float} * - * Return: + * Returns: * {Object} MapObject LonLat built from lon and lat params */ getMapObjectLonLatFromLonLat: function(lon, lat) { @@ -239,7 +239,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} X value of the MapObject Pixel */ getXFromMapObjectPixel: function(moPixel) { @@ -252,7 +252,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} Y value of the MapObject Pixel */ getYFromMapObjectPixel: function(moPixel) { @@ -266,7 +266,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class( * x - {Integer} * y - {Integer} * - * Return: + * Returns: * {Object} MapObject Pixel from x and y parameters */ getMapObjectPixelFromXY: function(x, y) { diff --git a/lib/OpenLayers/Layer/TMS.js b/lib/OpenLayers/Layer/TMS.js index 80ca7f2ff0..6a73f89e2e 100644 --- a/lib/OpenLayers/Layer/TMS.js +++ b/lib/OpenLayers/Layer/TMS.js @@ -61,7 +61,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * obj - {Object} * - * Return: + * Returns: * {} An exact clone of this */ clone: function (obj) { @@ -86,7 +86,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {String} A string with the layer's url and parameters and also the * passed-in bounds and appropriate tile size specified as * parameters @@ -112,7 +112,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {} The added OpenLayers.Tile.Image */ addTile:function(bounds,position) { diff --git a/lib/OpenLayers/Layer/TileCache.js b/lib/OpenLayers/Layer/TileCache.js index 40024b97bb..8e29c8699d 100644 --- a/lib/OpenLayers/Layer/TileCache.js +++ b/lib/OpenLayers/Layer/TileCache.js @@ -66,7 +66,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * APIMethod: clone * obj - {Object} * - * Return: + * Returns: * {} An exact clone of this * */ @@ -92,7 +92,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {String} A string with the layer's url and parameters and also the * passed-in bounds and appropriate tile size specified as parameters. */ @@ -108,7 +108,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * number - {Int} * length - {Int} * - * Return: + * Returns: * {String} A zero-padded string */ function zeroPad(number, length) { @@ -145,7 +145,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {} The added */ addTile:function(bounds, position) { diff --git a/lib/OpenLayers/Layer/Vector.js b/lib/OpenLayers/Layer/Vector.js index 7522ef1cb0..1811258ec7 100644 --- a/lib/OpenLayers/Layer/Vector.js +++ b/lib/OpenLayers/Layer/Vector.js @@ -100,7 +100,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, { * options - {Object} options Object with non-default properties to set on * the layer. * - * Return: + * Returns: * {} A new vector layer */ initialize: function(name, options) { @@ -357,7 +357,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * evt - {Event} * - * Return: + * Returns: * {} A feature if one was under the event. */ getFeatureFromEvent: function(evt) { @@ -372,7 +372,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * featureId - {String} * - * Return: + * Returns: * {} A feature corresponding to the given * featureId */ diff --git a/lib/OpenLayers/Layer/VirtualEarth.js b/lib/OpenLayers/Layer/VirtualEarth.js index e6695429d9..0f4634f857 100644 --- a/lib/OpenLayers/Layer/VirtualEarth.js +++ b/lib/OpenLayers/Layer/VirtualEarth.js @@ -98,7 +98,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( /** * APIMethod: getWarningHTML * - * Return: + * Returns: * {String} String with information on why layer is broken, how to get * it working. */ @@ -148,7 +148,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( /** * APIMethod: getMapObjectCenter * - * Return: + * Returns: * {Object} The mapObject's current center in Map Object format */ getMapObjectCenter: function() { @@ -158,7 +158,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( /** * APIMethod: getMapObjectZoom * - * Return: + * Returns: * {Integer} The mapObject's current zoom, in Map Object format */ getMapObjectZoom: function() { @@ -174,7 +174,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Object} MapObject LonLat translated from MapObject Pixel */ getMapObjectLonLatFromMapObjectPixel: function(moPixel) { @@ -187,7 +187,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Object} MapObject Pixel transtlated from MapObject LonLat */ getMapObjectPixelFromMapObjectLonLat: function(moLonLat) { @@ -210,7 +210,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Longitude of the given MapObject LonLat */ getLongitudeFromMapObjectLonLat: function(moLonLat) { @@ -223,7 +223,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Latitude of the given MapObject LonLat */ getLatitudeFromMapObjectLonLat: function(moLonLat) { @@ -237,7 +237,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * lon - {Float} * lat - {Float} * - * Return: + * Returns: * {Object} MapObject LonLat built from lon and lat params */ getMapObjectLonLatFromLonLat: function(lon, lat) { @@ -252,7 +252,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} X value of the MapObject Pixel */ getXFromMapObjectPixel: function(moPixel) { @@ -265,7 +265,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} Y value of the MapObject Pixel */ getYFromMapObjectPixel: function(moPixel) { @@ -279,7 +279,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class( * x - {Integer} * y - {Integer} * - * Return: + * Returns: * {Object} MapObject Pixel from x and y parameters */ getMapObjectPixelFromXY: function(x, y) { diff --git a/lib/OpenLayers/Layer/WFS.js b/lib/OpenLayers/Layer/WFS.js index a7b0aab2da..f9be84d1a8 100644 --- a/lib/OpenLayers/Layer/WFS.js +++ b/lib/OpenLayers/Layer/WFS.js @@ -277,7 +277,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class( * Parameters: * obj - {Object} * - * Return: + * Returns: * {} An exact clone of this OpenLayers.Layer.WFS */ clone: function (obj) { diff --git a/lib/OpenLayers/Layer/WMS.js b/lib/OpenLayers/Layer/WMS.js index 5e3dff88b2..aaea0dca0e 100644 --- a/lib/OpenLayers/Layer/WMS.js +++ b/lib/OpenLayers/Layer/WMS.js @@ -115,7 +115,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, { * Method: clone * Create a clone of this layer * - * Return: + * Returns: * {} An exact clone of this layer */ clone: function (obj) { @@ -143,7 +143,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, { * bounds - {} A bounds representing the bbox for the * request. * - * Return: + * Returns: * {String} A string with the layer's url and parameters and also the * passed-in bounds and appropriate tile size specified as * parameters. @@ -165,7 +165,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {} The added OpenLayers.Tile.Image */ addTile:function(bounds,position) { @@ -201,7 +201,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * newParams - {Object} * - * Return: + * Returns: * {String} */ getFullRequestString:function(newParams) { diff --git a/lib/OpenLayers/Layer/WorldWind.js b/lib/OpenLayers/Layer/WorldWind.js index 7eb48c3452..f8c46173cb 100644 --- a/lib/OpenLayers/Layer/WorldWind.js +++ b/lib/OpenLayers/Layer/WorldWind.js @@ -85,7 +85,7 @@ OpenLayers.Layer.WorldWind = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Return: + * Returns: * {String} A string with the layer's url and parameters and also the * passed-in bounds and appropriate tile size specified as * parameters diff --git a/lib/OpenLayers/Layer/Yahoo.js b/lib/OpenLayers/Layer/Yahoo.js index 11e8ac8e8b..dfe308bfec 100644 --- a/lib/OpenLayers/Layer/Yahoo.js +++ b/lib/OpenLayers/Layer/Yahoo.js @@ -128,7 +128,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( /** * APIMethod: getWarningHTML * - * Return: + * Returns: * {String} String with information on why layer is broken, how to get * it working. */ @@ -172,7 +172,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * gZoom - {Integer} * - * Return: + * Returns: * {Integer} An OpenLayers Zoom level, translated from the passed in gZoom * Returns null if null value is passed in. */ @@ -191,7 +191,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * olZoom - {Integer} * - * Return: + * Returns: * {Integer} A MapObject level, translated from the passed in olZoom * Returns null if null value is passed in */ @@ -228,7 +228,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( /** * APIMethod: getMapObjectCenter * - * Return: + * Returns: * {Object} The mapObject's current center in Map Object format */ getMapObjectCenter: function() { @@ -238,7 +238,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( /** * APIMethod: getMapObjectZoom * - * Return: + * Returns: * {Integer} The mapObject's current zoom, in Map Object format */ getMapObjectZoom: function() { @@ -254,7 +254,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Object} MapObject LonLat translated from MapObject Pixel */ getMapObjectLonLatFromMapObjectPixel: function(moPixel) { @@ -267,7 +267,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Object} MapObject Pixel transtlated from MapObject LonLat */ getMapObjectPixelFromMapObjectLonLat: function(moLonLat) { @@ -290,7 +290,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Longitude of the given MapObject LonLat */ getLongitudeFromMapObjectLonLat: function(moLonLat) { @@ -303,7 +303,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * moLonLat - {Object} MapObject LonLat format * - * Return: + * Returns: * {Float} Latitude of the given MapObject LonLat */ getLatitudeFromMapObjectLonLat: function(moLonLat) { @@ -317,7 +317,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * lon - {Float} * lat - {Float} * - * Return: + * Returns: * {Object} MapObject LonLat built from lon and lat params */ getMapObjectLonLatFromLonLat: function(lon, lat) { @@ -332,7 +332,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} X value of the MapObject Pixel */ getXFromMapObjectPixel: function(moPixel) { @@ -345,7 +345,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * moPixel - {Object} MapObject Pixel format * - * Return: + * Returns: * {Integer} Y value of the MapObject Pixel */ getYFromMapObjectPixel: function(moPixel) { @@ -359,7 +359,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * x - {Integer} * y - {Integer} * - * Return: + * Returns: * {Object} MapObject Pixel from x and y parameters */ getMapObjectPixelFromXY: function(x, y) { @@ -374,7 +374,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class( * Parameters: * olSize - {} * - * Return: + * Returns: * {Object} MapObject Size from olSize parameter */ getMapObjectSizeFromOLSize: function(olSize) { diff --git a/lib/OpenLayers/Map.js b/lib/OpenLayers/Map.js index 1c557351ed..f19ba55764 100644 --- a/lib/OpenLayers/Map.js +++ b/lib/OpenLayers/Map.js @@ -424,7 +424,7 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getTileSize * Get the tile size for the map * - * Return: + * Returns: * {} */ getTileSize: function() { @@ -447,7 +447,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameter: * id - {String} A layer id * - * Return: + * Returns: * {} The Layer with the corresponding id from the map's * layer collection, or null if not found. */ @@ -587,7 +587,8 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getNumLayers * - * Return: {Int} The number of layers attached to the map. + * Returns: + * {Int} The number of layers attached to the map. */ getNumLayers: function () { return this.layers.length; @@ -599,7 +600,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * layer - {} * - * Return: + * Returns: * {Integer} The current (zero-based) index of the given layer in the map's * layer stack. Returns -1 if the layer isn't on the map. */ @@ -756,7 +757,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * id - {String} ID of the control to return. * - * Return: + * Returns: * {} The control from the map's list of controls * which has a matching 'id'. If none found, * returns null. @@ -855,7 +856,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getSize * - * Return: + * Returns: * {} An object that represents the * size, in pixels, of the div into which OpenLayers * has been loaded. @@ -907,7 +908,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * Method: getCurrentSize * - * Return: + * Returns: * {} A new object with the dimensions * of the map div */ @@ -936,7 +937,7 @@ OpenLayers.Map = OpenLayers.Class({ * center - {} Default is this.getCenter() * resolution - {float} Default is this.getResolution() * - * Return: + * Returns: * {} A bounds based on resolution, center, and * current mapsize. */ @@ -980,7 +981,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getCenter * - * Return: + * Returns: * {} */ getCenter: function () { @@ -991,7 +992,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getZoom * - * Return: + * Returns: * {Integer} */ getZoom: function () { @@ -1147,7 +1148,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * zoomLevel - {Integer} * - * Return: + * Returns: * {Boolean} Whether or not the zoom level passed in is non-null and * within the min/max range of zoom levels. */ @@ -1163,7 +1164,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * lonlat - {} * - * Return: + * Returns: * {Boolean} Whether or not the lonlat passed in is non-null and within * the maxExtent bounds */ @@ -1187,7 +1188,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getProjection * - * Return: + * Returns: * {String} The Projection of the base layer. */ getProjection: function() { @@ -1201,7 +1202,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getMaxResolution * - * Return: + * Returns: * {String} The Map's Maximum Resolution */ getMaxResolution: function() { @@ -1215,7 +1216,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getMaxExtent * - * Return: + * Returns: * {} */ getMaxExtent: function () { @@ -1229,7 +1230,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getNumZoomLevels * - * Return: + * Returns: * {Integer} The total number of zoom levels that can be displayed by the * current baseLayer. */ @@ -1255,7 +1256,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getExtent * - * Return: + * Returns: * {} A Bounds object which represents the lon/lat * bounds of the current viewPort. * If no baselayer is set, returns null. @@ -1271,7 +1272,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getResolution * - * Return: + * Returns: * {Float} The current resolution of the map. * If no baselayer is set, returns null. */ @@ -1286,7 +1287,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getScale * - * Return: + * Returns: * {Float} The current scale denominator of the map. * If no baselayer is set, returns null. */ @@ -1307,7 +1308,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * bounds - {} * - * Return: + * Returns: * {Integer} A suitable zoom level for the specified bounds. * If no baselayer is set, returns null. */ @@ -1325,7 +1326,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameter: * resolution - {Float} * - * Return: + * Returns: * {Integer} A suitable zoom level for the specified resolution. * If no baselayer is set, returns null. */ @@ -1463,7 +1464,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * viewPortPx - {} * - * Return: + * Returns: * {} An OpenLayers.LonLat which is the passed-in view * port , translated into lon/lat * by the current base layer. @@ -1482,7 +1483,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * lonlat - {} * - * Return: + * Returns: * {} An OpenLayers.Pixel which is the passed-in * , translated into view port * pixels by the current base layer. @@ -1506,7 +1507,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * px - {} * - * Return: + * Returns: * {} An OpenLayers.LonLat corresponding to the given * OpenLayers.Pixel, translated into lon/lat by the * current base layer @@ -1521,7 +1522,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * lonlat - {} * - * Return: + * Returns: * {} An OpenLayers.Pixel corresponding to the * translated into view port * pixels by the current base layer. @@ -1542,7 +1543,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * layerPx - {} * - * Return: + * Returns: * {} Layer Pixel translated into ViewPort Pixel * coordinates */ @@ -1562,7 +1563,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * viewPortPx - {} * - * Return: + * Returns: * {} ViewPort Pixel translated into Layer Pixel * coordinates */ @@ -1589,7 +1590,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * px - {} * - * Return: + * Returns: * {} */ getLonLatFromLayerPx: function (px) { @@ -1604,7 +1605,7 @@ OpenLayers.Map = OpenLayers.Class({ * Parameters: * lonlat - {} lonlat * - * Return: + * Returns: * {} An OpenLayers.Pixel which is the passed-in * , translated into layer pixels * by the current base layer diff --git a/lib/OpenLayers/Marker.js b/lib/OpenLayers/Marker.js index 30682b74e6..59cab53532 100644 --- a/lib/OpenLayers/Marker.js +++ b/lib/OpenLayers/Marker.js @@ -105,7 +105,7 @@ OpenLayers.Marker = OpenLayers.Class({ * Parameters: * px - {} * - * Return: + * Returns: * {DOMElement} A new DOM Image with this marker's icon set at the * location passed-in */ @@ -130,7 +130,7 @@ OpenLayers.Marker = OpenLayers.Class({ /** * Method: onScreen * - * Return: + * Returns: * {Boolean} Whether or not the marker is currently visible on screen. */ onScreen:function() { @@ -189,7 +189,7 @@ OpenLayers.Marker = OpenLayers.Class({ * Function: defaultIcon * Creates a default . * - * Return: + * Returns: * {} A default OpenLayers.Icon to use for a marker */ OpenLayers.Marker.defaultIcon = function() { diff --git a/lib/OpenLayers/Marker/Box.js b/lib/OpenLayers/Marker/Box.js index 09fd425cb7..8c2674dd43 100644 --- a/lib/OpenLayers/Marker/Box.js +++ b/lib/OpenLayers/Marker/Box.js @@ -77,7 +77,7 @@ OpenLayers.Marker.Box = OpenLayers.Class(OpenLayers.Marker, { * px - {} * sz - {} * - * Return: + * Returns: * {DOMElement} A new DOM Image with this marker´s icon set at the * location passed-in */ diff --git a/lib/OpenLayers/Popup.js b/lib/OpenLayers/Popup.js index 1e1c583389..8012e74a8a 100644 --- a/lib/OpenLayers/Popup.js +++ b/lib/OpenLayers/Popup.js @@ -198,7 +198,7 @@ OpenLayers.Popup = OpenLayers.Class({ * Parameters: * px - {} the position the popup in pixels. * - * Return: + * Returns: * {DOMElement} Reference to a div that contains the drawn popup */ draw: function(px) { @@ -246,7 +246,7 @@ OpenLayers.Popup = OpenLayers.Class({ /** * Method: visible * - * Return: + * Returns: * {Boolean} Boolean indicating whether or not the popup is visible */ visible: function() { diff --git a/lib/OpenLayers/Popup/Anchored.js b/lib/OpenLayers/Popup/Anchored.js index 9dcacfa618..63bc613a41 100644 --- a/lib/OpenLayers/Popup/Anchored.js +++ b/lib/OpenLayers/Popup/Anchored.js @@ -56,7 +56,7 @@ OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, { * Parameters: * px - {} * - * Return: + * Returns: * {DOMElement} Reference to a div that contains the drawn popup */ draw: function(px) { @@ -78,7 +78,7 @@ OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, { * Parameters: * px - {} * - * Return: + * Returns: * {String} The relative position ("br" "tr" "tl "bl") at which the popup * should be placed */ @@ -126,7 +126,7 @@ OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, { * Parameters: * px - {} * - * Return: + * Returns: * {} The the new px position of the popup on the screen * relative to the passed-in px */ diff --git a/lib/OpenLayers/Popup/AnchoredBubble.js b/lib/OpenLayers/Popup/AnchoredBubble.js index 49f93c2314..d3d6c60105 100644 --- a/lib/OpenLayers/Popup/AnchoredBubble.js +++ b/lib/OpenLayers/Popup/AnchoredBubble.js @@ -43,7 +43,7 @@ OpenLayers.Popup.AnchoredBubble = OpenLayers.Class(OpenLayers.Popup.Anchored, { * Parameters: * px - {} * - * Return: + * Returns: * {DOMElement} Reference to a div that contains the drawn popup */ draw: function(px) { @@ -167,7 +167,7 @@ OpenLayers.Popup.AnchoredBubble = OpenLayers.Class(OpenLayers.Popup.Anchored, { /** * Method: getCornersToRound * - * Return: + * Returns: * {String} The proper corners string ("tr tl bl br") for rico to round */ getCornersToRound:function() { diff --git a/lib/OpenLayers/Renderer.js b/lib/OpenLayers/Renderer.js index 2c8c9571e9..b2c82af3ba 100644 --- a/lib/OpenLayers/Renderer.js +++ b/lib/OpenLayers/Renderer.js @@ -76,7 +76,7 @@ OpenLayers.Renderer = OpenLayers.Class({ * APIMethod: supported * This should be overridden by specific subclasses * - * Return: + * Returns: * {Boolean} Whether or not the browser supports the renderer class */ supported: function() { @@ -119,7 +119,7 @@ OpenLayers.Renderer = OpenLayers.Class({ * Method: getResolution * Uses cached copy of resolution if available to minimize computing * - * Return: + * Returns: * The current map's resolution */ getResolution: function() { @@ -176,7 +176,7 @@ OpenLayers.Renderer = OpenLayers.Class({ * Parameters: * evt - {} * - * Return: + * Returns: * {String} A feature id or null. */ getFeatureIdFromEvent: function(evt) {}, diff --git a/lib/OpenLayers/Renderer/Elements.js b/lib/OpenLayers/Renderer/Elements.js index 12e14e9036..23a7d2779a 100644 --- a/lib/OpenLayers/Renderer/Elements.js +++ b/lib/OpenLayers/Renderer/Elements.js @@ -93,7 +93,7 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, { * Parameters: * geometry - {} * - * Return: + * Returns: * {String} The corresponding node type for the specified geometry */ getNodeType: function(geometry) { }, @@ -284,7 +284,7 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, { * Parameters: * evt - {Object} An object * - * Return: + * Returns: * {} A geometry from an event that * happened on a layer */ @@ -334,7 +334,7 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, { * type - {String} type Kind of node to draw * geometry - {} * - * Return: + * Returns: * {DOMElement} A new node of the given type and id */ nodeFactory: function(id, type, geometry) { diff --git a/lib/OpenLayers/Renderer/SVG.js b/lib/OpenLayers/Renderer/SVG.js index ea3a11d567..9c7510d43b 100644 --- a/lib/OpenLayers/Renderer/SVG.js +++ b/lib/OpenLayers/Renderer/SVG.js @@ -57,7 +57,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { /** * APIMethod: supported * - * Return: + * Returns: * {Boolean} Whether or not the browser supports the SVG renderer */ supported: function() { @@ -133,7 +133,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { * Parameters: * geometry - {} * - * Return: + * Returns: * {String} The corresponding node type for the specified geometry */ getNodeType: function(geometry) { @@ -251,7 +251,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { * type - {String} Kind of node to draw * id - {String} Id for node * - * Return: + * Returns: * {DOMElement} A new node of the given type and id */ createNode: function(type, id) { @@ -269,7 +269,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { * node - {SVGDomElement} An SVG element * type - {String} Kind of node * - * Return: + * Returns: * {Boolean} Whether or not the specified node is of the specified type */ nodeTypeCompare: function(node, type) { @@ -279,7 +279,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { /** * Method: createRenderRoot * - * Return: + * Returns: * {DOMElement} The specific render engine's root element */ createRenderRoot: function() { @@ -291,7 +291,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { /** * Method: createRoot * - * Return: + * Returns: * {DOMElement} The main root element to which we'll add vectors */ createRoot: function() { @@ -530,7 +530,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { * Parameters: * point - {} * - * Return: + * Returns: * {String} */ getShortString: function(point) { diff --git a/lib/OpenLayers/Renderer/VML.js b/lib/OpenLayers/Renderer/VML.js index 28cb6de533..7dbc518a2f 100644 --- a/lib/OpenLayers/Renderer/VML.js +++ b/lib/OpenLayers/Renderer/VML.js @@ -55,7 +55,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, { * APIMethod: supported * Determine whether a browser supports this renderer. * - * Return: + * Returns: * {Boolean} The browser supports the VML renderer */ supported: function() { @@ -109,7 +109,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, { * Parameters: * geometry - {} * - * Return: + * Returns: * {String} The corresponding node type for the specified geometry */ getNodeType: function(geometry) { @@ -280,7 +280,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, { * type - {String} Kind of node to draw * id - {String} Id for node * - * Return: + * Returns: * {DOMElement} A new node of the given type and id */ createNode: function(type, id) { @@ -299,7 +299,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, { * type - {String} Kind of node to draw * id - {String} Id for node * - * Return: + * Returns: * {Boolean} Whether or not the specified node is of the specified type */ nodeTypeCompare: function(node, type) { @@ -325,7 +325,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, { * Method: createRenderRoot * Create the renderer root * - * Return: + * Returns: * {DOMElement} The specific render engine's root element */ createRenderRoot: function() { @@ -338,7 +338,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, { * Method: createRoot * Create the main root element * - * Return: + * Returns: * {DOMElement} The main root element to which we'll add vectors */ createRoot: function() { diff --git a/lib/OpenLayers/Tile.js b/lib/OpenLayers/Tile.js index f200d547c8..280953baab 100644 --- a/lib/OpenLayers/Tile.js +++ b/lib/OpenLayers/Tile.js @@ -129,7 +129,7 @@ OpenLayers.Tile = OpenLayers.Class({ * Clear whatever is currently in the tile, then return whether or not * it should actually be re-drawn. * - * Return: + * Returns: * {Boolean} Whether or not the tile should actually be drawn. Note that * this is not really the best way of doing things, but such is * the way the code has been developed. Subclasses call this and @@ -201,7 +201,7 @@ OpenLayers.Tile = OpenLayers.Class({ * Parameters: * position - {} * - * Return: + * Returns: * bounds - {} */ getBoundsFromBaseLayer: function(position) { diff --git a/lib/OpenLayers/Tile/Image.js b/lib/OpenLayers/Tile/Image.js index 23dc98fd63..2b205d473f 100644 --- a/lib/OpenLayers/Tile/Image.js +++ b/lib/OpenLayers/Tile/Image.js @@ -84,7 +84,7 @@ OpenLayers.Tile.Image = OpenLayers.Class(OpenLayers.Tile, { * Method: draw * Check that a tile should be drawn, and draw it. * - * Return: + * Returns: * {Boolean} Always returns true. */ draw:function() { diff --git a/lib/OpenLayers/Util.js b/lib/OpenLayers/Util.js index da66596f16..61ead807c4 100644 --- a/lib/OpenLayers/Util.js +++ b/lib/OpenLayers/Util.js @@ -193,7 +193,7 @@ OpenLayers.Util.modifyDOMElement = function(element, id, px, sz, position, * overflow - {String} The style.overflow value. Eg. hidden * opacity - {Float} Fractional value (0.0 - 1.0) * - * Return: + * Returns: * {DOMElement} A DOM Div created with the specified attributes. */ OpenLayers.Util.createDiv = function(id, px, sz, imgURL, position, @@ -234,7 +234,7 @@ OpenLayers.Util.createDiv = function(id, px, sz, imgURL, position, * loaded. * opacity - {Float} Fractional value (0.0 - 1.0) * - * Return: + * Returns: * {DOMElement} A DOM Image created with the specified attributes. */ OpenLayers.Util.createImage = function(id, px, sz, imgURL, position, border, @@ -353,7 +353,7 @@ OpenLayers.Util.onImageLoadError = function() { * hack which allows alpha transparency for png images under Internet * Explorer. * - * Return: + * Returns: * {Boolean} true if alpha has is necessary and possible, false otherwise. */ OpenLayers.Util.alphaHack = function() { @@ -437,7 +437,7 @@ OpenLayers.Util.modifyAlphaImageDiv = function(div, id, px, sz, imgURL, * sizing {String} 'crop', 'scale', or 'image'. Default is "scale" * delayDisplay{Boolean} * - * Return: + * Returns: * {DOMElement} A DOM Div created with a DOM Image inside it. If the hack is * needed for transparency in IE, it is added. */ @@ -509,7 +509,7 @@ OpenLayers.Util.applyDefaults = function (to, from) { * Parameters: * params - {Object} * - * Return: + * Returns: * {String} A concatenation of the properties of an object in * http parameter notation. * (ex. "key1=value1&key2=value2&key3=value3") @@ -552,7 +552,7 @@ OpenLayers.ImgPath = ''; /** * Function: getImagesLocation * - * Return: + * Returns: * {String} The fully formatted image location string */ OpenLayers.Util.getImagesLocation = function() { @@ -572,7 +572,7 @@ OpenLayers.Util.getImagesLocation = function() { * successfully executes. * If none executes successfully, returns null. * - * Return: + * Returns: * {*} The value returned by the first successfully executed function. */ OpenLayers.Util.Try = function() { @@ -599,7 +599,7 @@ OpenLayers.Util.Try = function() { * p - {} * tagName - {String} * - * Return: + * Returns: * {Array} */ OpenLayers.Util.getNodes=function(p, tagName) { @@ -622,7 +622,7 @@ OpenLayers.Util.getNodes=function(p, tagName) { * nodes - {Array} * tagName - {String} * - * Return: + * Returns: * {Array} */ OpenLayers.Util._getNodes=function(nodes, tagName) { @@ -646,7 +646,7 @@ OpenLayers.Util._getNodes=function(nodes, tagName) { * item - {String} * index - {Integer} * - * Return: + * Returns: * {String} */ OpenLayers.Util.getTagText = function (parent, item, index) { @@ -673,7 +673,7 @@ OpenLayers.Util.getTagText = function (parent, item, index) { * Parameters: * node - {XMLNode} * - * Return: + * Returns: * {String} The text value of the given node, without breaking in firefox or IE */ OpenLayers.Util.getXmlNodeValue = function(node) { @@ -699,7 +699,7 @@ OpenLayers.Util.getXmlNodeValue = function(node) { * evt - {Event} * div - {HTMLDivElement} * - * Return: + * Returns: * {Boolean} */ OpenLayers.Util.mouseLeft = function (evt, div) { @@ -719,7 +719,7 @@ OpenLayers.Util.mouseLeft = function (evt, div) { * Parameters: * x - {Float} * - * Return: + * Returns: * {Float} */ OpenLayers.Util.rad = function(x) {return x*Math.PI/180;}; @@ -731,7 +731,7 @@ OpenLayers.Util.rad = function(x) {return x*Math.PI/180;}; * p1 - {Float} * p2 - {Float} * - * Return: + * Returns: * {Float} */ OpenLayers.Util.distVincenty=function(p1, p2) { @@ -779,7 +779,7 @@ OpenLayers.Util.distVincenty=function(p1, p2) { * url - {String} Optional url used to extract the query string. * If null, query string is taken from page location. * - * Return: + * Returns: * {Object} An object of key/value pairs from the query string. */ OpenLayers.Util.getParameters = function(url) { @@ -831,7 +831,7 @@ OpenLayers.Util.getParameters = function(url) { * url - {String} Optional url used to extract the query string. * If null, query string is taken from page location. * - * Return: + * Returns: * {Object} An object of key/value pairs from the query string. */ OpenLayers.Util.getArgs = function(url) { @@ -856,7 +856,7 @@ OpenLayers.Util.lastSeqID = 0; * prefix {String} String to prefix unique id. * If null, default is "id_" * - * Return: + * Returns: * {String} A unique id string, built on the passed in prefix */ OpenLayers.Util.createUniqueID = function(prefix) { @@ -894,7 +894,7 @@ OpenLayers.DOTS_PER_INCH = 72; * Parameters: * scale - {float} * - * Return: + * Returns: * {Float} A normalized scale value, in 1 / X format. * This means that if a value less than one ( already 1/x) is passed * in, it just returns scale directly. Otherwise, it returns @@ -914,7 +914,7 @@ OpenLayers.Util.normalizeScale = function (scale) { * units - {String} Index into OpenLayers.INCHES_PER_UNIT hashtable. * Default is degrees * - * Return: + * Returns: * {Float} The corresponding resolution given passed-in scale and unit * parameters. */ @@ -939,7 +939,7 @@ OpenLayers.Util.getResolutionFromScale = function (scale, units) { * units - {String} Index into OpenLayers.INCHES_PER_UNIT hashtable. * Default is degrees * - * Return: + * Returns: * {Float} The corresponding scale given passed-in resolution and unit * parameters. */ @@ -979,7 +979,7 @@ OpenLayers.Util.safeStopPropagation = function(evt) { * Parameters: * forElement - {DOMElement} * - * Return:´ + * Returns:´ * {Array} two item array, L value then T value. */ OpenLayers.Util.pagePosition = function(forElement) { @@ -1044,7 +1044,7 @@ OpenLayers.Util.pagePosition = function(forElement) { * 'ignorePort80' - Default is True * 'ignoreHash' - Default is True * - * Return: + * Returns: * {Boolean} Whether or not the two URLs are equivalent */ OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) { @@ -1116,7 +1116,7 @@ OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) { * ignorePort80: don't include explicit port if port is 80, * ignoreHash: Don't include part of url after the hash (#). * - * Return: + * Returns: * {Object} An object with separate url, a, port, host, and args parsed out * and ready for comparison */ @@ -1227,7 +1227,7 @@ OpenLayers.Util.createUrlObject = function(url, options) { * Parameters: * url - {String} The url to process * - * Return: + * Returns: * {String} The string with all queryString and Hash removed */ OpenLayers.Util.removeTail = function(url) { @@ -1249,7 +1249,7 @@ OpenLayers.Util.removeTail = function(url) { /** * Function: getBrowserName * - * Return: + * Returns: * {String} A string which specifies which is the current * browser in which we are running. *