diff --git a/lib/OpenLayers/Control/DragFeature.js b/lib/OpenLayers/Control/DragFeature.js index 9daf5b3b54..1e93abc9f4 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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {Boolean} Successfully deactivated the control. */ deactivate: function() { diff --git a/lib/OpenLayers/Control/LayerSwitcher.js b/lib/OpenLayers/Control/LayerSwitcher.js index d053eda69a..254f5b4e0a 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 * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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 ceb5f5fe0c..02f484872d 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} * - * Returns: + * Return: * {Boolean} */ defaultClick: function (evt) { @@ -109,11 +109,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, { }, /** - * Method: defaultDblClick - * - * Parameters: - * evt - {Event} - */ + * Method: defaultDblClick + * + * Parameters: + * evt - {Event} + */ defaultDblClick: function (evt) { var newCenter = this.map.getLonLatFromViewPortPx( evt.xy ); this.map.setCenter(newCenter, this.map.zoom + 1); @@ -122,11 +122,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, { }, /** - * Method: defaultMouseDown - * - * Parameters: - * evt - {Event} - */ + * Method: defaultMouseDown + * + * Parameters: + * evt - {Event} + */ defaultMouseDown: function (evt) { if (!OpenLayers.Event.isLeftClick(evt)) return; this.mouseDragStart = evt.xy.clone(); @@ -151,11 +151,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, { }, /** - * Method: defaultMouseMove - * - * Parameters: - * evt - {Event} - */ + * Method: defaultMouseMove + * + * Parameters: + * evt - {Event} + */ defaultMouseMove: function (evt) { // record the mouse position, used in onWheelEvent this.mousePosition = evt.xy.clone(); @@ -188,11 +188,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, { }, /** - * Method: defaultMouseUp - * - * Parameters: - * evt - {} - */ + * Method: defaultMouseUp + * + * Parameters: + * evt - {} + */ defaultMouseUp: function (evt) { if (!OpenLayers.Event.isLeftClick(evt)) return; if (this.zoomBox) { @@ -208,11 +208,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, { }, /** - * Method: defaultMouseOut - * - * Parameters: - * evt - {Event} - */ + * Method: defaultMouseOut + * + * Parameters: + * evt - {Event} + */ defaultMouseOut: function (evt) { if (this.mouseDragStart != null && OpenLayers.Util.mouseLeft(evt, this.map.div)) { @@ -343,4 +343,3 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, { CLASS_NAME: "OpenLayers.Control.MouseDefaults" }); - diff --git a/lib/OpenLayers/Control/PanZoom.js b/lib/OpenLayers/Control/PanZoom.js index 612cd83e70..c1d8572e19 100644 --- a/lib/OpenLayers/Control/PanZoom.js +++ b/lib/OpenLayers/Control/PanZoom.js @@ -55,14 +55,14 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, { }, /** - * Method: draw - * - * Parameters: - * px - {} - * - * Returns: - * {DOMElement} A reference to the container div for the PanZoom control - */ + * Method: draw + * + * Parameters: + * px - {} + * + * Return: + * {DOMElement} A reference to the container div for the PanZoom control + */ draw: function(px) { // initialize our internal div OpenLayers.Control.prototype.draw.apply(this, arguments); @@ -98,7 +98,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, { * xy - {} * sz - {} * - * Returns: + * Return: * {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,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, { * Parameters: * evt - {Event} * - * Returns: {Boolean} + * Return: {Boolean} */ doubleClick: function (evt) { OpenLayers.Event.stop(evt); diff --git a/lib/OpenLayers/Control/Panel.js b/lib/OpenLayers/Control/Panel.js index a0d3032f0c..719d73d72b 100644 --- a/lib/OpenLayers/Control/Panel.js +++ b/lib/OpenLayers/Control/Panel.js @@ -82,7 +82,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, { /** * Method: draw * - * Returns: {DOMElement} + * Return: {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 324453b188..b288f7c1dd 100644 --- a/lib/OpenLayers/Control/Permalink.js +++ b/lib/OpenLayers/Control/Permalink.js @@ -78,7 +78,7 @@ OpenLayers.Control.Permalink = OpenLayers.Class(OpenLayers.Control, { /** * Method: draw * - * Returns: {DOMElement} + * Return: {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 a5d4399e7c..6434aa2142 100644 --- a/lib/OpenLayers/Control/Scale.js +++ b/lib/OpenLayers/Control/Scale.js @@ -34,7 +34,7 @@ OpenLayers.Control.Scale = OpenLayers.Class(OpenLayers.Control, { /** * Method: draw * - * Returns: {DOMElemen}t + * Return: {DOMElemen} */ draw: function() { OpenLayers.Control.prototype.draw.apply(this, arguments); diff --git a/lib/OpenLayers/Feature.js b/lib/OpenLayers/Feature.js index 274ea13d1e..0bd84ddd50 100644 --- a/lib/OpenLayers/Feature.js +++ b/lib/OpenLayers/Feature.js @@ -98,7 +98,7 @@ OpenLayers.Feature = OpenLayers.Class({ /** * Method: onScreen * - * Returns: + * Return: * {Boolean} Whether or not the feature is currently visible on screen * (based on its 'lonlat' property) */ @@ -157,7 +157,7 @@ OpenLayers.Feature = OpenLayers.Class({ * Parameters: * closeBox - {Boolean} create popup with closebox or not * - * Returns: + * Return: * {} * */ diff --git a/lib/OpenLayers/Feature/Vector.js b/lib/OpenLayers/Feature/Vector.js index 550b200630..0b54dca09f 100644 --- a/lib/OpenLayers/Feature/Vector.js +++ b/lib/OpenLayers/Feature/Vector.js @@ -96,14 +96,14 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { OpenLayers.Feature.prototype.destroy.apply(this, arguments); }, - /** - * Method: clone - * Create a clone of this vector feature. Does not set any non-standard - * properties. - * - * Returns: - * {} An exact clone of this vector feature. - */ + /** + * Method: clone + * Create a clone of this vector feature. Does not set any non-standard + * properties. + * + * Return: + * {} An exact clone of this vector feature. + */ clone: function () { return new OpenLayers.Feature.Vector(this.geometry.clone(), this.attributes, @@ -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 * - * Returns: + * Return: * {Boolean} Whether or not the feature is at the specified location */ atPoint: function(lonlat, toleranceLon, toleranceLat) { @@ -234,11 +234,10 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { }); -/* +/** * Constant: OpenLayers.Feature.Vector.style - * OpenLayers features can have a number of - * style attributes. The 'default' style will - * typically be used if no other style is specified. + * OpenLayers features can have a number of style attributes. The 'default' + * style will typically be used if no other style is specified. * * Default style properties: * @@ -258,7 +257,6 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, { * - hoverPointUnit: "%", * - pointerEvents: "visiblePainted" */ - OpenLayers.Feature.Vector.style = { 'default': { fillColor: "#ee9900", diff --git a/lib/OpenLayers/Format/GML.js b/lib/OpenLayers/Format/GML.js index c339ad201b..d937f89647 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} * - * Returns: + * Return: * {} polygon geometry */ parsePolygonNode: function(polygonNode) { @@ -291,7 +291,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * xmlNode - {} * - * Returns: + * Return: * An array of points. */ parseCoords: function(xmlNode) { @@ -365,7 +365,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * feature - {} * - * Returns: + * Return: * {DOMElement} */ createFeatureXML: function(feature) { @@ -475,7 +475,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, { * Parameters: * geometry - {} * - * Returns: + * Return: * {XmlNode} created xmlNode */ buildCoordinatesNode: function(geometry) { diff --git a/lib/OpenLayers/Format/GeoJSON.js b/lib/OpenLayers/Format/GeoJSON.js index 0b90b05035..8156dbfd88 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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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 * - * Returns: + * Return: * {} 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 * - * Returns: + * Return: * {} 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. * - * Returns: + * Return: * {} 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. * - * Returns: + * Return: * {} 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. * - * Returns: + * Return: * {} 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. * - * Returns: + * Return: * {} A geometry. */ "multilinestring": function(array) { @@ -338,10 +338,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Convert a coordinate array from GeoJSON into an * . * - * Returns: - * array - {Object} The coordinates array from the GeoJSON fragment. - * - * Returns: + * Return: * {} A geometry. */ "polygon": function(array) { @@ -367,7 +364,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array - {Object} The coordinates array from the GeoJSON fragment. * - * Returns: + * Return: * {} A geometry. */ "multipolygon": function(array) { @@ -392,7 +389,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * array - {Object} The coordinates array from the GeoJSON fragment. * - * Returns: + * Return: * {} A geometry. */ "box": function(array) { @@ -423,7 +420,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * pretty - {Boolean} Structure the output with newlines and indentation. * Default is false. * - * Returns: + * Return: * {String} The GeoJSON string representation of the input geometry, * features, array of geometries, or array of features. */ @@ -497,7 +494,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * feature - {} * - * Returns: + * Return: * {Object} An object representing the point. */ 'feature': function(feature) { @@ -517,7 +514,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * geometry - {} * - * Returns: + * Return: * {Object} An object representing the geometry. */ 'geometry': function(geometry) { @@ -536,7 +533,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * point - {} * - * Returns: + * Return: * {Array} An array of coordinates representing the point. */ 'point': function(point) { @@ -550,7 +547,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * multipoint - {} * - * Returns: + * Return: * {Array} An array of point coordinate arrays representing * the multipoint. */ @@ -569,7 +566,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * linestring - {} * - * Returns: + * Return: * {Array} An array of coordinate arrays representing * the linestring. */ @@ -588,7 +585,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * linestring - {} * - * Returns: + * Return: * {Array} An array of linestring arrays representing * the multilinestring. */ @@ -607,7 +604,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * polygon - {} * - * Returns: + * Return: * {Array} An array of linear ring arrays representing the polygon. */ 'polygon': function(polygon) { @@ -625,7 +622,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, { * Parameters: * multipolygon - {} * - * Returns: + * Return: * {Array} An array of polygon arrays representing * the multipolygon */ diff --git a/lib/OpenLayers/Format/GeoRSS.js b/lib/OpenLayers/Format/GeoRSS.js index 047d91f4f7..bb55974fb1 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 - {} * - * Returns: + * Return: * {DOMElement} */ createFeatureXML: function(feature) { diff --git a/lib/OpenLayers/Format/JSON.js b/lib/OpenLayers/Format/JSON.js index e79e16912b..a93f1bc82c 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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {String} A space. */ writeSpace: function() { @@ -206,7 +206,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, { * Parameters: * object - {Object} The object to be serialized. * - * Returns: + * Return: * {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 * - * Returns: + * Return: * {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 * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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 a2aaa7b3ec..ad068d4b40 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 - {} * - * Returns: + * Return: * An array of points. */ parseCoords: function(xmlNode) { diff --git a/lib/OpenLayers/Format/XML.js b/lib/OpenLayers/Format/XML.js index 3d90c837b8..754d5eb795 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 - * Returns: + * Return: * {DOMElement} A DOM node */ read: function(text) { @@ -101,7 +101,7 @@ OpenLayers.Format.XML.prototype = * Parameters: * node - {DOMElement} A DOM node. * - * Returns: + * Return: * {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). * - * Returns: + * Return: * {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. * - * Returns: + * Return: * {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). * - * Returns: + * Return: * {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). * - * Returns: + * Return: * {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). * - * Returns: + * Return: * {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). * - * Returns: + * Return: * {Boolean} The node has an attribute matching the name and namespace. */ hasAttributeNS: function(node, uri, name) { diff --git a/lib/OpenLayers/Handler.js b/lib/OpenLayers/Handler.js index ce2f3883f1..252589d0c3 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. * - * Returns: + * Return: * {Boolean} The keyMask matches the keys down on an event. */ checkModifiers: function (evt) { diff --git a/lib/OpenLayers/Handler/Feature.js b/lib/OpenLayers/Handler/Feature.js index 00388efe96..fd147449d0 100644 --- a/lib/OpenLayers/Handler/Feature.js +++ b/lib/OpenLayers/Handler/Feature.js @@ -82,8 +82,8 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, { /** * Method: dblclick * Capture double-clicks. Let the event continue propagating if the - * double-click doesn't hit a feature. Otherwise call the dblclick - * callback. + * double-click doesn't hit a feature. Otherwise call the dblclick + * callback. * * Parameters: * evt - {Event} @@ -149,7 +149,8 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, { * Method: activate * Turn of the handler. Returns false if the handler was already active. * - * Returns: {Boolean} + * Return: + * {Boolean} */ deactivate: function() { if(OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) { diff --git a/lib/OpenLayers/Icon.js b/lib/OpenLayers/Icon.js index 44f040b955..57eda50762 100644 --- a/lib/OpenLayers/Icon.js +++ b/lib/OpenLayers/Icon.js @@ -54,13 +54,13 @@ OpenLayers.Icon = OpenLayers.Class({ px: null, /** - * Constructor: OpenLayers.Icon - * Creates an icon, which is an image tag in a div. - * - * url - {String} - * size - {} - * calculateOffset - {Function} - */ + * Constructor: OpenLayers.Icon + * Creates an icon, which is an image tag in a div. + * + * url - {String} + * size - {} + * calculateOffset - {Function} + */ initialize: function(url, size, offset, calculateOffset) { this.url = url; this.size = (size) ? size : new OpenLayers.Size(20,20); @@ -83,11 +83,11 @@ OpenLayers.Icon = OpenLayers.Class({ }, /** - * Method: clone - * - * Returns: - * {} A fresh copy of the icon. - */ + * Method: clone + * + * Return: + * {} A fresh copy of the icon. + */ clone: function() { return new OpenLayers.Icon(this.url, this.size, @@ -108,15 +108,15 @@ OpenLayers.Icon = OpenLayers.Class({ }, /** - * Method: draw - * Move the div to the given pixel. - * - * Parameters: - * px - {} - * - * Returns: - * {DOMElement} A new DOM Image of this icon set at the location passed-in - */ + * Method: draw + * Move the div to the given pixel. + * + * Parameters: + * px - {} + * + * Return: + * {DOMElement} A new DOM Image of this icon set at the location passed-in + */ draw: function(px) { OpenLayers.Util.modifyAlphaImageDiv(this.imageDiv, null, @@ -143,12 +143,12 @@ OpenLayers.Icon = OpenLayers.Class({ }, /** - * Method: moveTo - * move icon to passed in px. - * - * Parameters: - * px - {} - */ + * Method: moveTo + * move icon to passed in px. + * + * Parameters: + * px - {} + */ moveTo: function (px) { //if no px passed in, use stored location if (px != null) { diff --git a/lib/OpenLayers/Layer.js b/lib/OpenLayers/Layer.js index 02456beb6e..e1736d88bb 100644 --- a/lib/OpenLayers/Layer.js +++ b/lib/OpenLayers/Layer.js @@ -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. * - * Returns: + * Return: * {} */ getDataExtent: function () { diff --git a/lib/OpenLayers/Layer/Markers.js b/lib/OpenLayers/Layer/Markers.js index c5c891271e..cdc5d70ba5 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. * - * Returns: + * Return: * {} */ getDataExtent: function () { diff --git a/lib/OpenLayers/Layer/TileCache.js b/lib/OpenLayers/Layer/TileCache.js index 0887ba51a4..40024b97bb 100644 --- a/lib/OpenLayers/Layer/TileCache.js +++ b/lib/OpenLayers/Layer/TileCache.js @@ -20,38 +20,39 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * APIProperty: reproject * {Boolean} Try to reproject this layer if it is used as an overlay. * Default is false. - **/ + */ reproject: false, /** * APIProperty: isBaseLayer * {Boolean} Treat this layer as a base layer. Default is true. - **/ + */ isBaseLayer: true, /** * APIProperty: tileOrigin * {} Location of the tile lattice origin. Default is * bottom left of the maxExtent. - **/ + */ tileOrigin: null, /** * APIProperty: format * {String} Mime type of the images returned. Default is image/png. - **/ + */ format: 'image/png', /** - * Constructor: OpenLayers.Layer.TileCache - * Create a new read only TileCache layer. - * - * Parameters: - * name - {String} Name of the layer displayed in the interface - * url - {String} Location of the web accessible cache - * layername - {String} Layer name as defined in the TileCache configuration - * options - {Object} Hashtable of extra options to tag onto the layer - */ + * Constructor: OpenLayers.Layer.TileCache + * Create a new read only TileCache layer. + * + * Parameters: + * name - {String} Name of the layer displayed in the interface + * url - {String} Location of the web accessible cache + * layername - {String} Layer name as defined in the TileCache + * configuration + * options - {Object} Hashtable of extra options to tag onto the layer + */ initialize: function(name, url, layername, options) { options = OpenLayers.Util.extend({maxResolution: 180/256}, options); this.layername = layername; @@ -65,8 +66,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * APIMethod: clone * obj - {Object} * - * Returns: - * An exact clone of this + * Return: + * {} An exact clone of this + * */ clone: function (obj) { @@ -90,10 +92,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * Parameters: * bounds - {} * - * Returns: - * A string with the layer's url and parameters and also the - * passed-in bounds and appropriate tile size specified as - * parameters + * Return: + * {String} A string with the layer's url and parameters and also the + * passed-in bounds and appropriate tile size specified as parameters. */ getURL: function(bounds) { var res = this.map.getResolution(); @@ -106,9 +107,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { * Zero-pad a positive integer. * number - {Int} * length - {Int} - - * Returns: - * A zero-padded string + * + * Return: + * {String} A zero-padded string */ function zeroPad(number, length) { number = String(number); @@ -138,15 +139,15 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, { }, /** - * Method: addTile - * Create a tile, initialize it, and add it to the layer div. - * - * Parameters: - * bounds - {} - * - * Returns: - * The added {} - */ + * Method: addTile + * Create a tile, initialize it, and add it to the layer div. + * + * Parameters: + * bounds - {} + * + * Return: + * {} The added + */ addTile:function(bounds, position) { var url = this.getURL(bounds); return new OpenLayers.Tile.Image(this, position, bounds, diff --git a/lib/OpenLayers/Layer/Vector.js b/lib/OpenLayers/Layer/Vector.js index 0fae25c05e..7522ef1cb0 100644 --- a/lib/OpenLayers/Layer/Vector.js +++ b/lib/OpenLayers/Layer/Vector.js @@ -357,7 +357,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, { * Parameters: * evt - {Event} * - * Returns: + * Return: * {} 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} * - * Returns: + * Return: * {} A feature corresponding to the given * featureId */ diff --git a/lib/OpenLayers/Layer/WFS.js b/lib/OpenLayers/Layer/WFS.js index ed449175e1..a7b0aab2da 100644 --- a/lib/OpenLayers/Layer/WFS.js +++ b/lib/OpenLayers/Layer/WFS.js @@ -25,7 +25,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class( /** * APIProperty: ratio * {Float} the ratio of image/tile size to map size (this is the untiled - * buffer) + * buffer) */ ratio: 2, @@ -41,8 +41,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class( /** * APIProperty: featureClass * {} If featureClass is defined, an old-style markers - * based WFS layer is created instead of a new-style vector layer. If - * sent, this should be a subclass of OpenLayers.Feature + * based WFS layer is created instead of a new-style vector layer. If + * sent, this should be a subclass of OpenLayers.Feature */ featureClass: null, @@ -55,19 +55,19 @@ OpenLayers.Layer.WFS = OpenLayers.Class( /** * APIProperty: encodeBBOX * {Boolean} Should the BBOX commas be encoded? The WMS spec says 'no', - * but some services want it that way. Default false. + * but some services want it that way. Default false. */ encodeBBOX: false, /** - * Constructor: OpenLayers.Layer.WFS - * - * Parameters: - * name - {String} - * url - {String} - * params - {Object} - * options - {Object} Hashtable of extra options to tag onto the layer - */ + * Constructor: OpenLayers.Layer.WFS + * + * Parameters: + * name - {String} + * url - {String} + * params - {Object} + * options - {Object} Hashtable of extra options to tag onto the layer + */ initialize: function(name, url, params, options) { if (options == undefined) { options = {}; } @@ -277,8 +277,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class( * Parameters: * obj - {Object} * - * Returns: - * {} LAn exact clone of this OpenLayers.Layer.WFS + * Return: + * {} An exact clone of this OpenLayers.Layer.WFS */ clone: function (obj) { @@ -387,8 +387,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class( /** * APIMethod: commitReport * Called with a 'success' message if the commit succeeded, otherwise - * a failure message, and the full request text as a second parameter. - * Override this function to provide custom transaction reporting. + * a failure message, and the full request text as a second parameter. + * Override this function to provide custom transaction reporting. * * string - {String} reporting string * response - {String} full XML response diff --git a/lib/OpenLayers/Layer/WorldWind.js b/lib/OpenLayers/Layer/WorldWind.js index f8c46173cb..7eb48c3452 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 - {} * - * Returns: + * Return: * {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/Marker.js b/lib/OpenLayers/Marker.js index 54991974f5..30682b74e6 100644 --- a/lib/OpenLayers/Marker.js +++ b/lib/OpenLayers/Marker.js @@ -189,7 +189,7 @@ OpenLayers.Marker = OpenLayers.Class({ * Function: defaultIcon * Creates a default . * - * Returns: + * Return: * {} A default OpenLayers.Icon to use for a marker */ OpenLayers.Marker.defaultIcon = function() { diff --git a/lib/OpenLayers/Popup.js b/lib/OpenLayers/Popup.js index 59130b5675..1e1c583389 100644 --- a/lib/OpenLayers/Popup.js +++ b/lib/OpenLayers/Popup.js @@ -246,7 +246,7 @@ OpenLayers.Popup = OpenLayers.Class({ /** * Method: visible * - * Returns: + * Return: * {Boolean} Boolean indicating whether or not the popup is visible */ visible: function() { diff --git a/lib/OpenLayers/Renderer.js b/lib/OpenLayers/Renderer.js index b2c82af3ba..2c8c9571e9 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 * - * Returns: + * Return: * {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 * - * Returns: + * Return: * The current map's resolution */ getResolution: function() { @@ -176,7 +176,7 @@ OpenLayers.Renderer = OpenLayers.Class({ * Parameters: * evt - {} * - * Returns: + * Return: * {String} A feature id or null. */ getFeatureIdFromEvent: function(evt) {},