wiki/NaturalDocs says we should be using 'Return:' and not 'Returns:' so this patch is fixing that. Of course, in the process, I came across not a few instances where other ND related whitespace or typos were at odds with a peaceful, uniform OL codebase. No functional changes here, just makin' things pretty.

git-svn-id: http://svn.openlayers.org/trunk/openlayers@4109 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2007-08-29 18:08:32 +00:00
parent e5641c76e0
commit b5ef77096c
27 changed files with 192 additions and 196 deletions
+2 -2
View File
@@ -135,7 +135,7 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: activate * APIMethod: activate
* Activate the control and the feature handler. * Activate the control and the feature handler.
* *
* Returns: * Return:
* {Boolean} Successfully activated the control and feature handler. * {Boolean} Successfully activated the control and feature handler.
*/ */
activate: function() { activate: function() {
@@ -147,7 +147,7 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: deactivate * APIMethod: deactivate
* Deactivate the control and all handlers. * Deactivate the control and all handlers.
* *
* Returns: * Return:
* {Boolean} Successfully deactivated the control. * {Boolean} Successfully deactivated the control.
*/ */
deactivate: function() { deactivate: function() {
+2 -2
View File
@@ -126,7 +126,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
/** /**
* Method: draw * Method: draw
* *
* Returns: * Return:
* {DOMElement} A reference to the DIV DOMElement containing the switcher * {DOMElement} A reference to the DIV DOMElement containing the switcher
* tabs * tabs
*/ */
@@ -175,7 +175,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
* control to display that state. Groups base layers into a radio-button * control to display that state. Groups base layers into a radio-button
* group and lists each data layer with a checkbox. * group and lists each data layer with a checkbox.
* *
* Returns: * Return:
* {DOMElement} A reference to the DIV DOMElement containing the control * {DOMElement} A reference to the DIV DOMElement containing the control
*/ */
redraw: function() { redraw: function() {
+26 -27
View File
@@ -98,7 +98,7 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
* *
* Returns: * Return:
* {Boolean} * {Boolean}
*/ */
defaultClick: function (evt) { defaultClick: function (evt) {
@@ -109,11 +109,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
}, },
/** /**
* Method: defaultDblClick * Method: defaultDblClick
* *
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
*/ */
defaultDblClick: function (evt) { defaultDblClick: function (evt) {
var newCenter = this.map.getLonLatFromViewPortPx( evt.xy ); var newCenter = this.map.getLonLatFromViewPortPx( evt.xy );
this.map.setCenter(newCenter, this.map.zoom + 1); this.map.setCenter(newCenter, this.map.zoom + 1);
@@ -122,11 +122,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
}, },
/** /**
* Method: defaultMouseDown * Method: defaultMouseDown
* *
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
*/ */
defaultMouseDown: function (evt) { defaultMouseDown: function (evt) {
if (!OpenLayers.Event.isLeftClick(evt)) return; if (!OpenLayers.Event.isLeftClick(evt)) return;
this.mouseDragStart = evt.xy.clone(); this.mouseDragStart = evt.xy.clone();
@@ -151,11 +151,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
}, },
/** /**
* Method: defaultMouseMove * Method: defaultMouseMove
* *
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
*/ */
defaultMouseMove: function (evt) { defaultMouseMove: function (evt) {
// record the mouse position, used in onWheelEvent // record the mouse position, used in onWheelEvent
this.mousePosition = evt.xy.clone(); this.mousePosition = evt.xy.clone();
@@ -188,11 +188,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
}, },
/** /**
* Method: defaultMouseUp * Method: defaultMouseUp
* *
* Parameters: * Parameters:
* evt - {<OpenLayers.Event>} * evt - {<OpenLayers.Event>}
*/ */
defaultMouseUp: function (evt) { defaultMouseUp: function (evt) {
if (!OpenLayers.Event.isLeftClick(evt)) return; if (!OpenLayers.Event.isLeftClick(evt)) return;
if (this.zoomBox) { if (this.zoomBox) {
@@ -208,11 +208,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
}, },
/** /**
* Method: defaultMouseOut * Method: defaultMouseOut
* *
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
*/ */
defaultMouseOut: function (evt) { defaultMouseOut: function (evt) {
if (this.mouseDragStart != null && if (this.mouseDragStart != null &&
OpenLayers.Util.mouseLeft(evt, this.map.div)) { OpenLayers.Util.mouseLeft(evt, this.map.div)) {
@@ -343,4 +343,3 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
CLASS_NAME: "OpenLayers.Control.MouseDefaults" CLASS_NAME: "OpenLayers.Control.MouseDefaults"
}); });
+10 -10
View File
@@ -55,14 +55,14 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
}, },
/** /**
* Method: draw * Method: draw
* *
* Parameters: * Parameters:
* px - {<OpenLayers.Pixel>} * px - {<OpenLayers.Pixel>}
* *
* Returns: * Return:
* {DOMElement} A reference to the container div for the PanZoom control * {DOMElement} A reference to the container div for the PanZoom control
*/ */
draw: function(px) { draw: function(px) {
// initialize our internal div // initialize our internal div
OpenLayers.Control.prototype.draw.apply(this, arguments); OpenLayers.Control.prototype.draw.apply(this, arguments);
@@ -98,7 +98,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
* xy - {<OpenLayers.Pixel>} * xy - {<OpenLayers.Pixel>}
* sz - {<OpenLayers.Size>} * sz - {<OpenLayers.Size>}
* *
* Returns: * Return:
* {DOMElement} A Div (an alphaImageDiv, to be precise) that contains the * {DOMElement} A Div (an alphaImageDiv, to be precise) that contains the
* image of the button, and has all the proper event handlers set. * image of the button, and has all the proper event handlers set.
*/ */
@@ -132,7 +132,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
* *
* Returns: {Boolean} * Return: {Boolean}
*/ */
doubleClick: function (evt) { doubleClick: function (evt) {
OpenLayers.Event.stop(evt); OpenLayers.Event.stop(evt);
+1 -1
View File
@@ -82,7 +82,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
/** /**
* Method: draw * Method: draw
* *
* Returns: {DOMElement} * Return: {DOMElement}
*/ */
draw: function() { draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments); OpenLayers.Control.prototype.draw.apply(this, arguments);
+1 -1
View File
@@ -78,7 +78,7 @@ OpenLayers.Control.Permalink = OpenLayers.Class(OpenLayers.Control, {
/** /**
* Method: draw * Method: draw
* *
* Returns: {DOMElement} * Return: {DOMElement}
*/ */
draw: function() { draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments); OpenLayers.Control.prototype.draw.apply(this, arguments);
+1 -1
View File
@@ -34,7 +34,7 @@ OpenLayers.Control.Scale = OpenLayers.Class(OpenLayers.Control, {
/** /**
* Method: draw * Method: draw
* *
* Returns: {DOMElemen}t * Return: {DOMElemen}
*/ */
draw: function() { draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments); OpenLayers.Control.prototype.draw.apply(this, arguments);
+2 -2
View File
@@ -98,7 +98,7 @@ OpenLayers.Feature = OpenLayers.Class({
/** /**
* Method: onScreen * Method: onScreen
* *
* Returns: * Return:
* {Boolean} Whether or not the feature is currently visible on screen * {Boolean} Whether or not the feature is currently visible on screen
* (based on its 'lonlat' property) * (based on its 'lonlat' property)
*/ */
@@ -157,7 +157,7 @@ OpenLayers.Feature = OpenLayers.Class({
* Parameters: * Parameters:
* closeBox - {Boolean} create popup with closebox or not * closeBox - {Boolean} create popup with closebox or not
* *
* Returns: * Return:
* {<OpenLayers.Popup.AnchoredBubble>} * {<OpenLayers.Popup.AnchoredBubble>}
* *
*/ */
+12 -14
View File
@@ -96,14 +96,14 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
OpenLayers.Feature.prototype.destroy.apply(this, arguments); OpenLayers.Feature.prototype.destroy.apply(this, arguments);
}, },
/** /**
* Method: clone * Method: clone
* Create a clone of this vector feature. Does not set any non-standard * Create a clone of this vector feature. Does not set any non-standard
* properties. * properties.
* *
* Returns: * Return:
* {<OpenLayers.Feature.Vector>} An exact clone of this vector feature. * {<OpenLayers.Feature.Vector>} An exact clone of this vector feature.
*/ */
clone: function () { clone: function () {
return new OpenLayers.Feature.Vector(this.geometry.clone(), return new OpenLayers.Feature.Vector(this.geometry.clone(),
this.attributes, this.attributes,
@@ -166,7 +166,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* toleranceLon - {float} Optional tolerance in Geometric Coords * toleranceLon - {float} Optional tolerance in Geometric Coords
* toleranceLat - {float} Optional tolerance in Geographic Coords * toleranceLat - {float} Optional tolerance in Geographic Coords
* *
* Returns: * Return:
* {Boolean} Whether or not the feature is at the specified location * {Boolean} Whether or not the feature is at the specified location
*/ */
atPoint: function(lonlat, toleranceLon, toleranceLat) { atPoint: function(lonlat, toleranceLon, toleranceLat) {
@@ -234,11 +234,10 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
}); });
/* /**
* Constant: OpenLayers.Feature.Vector.style * Constant: OpenLayers.Feature.Vector.style
* OpenLayers features can have a number of * OpenLayers features can have a number of style attributes. The 'default'
* style attributes. The 'default' style will * style will typically be used if no other style is specified.
* typically be used if no other style is specified.
* *
* Default style properties: * Default style properties:
* *
@@ -258,7 +257,6 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* - hoverPointUnit: "%", * - hoverPointUnit: "%",
* - pointerEvents: "visiblePainted" * - pointerEvents: "visiblePainted"
*/ */
OpenLayers.Feature.Vector.style = { OpenLayers.Feature.Vector.style = {
'default': { 'default': {
fillColor: "#ee9900", fillColor: "#ee9900",
+4 -4
View File
@@ -264,7 +264,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* xmlNode - {XMLNode} * xmlNode - {XMLNode}
* *
* Returns: * Return:
* {<OpenLayers.Geometry.Polygon>} polygon geometry * {<OpenLayers.Geometry.Polygon>} polygon geometry
*/ */
parsePolygonNode: function(polygonNode) { parsePolygonNode: function(polygonNode) {
@@ -291,7 +291,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* xmlNode - {<XMLNode>} * xmlNode - {<XMLNode>}
* *
* Returns: * Return:
* An array of <OpenLayers.Geometry.Point> points. * An array of <OpenLayers.Geometry.Point> points.
*/ */
parseCoords: function(xmlNode) { parseCoords: function(xmlNode) {
@@ -365,7 +365,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* feature - {<OpenLayers.Feature.Vector>} * feature - {<OpenLayers.Feature.Vector>}
* *
* Returns: * Return:
* {DOMElement} * {DOMElement}
*/ */
createFeatureXML: function(feature) { createFeatureXML: function(feature) {
@@ -475,7 +475,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* geometry - {<OpenLayers.Geometry>} * geometry - {<OpenLayers.Geometry>}
* *
* Returns: * Return:
* {XmlNode} created xmlNode * {XmlNode} created xmlNode
*/ */
buildCoordinatesNode: function(geometry) { buildCoordinatesNode: function(geometry) {
+20 -23
View File
@@ -42,7 +42,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* reform generic objects into instances of classes, or to transform * reform generic objects into instances of classes, or to transform
* date strings into Date objects. * date strings into Date objects.
* *
* Returns: * Return:
* {Object} The return depends on the value of the type argument. If type * {Object} The return depends on the value of the type argument. If type
* is "FeatureCollection" (the default), the return will be an array * is "FeatureCollection" (the default), the return will be an array
* of <OpenLayers.Feature.Vector>. If type is "Geometry", the input json * of <OpenLayers.Feature.Vector>. If type is "Geometry", the input json
@@ -147,7 +147,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Method: isValidType * Method: isValidType
* Check if a GeoJSON object is a valid representative of the given type. * 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. * {Boolean} The object is valid GeoJSON object of the given type.
*/ */
isValidType: function(obj, type) { isValidType: function(obj, type) {
@@ -188,7 +188,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* obj - {Object} An object created from a GeoJSON object * obj - {Object} An object created from a GeoJSON object
* *
* Returns: * Return:
* {<OpenLayers.Feature.Vector>} A feature. * {<OpenLayers.Feature.Vector>} A feature.
*/ */
parseFeature: function(obj) { parseFeature: function(obj) {
@@ -214,7 +214,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* obj - {Object} An object created from a GeoJSON object * obj - {Object} An object created from a GeoJSON object
* *
* Returns: * Return:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
parseGeometry: function(obj) { parseGeometry: function(obj) {
@@ -248,7 +248,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment. * array - {Object} The coordinates array from the GeoJSON fragment.
* *
* Returns: * Return:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
"point": function(array) { "point": function(array) {
@@ -266,7 +266,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* array {Object} The coordinates array from the GeoJSON fragment. * array {Object} The coordinates array from the GeoJSON fragment.
* *
* Returns: * Return:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
"multipoint": function(array) { "multipoint": function(array) {
@@ -291,7 +291,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment. * array - {Object} The coordinates array from the GeoJSON fragment.
* *
* Returns: * Return:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
"linestring": function(array) { "linestring": function(array) {
@@ -316,7 +316,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment. * array - {Object} The coordinates array from the GeoJSON fragment.
* *
* Returns: * Return:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
"multilinestring": function(array) { "multilinestring": function(array) {
@@ -338,10 +338,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Convert a coordinate array from GeoJSON into an * Convert a coordinate array from GeoJSON into an
* <OpenLayers.Geometry>. * <OpenLayers.Geometry>.
* *
* Returns: * Return:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
"polygon": function(array) { "polygon": function(array) {
@@ -367,7 +364,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment. * array - {Object} The coordinates array from the GeoJSON fragment.
* *
* Returns: * Return:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
"multipolygon": function(array) { "multipolygon": function(array) {
@@ -392,7 +389,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment. * array - {Object} The coordinates array from the GeoJSON fragment.
* *
* Returns: * Return:
* {<OpenLayers.Geometry>} A geometry. * {<OpenLayers.Geometry>} A geometry.
*/ */
"box": function(array) { "box": function(array) {
@@ -423,7 +420,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* pretty - {Boolean} Structure the output with newlines and indentation. * pretty - {Boolean} Structure the output with newlines and indentation.
* Default is false. * Default is false.
* *
* Returns: * Return:
* {String} The GeoJSON string representation of the input geometry, * {String} The GeoJSON string representation of the input geometry,
* features, array of geometries, or array of features. * features, array of geometries, or array of features.
*/ */
@@ -497,7 +494,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* feature - {<OpenLayers.Feature.Vector>} * feature - {<OpenLayers.Feature.Vector>}
* *
* Returns: * Return:
* {Object} An object representing the point. * {Object} An object representing the point.
*/ */
'feature': function(feature) { 'feature': function(feature) {
@@ -517,7 +514,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* geometry - {<OpenLayers.Geometry>} * geometry - {<OpenLayers.Geometry>}
* *
* Returns: * Return:
* {Object} An object representing the geometry. * {Object} An object representing the geometry.
*/ */
'geometry': function(geometry) { 'geometry': function(geometry) {
@@ -536,7 +533,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* point - {<OpenLayers.Geometry.Point>} * point - {<OpenLayers.Geometry.Point>}
* *
* Returns: * Return:
* {Array} An array of coordinates representing the point. * {Array} An array of coordinates representing the point.
*/ */
'point': function(point) { 'point': function(point) {
@@ -550,7 +547,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* multipoint - {<OpenLayers.Geometry.MultiPoint>} * multipoint - {<OpenLayers.Geometry.MultiPoint>}
* *
* Returns: * Return:
* {Array} An array of point coordinate arrays representing * {Array} An array of point coordinate arrays representing
* the multipoint. * the multipoint.
*/ */
@@ -569,7 +566,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* linestring - {<OpenLayers.Geometry.LineString>} * linestring - {<OpenLayers.Geometry.LineString>}
* *
* Returns: * Return:
* {Array} An array of coordinate arrays representing * {Array} An array of coordinate arrays representing
* the linestring. * the linestring.
*/ */
@@ -588,7 +585,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* linestring - {<OpenLayers.Geometry.MultiLineString>} * linestring - {<OpenLayers.Geometry.MultiLineString>}
* *
* Returns: * Return:
* {Array} An array of linestring arrays representing * {Array} An array of linestring arrays representing
* the multilinestring. * the multilinestring.
*/ */
@@ -607,7 +604,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* polygon - {<OpenLayers.Geometry.Polygon>} * polygon - {<OpenLayers.Geometry.Polygon>}
* *
* Returns: * Return:
* {Array} An array of linear ring arrays representing the polygon. * {Array} An array of linear ring arrays representing the polygon.
*/ */
'polygon': function(polygon) { 'polygon': function(polygon) {
@@ -625,7 +622,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters: * Parameters:
* multipolygon - {<OpenLayers.Geometry.MultiPolygon>} * multipolygon - {<OpenLayers.Geometry.MultiPolygon>}
* *
* Returns: * Return:
* {Array} An array of polygon arrays representing * {Array} An array of polygon arrays representing
* the multipolygon * the multipolygon
*/ */
+1 -1
View File
@@ -67,7 +67,7 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* feature - {<OpenLayers.Feature.Vector>} * feature - {<OpenLayers.Feature.Vector>}
* *
* Returns: * Return:
* {DOMElement} * {DOMElement}
*/ */
createFeatureXML: function(feature) { createFeatureXML: function(feature) {
+11 -11
View File
@@ -80,7 +80,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* reform generic objects into instances of classes, or to transform * reform generic objects into instances of classes, or to transform
* date strings into Date objects. * date strings into Date objects.
* *
* Returns: * Return:
* {Object} An object, array, string, or number . * {Object} An object, array, string, or number .
*/ */
read: function(json, filter) { read: function(json, filter) {
@@ -141,7 +141,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* pretty - {Boolean} Structure the output with newlines and indentation. * pretty - {Boolean} Structure the output with newlines and indentation.
* Default is false. * Default is false.
* *
* Returns: * Return:
* {String} The JSON string representation of the input value. * {String} The JSON string representation of the input value.
*/ */
write: function(value, pretty) { write: function(value, pretty) {
@@ -158,7 +158,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeIndent * Method: writeIndent
* Output an indentation string depending on the indentation level. * Output an indentation string depending on the indentation level.
* *
* Returns: * Return:
* {String} An appropriate indentation string. * {String} An appropriate indentation string.
*/ */
writeIndent: function() { writeIndent: function() {
@@ -175,7 +175,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeNewline * Method: writeNewline
* Output a string representing a newline if in pretty printing mode. * Output a string representing a newline if in pretty printing mode.
* *
* Returns: * Return:
* {String} A string representing a new line. * {String} A string representing a new line.
*/ */
writeNewline: function() { writeNewline: function() {
@@ -186,7 +186,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeSpace * Method: writeSpace
* Output a string representing a space if in pretty printing mode. * Output a string representing a space if in pretty printing mode.
* *
* Returns: * Return:
* {String} A space. * {String} A space.
*/ */
writeSpace: function() { writeSpace: function() {
@@ -206,7 +206,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* object - {Object} The object to be serialized. * object - {Object} The object to be serialized.
* *
* Returns: * Return:
* {String} A JSON string representing the object. * {String} A JSON string representing the object.
*/ */
'object': function(object) { 'object': function(object) {
@@ -255,7 +255,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* array - {Array} The array to be serialized * array - {Array} The array to be serialized
* *
* Returns: * Return:
* {String} A JSON string representing the array. * {String} A JSON string representing the array.
*/ */
'array': function(array) { 'array': function(array) {
@@ -287,7 +287,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters * Parameters
* string - {String} The string to be serialized * string - {String} The string to be serialized
* *
* Returns: * Return:
* {String} A JSON string representing the string. * {String} A JSON string representing the string.
*/ */
'string': function(string) { 'string': function(string) {
@@ -326,7 +326,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* number - {Number} The number to be serialized. * number - {Number} The number to be serialized.
* *
* Returns: * Return:
* {String} A JSON string representing the number. * {String} A JSON string representing the number.
*/ */
'number': function(number) { 'number': function(number) {
@@ -340,7 +340,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* bool - {Boolean} The boolean to be serialized. * bool - {Boolean} The boolean to be serialized.
* *
* Returns: * Return:
* {String} A JSON string representing the boolean. * {String} A JSON string representing the boolean.
*/ */
'boolean': function(bool) { 'boolean': function(bool) {
@@ -354,7 +354,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* date - {Date} The date to be serialized. * date - {Date} The date to be serialized.
* *
* Returns: * Return:
* {String} A JSON string representing the date. * {String} A JSON string representing the date.
*/ */
'date': function(date) { 'date': function(date) {
+1 -1
View File
@@ -148,7 +148,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format, {
* Parameters: * Parameters:
* xmlNode - {<XMLNode>} * xmlNode - {<XMLNode>}
* *
* Returns: * Return:
* An array of <OpenLayers.Geometry.Point> points. * An array of <OpenLayers.Geometry.Point> points.
*/ */
parseCoords: function(xmlNode) { parseCoords: function(xmlNode) {
+8 -8
View File
@@ -53,7 +53,7 @@ OpenLayers.Format.XML.prototype =
* Parameters: * Parameters:
* text - {String} A XML string * text - {String} A XML string
* Returns: * Return:
* {DOMElement} A DOM node * {DOMElement} A DOM node
*/ */
read: function(text) { read: function(text) {
@@ -101,7 +101,7 @@ OpenLayers.Format.XML.prototype =
* Parameters: * Parameters:
* node - {DOMElement} A DOM node. * node - {DOMElement} A DOM node.
* *
* Returns: * Return:
* {String} The XML string representation of the input node. * {String} The XML string representation of the input node.
*/ */
write: function(node) { write: function(node) {
@@ -126,7 +126,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI for the element. * uri - {String} Namespace URI for the element.
* name - {String} The qualified name of the element (prefix:localname). * name - {String} The qualified name of the element (prefix:localname).
* *
* Returns: * Return:
* {Element} A DOM element with namespace. * {Element} A DOM element with namespace.
*/ */
createElementNS: function(uri, name) { createElementNS: function(uri, name) {
@@ -148,7 +148,7 @@ OpenLayers.Format.XML.prototype =
* Parameters: * Parameters:
* text - {String} The text of the node. * text - {String} The text of the node.
* *
* Returns: * Return:
* {DOMElement} A DOM text node. * {DOMElement} A DOM text node.
*/ */
createTextNode: function(text) { createTextNode: function(text) {
@@ -173,7 +173,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI. * uri - {String} Namespace URI.
* name - {String} Local name of the tag (without the prefix). * name - {String} Local name of the tag (without the prefix).
* *
* Returns: * Return:
* {NodeList} A node list or array of elements. * {NodeList} A node list or array of elements.
*/ */
getElementsByTagNameNS: function(node, uri, name) { getElementsByTagNameNS: function(node, uri, name) {
@@ -207,7 +207,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI. * uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix). * name - {String} Local name of the attribute (without the prefix).
* *
* Returns: * Return:
* {DOMElement} An attribute node or null if none found. * {DOMElement} An attribute node or null if none found.
*/ */
getAttributeNodeNS: function(node, uri, name) { getAttributeNodeNS: function(node, uri, name) {
@@ -241,7 +241,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI. * uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix). * name - {String} Local name of the attribute (without the prefix).
* *
* Returns: * Return:
* {String} An attribute value or and empty string if none found. * {String} An attribute value or and empty string if none found.
*/ */
getAttributeNS: function(node, uri, name) { getAttributeNS: function(node, uri, name) {
@@ -267,7 +267,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI. * uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix). * name - {String} Local name of the attribute (without the prefix).
* *
* Returns: * Return:
* {Boolean} The node has an attribute matching the name and namespace. * {Boolean} The node has an attribute matching the name and namespace.
*/ */
hasAttributeNS: function(node, uri, name) { hasAttributeNS: function(node, uri, name) {
+1 -1
View File
@@ -124,7 +124,7 @@ OpenLayers.Handler = OpenLayers.Class({
* returns true. If a <keyMask> is set and it matches the combination * returns true. If a <keyMask> is set and it matches the combination
* of keys down on an event, this returns true. * of keys down on an event, this returns true.
* *
* Returns: * Return:
* {Boolean} The keyMask matches the keys down on an event. * {Boolean} The keyMask matches the keys down on an event.
*/ */
checkModifiers: function (evt) { checkModifiers: function (evt) {
+4 -3
View File
@@ -82,8 +82,8 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
/** /**
* Method: dblclick * Method: dblclick
* Capture double-clicks. Let the event continue propagating if the * Capture double-clicks. Let the event continue propagating if the
* double-click doesn't hit a feature. Otherwise call the dblclick * double-click doesn't hit a feature. Otherwise call the dblclick
* callback. * callback.
* *
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
@@ -149,7 +149,8 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
* Method: activate * Method: activate
* Turn of the handler. Returns false if the handler was already active. * Turn of the handler. Returns false if the handler was already active.
* *
* Returns: {Boolean} * Return:
* {Boolean}
*/ */
deactivate: function() { deactivate: function() {
if(OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) { if(OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) {
+27 -27
View File
@@ -54,13 +54,13 @@ OpenLayers.Icon = OpenLayers.Class({
px: null, px: null,
/** /**
* Constructor: OpenLayers.Icon * Constructor: OpenLayers.Icon
* Creates an icon, which is an image tag in a div. * Creates an icon, which is an image tag in a div.
* *
* url - {String} * url - {String}
* size - {<OpenLayers.Size>} * size - {<OpenLayers.Size>}
* calculateOffset - {Function} * calculateOffset - {Function}
*/ */
initialize: function(url, size, offset, calculateOffset) { initialize: function(url, size, offset, calculateOffset) {
this.url = url; this.url = url;
this.size = (size) ? size : new OpenLayers.Size(20,20); this.size = (size) ? size : new OpenLayers.Size(20,20);
@@ -83,11 +83,11 @@ OpenLayers.Icon = OpenLayers.Class({
}, },
/** /**
* Method: clone * Method: clone
* *
* Returns: * Return:
* {<OpenLayers.Icon>} A fresh copy of the icon. * {<OpenLayers.Icon>} A fresh copy of the icon.
*/ */
clone: function() { clone: function() {
return new OpenLayers.Icon(this.url, return new OpenLayers.Icon(this.url,
this.size, this.size,
@@ -108,15 +108,15 @@ OpenLayers.Icon = OpenLayers.Class({
}, },
/** /**
* Method: draw * Method: draw
* Move the div to the given pixel. * Move the div to the given pixel.
* *
* Parameters: * Parameters:
* px - {<OpenLayers.Pixel>} * px - {<OpenLayers.Pixel>}
* *
* Returns: * Return:
* {DOMElement} A new DOM Image of this icon set at the location passed-in * {DOMElement} A new DOM Image of this icon set at the location passed-in
*/ */
draw: function(px) { draw: function(px) {
OpenLayers.Util.modifyAlphaImageDiv(this.imageDiv, OpenLayers.Util.modifyAlphaImageDiv(this.imageDiv,
null, null,
@@ -143,12 +143,12 @@ OpenLayers.Icon = OpenLayers.Class({
}, },
/** /**
* Method: moveTo * Method: moveTo
* move icon to passed in px. * move icon to passed in px.
* *
* Parameters: * Parameters:
* px - {<OpenLayers.Pixel>} * px - {<OpenLayers.Pixel>}
*/ */
moveTo: function (px) { moveTo: function (px) {
//if no px passed in, use stored location //if no px passed in, use stored location
if (px != null) { if (px != null) {
+1 -1
View File
@@ -744,7 +744,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Calculates the max extent which includes all of the data for the layer. * Calculates the max extent which includes all of the data for the layer.
* This function is to be implemented by subclasses. * This function is to be implemented by subclasses.
* *
* Returns: * Return:
* {<OpenLayers.Bounds>} * {<OpenLayers.Bounds>}
*/ */
getDataExtent: function () { getDataExtent: function () {
+1 -1
View File
@@ -144,7 +144,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, {
* APIMethod: getDataExtent * APIMethod: getDataExtent
* Calculates the max extent which includes all of the markers. * Calculates the max extent which includes all of the markers.
* *
* Returns: * Return:
* {<OpenLayers.Bounds>} * {<OpenLayers.Bounds>}
*/ */
getDataExtent: function () { getDataExtent: function () {
+32 -31
View File
@@ -20,38 +20,39 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* APIProperty: reproject * APIProperty: reproject
* {Boolean} Try to reproject this layer if it is used as an overlay. * {Boolean} Try to reproject this layer if it is used as an overlay.
* Default is false. * Default is false.
**/ */
reproject: false, reproject: false,
/** /**
* APIProperty: isBaseLayer * APIProperty: isBaseLayer
* {Boolean} Treat this layer as a base layer. Default is true. * {Boolean} Treat this layer as a base layer. Default is true.
**/ */
isBaseLayer: true, isBaseLayer: true,
/** /**
* APIProperty: tileOrigin * APIProperty: tileOrigin
* {<OpenLayers.LonLat>} Location of the tile lattice origin. Default is * {<OpenLayers.LonLat>} Location of the tile lattice origin. Default is
* bottom left of the maxExtent. * bottom left of the maxExtent.
**/ */
tileOrigin: null, tileOrigin: null,
/** /**
* APIProperty: format * APIProperty: format
* {String} Mime type of the images returned. Default is image/png. * {String} Mime type of the images returned. Default is image/png.
**/ */
format: 'image/png', format: 'image/png',
/** /**
* Constructor: OpenLayers.Layer.TileCache * Constructor: OpenLayers.Layer.TileCache
* Create a new read only TileCache layer. * Create a new read only TileCache layer.
* *
* Parameters: * Parameters:
* name - {String} Name of the layer displayed in the interface * name - {String} Name of the layer displayed in the interface
* url - {String} Location of the web accessible cache * url - {String} Location of the web accessible cache
* layername - {String} Layer name as defined in the TileCache configuration * layername - {String} Layer name as defined in the TileCache
* options - {Object} Hashtable of extra options to tag onto the layer * configuration
*/ * options - {Object} Hashtable of extra options to tag onto the layer
*/
initialize: function(name, url, layername, options) { initialize: function(name, url, layername, options) {
options = OpenLayers.Util.extend({maxResolution: 180/256}, options); options = OpenLayers.Util.extend({maxResolution: 180/256}, options);
this.layername = layername; this.layername = layername;
@@ -65,8 +66,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* APIMethod: clone * APIMethod: clone
* obj - {Object} * obj - {Object}
* *
* Returns: * Return:
* An exact clone of this <OpenLayers.Layer.TileCache> * {<OpenLayers.Layer.TileCache>} An exact clone of this
* <OpenLayers.Layer.TileCache>
*/ */
clone: function (obj) { clone: function (obj) {
@@ -90,10 +92,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters: * Parameters:
* bounds - {<OpenLayers.Bounds>} * bounds - {<OpenLayers.Bounds>}
* *
* Returns: * Return:
* A string with the layer's url and parameters and also the * {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as * passed-in bounds and appropriate tile size specified as parameters.
* parameters
*/ */
getURL: function(bounds) { getURL: function(bounds) {
var res = this.map.getResolution(); var res = this.map.getResolution();
@@ -106,9 +107,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Zero-pad a positive integer. * Zero-pad a positive integer.
* number - {Int} * number - {Int}
* length - {Int} * length - {Int}
*
* Returns: * Return:
* A zero-padded string * {String} A zero-padded string
*/ */
function zeroPad(number, length) { function zeroPad(number, length) {
number = String(number); number = String(number);
@@ -138,15 +139,15 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
}, },
/** /**
* Method: addTile * Method: addTile
* Create a tile, initialize it, and add it to the layer div. * Create a tile, initialize it, and add it to the layer div.
* *
* Parameters: * Parameters:
* bounds - {<OpenLayers.Bounds>} * bounds - {<OpenLayers.Bounds>}
* *
* Returns: * Return:
* The added {<OpenLayers.Tile.Image>} * {<OpenLayers.Tile.Image>} The added <OpenLayers.Tile.Image>
*/ */
addTile:function(bounds, position) { addTile:function(bounds, position) {
var url = this.getURL(bounds); var url = this.getURL(bounds);
return new OpenLayers.Tile.Image(this, position, bounds, return new OpenLayers.Tile.Image(this, position, bounds,
+2 -2
View File
@@ -357,7 +357,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
* Parameters: * Parameters:
* evt - {Event} * evt - {Event}
* *
* Returns: * Return:
* {<OpenLayers.Feature.Vector>} A feature if one was under the event. * {<OpenLayers.Feature.Vector>} A feature if one was under the event.
*/ */
getFeatureFromEvent: function(evt) { getFeatureFromEvent: function(evt) {
@@ -372,7 +372,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
* Parameters: * Parameters:
* featureId - {String} * featureId - {String}
* *
* Returns: * Return:
* {<OpenLayers.Feature.Vector>} A feature corresponding to the given * {<OpenLayers.Feature.Vector>} A feature corresponding to the given
* featureId * featureId
*/ */
+16 -16
View File
@@ -25,7 +25,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/** /**
* APIProperty: ratio * APIProperty: ratio
* {Float} the ratio of image/tile size to map size (this is the untiled * {Float} the ratio of image/tile size to map size (this is the untiled
* buffer) * buffer)
*/ */
ratio: 2, ratio: 2,
@@ -41,8 +41,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/** /**
* APIProperty: featureClass * APIProperty: featureClass
* {<OpenLayers.Feature>} If featureClass is defined, an old-style markers * {<OpenLayers.Feature>} If featureClass is defined, an old-style markers
* based WFS layer is created instead of a new-style vector layer. If * based WFS layer is created instead of a new-style vector layer. If
* sent, this should be a subclass of OpenLayers.Feature * sent, this should be a subclass of OpenLayers.Feature
*/ */
featureClass: null, featureClass: null,
@@ -55,19 +55,19 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/** /**
* APIProperty: encodeBBOX * APIProperty: encodeBBOX
* {Boolean} Should the BBOX commas be encoded? The WMS spec says 'no', * {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, encodeBBOX: false,
/** /**
* Constructor: OpenLayers.Layer.WFS * Constructor: OpenLayers.Layer.WFS
* *
* Parameters: * Parameters:
* name - {String} * name - {String}
* url - {String} * url - {String}
* params - {Object} * params - {Object}
* options - {Object} Hashtable of extra options to tag onto the layer * options - {Object} Hashtable of extra options to tag onto the layer
*/ */
initialize: function(name, url, params, options) { initialize: function(name, url, params, options) {
if (options == undefined) { options = {}; } if (options == undefined) { options = {}; }
@@ -277,8 +277,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
* Parameters: * Parameters:
* obj - {Object} * obj - {Object}
* *
* Returns: * Return:
* {<OpenLayers.Layer.WFS>} LAn exact clone of this OpenLayers.Layer.WFS * {<OpenLayers.Layer.WFS>} An exact clone of this OpenLayers.Layer.WFS
*/ */
clone: function (obj) { clone: function (obj) {
@@ -387,8 +387,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/** /**
* APIMethod: commitReport * APIMethod: commitReport
* Called with a 'success' message if the commit succeeded, otherwise * Called with a 'success' message if the commit succeeded, otherwise
* a failure message, and the full request text as a second parameter. * a failure message, and the full request text as a second parameter.
* Override this function to provide custom transaction reporting. * Override this function to provide custom transaction reporting.
* *
* string - {String} reporting string * string - {String} reporting string
* response - {String} full XML response * response - {String} full XML response
+1 -1
View File
@@ -85,7 +85,7 @@ OpenLayers.Layer.WorldWind = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters: * Parameters:
* bounds - {<OpenLayers.Bounds>} * bounds - {<OpenLayers.Bounds>}
* *
* Returns: * Return:
* {String} A string with the layer's url and parameters and also the * {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as * passed-in bounds and appropriate tile size specified as
* parameters * parameters
+1 -1
View File
@@ -189,7 +189,7 @@ OpenLayers.Marker = OpenLayers.Class({
* Function: defaultIcon * Function: defaultIcon
* Creates a default <OpenLayers.Icon>. * Creates a default <OpenLayers.Icon>.
* *
* Returns: * Return:
* {<OpenLayers.Icon>} A default OpenLayers.Icon to use for a marker * {<OpenLayers.Icon>} A default OpenLayers.Icon to use for a marker
*/ */
OpenLayers.Marker.defaultIcon = function() { OpenLayers.Marker.defaultIcon = function() {
+1 -1
View File
@@ -246,7 +246,7 @@ OpenLayers.Popup = OpenLayers.Class({
/** /**
* Method: visible * Method: visible
* *
* Returns: * Return:
* {Boolean} Boolean indicating whether or not the popup is visible * {Boolean} Boolean indicating whether or not the popup is visible
*/ */
visible: function() { visible: function() {
+3 -3
View File
@@ -76,7 +76,7 @@ OpenLayers.Renderer = OpenLayers.Class({
* APIMethod: supported * APIMethod: supported
* This should be overridden by specific subclasses * This should be overridden by specific subclasses
* *
* Returns: * Return:
* {Boolean} Whether or not the browser supports the renderer class * {Boolean} Whether or not the browser supports the renderer class
*/ */
supported: function() { supported: function() {
@@ -119,7 +119,7 @@ OpenLayers.Renderer = OpenLayers.Class({
* Method: getResolution * Method: getResolution
* Uses cached copy of resolution if available to minimize computing * Uses cached copy of resolution if available to minimize computing
* *
* Returns: * Return:
* The current map's resolution * The current map's resolution
*/ */
getResolution: function() { getResolution: function() {
@@ -176,7 +176,7 @@ OpenLayers.Renderer = OpenLayers.Class({
* Parameters: * Parameters:
* evt - {<OpenLayers.Event>} * evt - {<OpenLayers.Event>}
* *
* Returns: * Return:
* {String} A feature id or null. * {String} A feature id or null.
*/ */
getFeatureIdFromEvent: function(evt) {}, getFeatureIdFromEvent: function(evt) {},