ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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.

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/OpenLayers/Control/DragFeature.js
View File

@@ -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() {

4
lib/OpenLayers/Control/LayerSwitcher.js
View File

@@ -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() {

53
lib/OpenLayers/Control/MouseDefaults.js
View File

@@ -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 - {<OpenLayers.Event>}
*/
* Method: defaultMouseUp
*
* Parameters:
* evt - {<OpenLayers.Event>}
*/
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"
});

20
lib/OpenLayers/Control/PanZoom.js
View File

@@ -55,14 +55,14 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
},
/**
* Method: draw
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Returns:
* {DOMElement} A reference to the container div for the PanZoom control
*/
* Method: draw
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* 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 - {<OpenLayers.Pixel>}
* sz - {<OpenLayers.Size>}
*
* 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);

2
lib/OpenLayers/Control/Panel.js
View File

@@ -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);

2
lib/OpenLayers/Control/Permalink.js
View File

@@ -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);

2
lib/OpenLayers/Control/Scale.js
View File

@@ -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);

4
lib/OpenLayers/Feature.js
View File

@@ -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:
* {<OpenLayers.Popup.AnchoredBubble>}
*
*/

26
lib/OpenLayers/Feature/Vector.js
View File

@@ -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:
* {<OpenLayers.Feature.Vector>} An exact clone of this vector feature.
*/
/**
* Method: clone
* Create a clone of this vector feature. Does not set any non-standard
* properties.
*
* Return:
* {<OpenLayers.Feature.Vector>} 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",

8
lib/OpenLayers/Format/GML.js
View File

@@ -264,7 +264,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {XMLNode}
*
* Returns:
* Return:
* {<OpenLayers.Geometry.Polygon>} polygon geometry
*/
parsePolygonNode: function(polygonNode) {
@@ -291,7 +291,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {<XMLNode>}
*
* Returns:
* Return:
* An array of <OpenLayers.Geometry.Point> points.
*/
parseCoords: function(xmlNode) {
@@ -365,7 +365,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* feature - {<OpenLayers.Feature.Vector>}
*
* Returns:
* Return:
* {DOMElement}
*/
createFeatureXML: function(feature) {
@@ -475,7 +475,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Returns:
* Return:
* {XmlNode} created xmlNode
*/
buildCoordinatesNode: function(geometry) {

43
lib/OpenLayers/Format/GeoJSON.js
View File

@@ -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 <OpenLayers.Feature.Vector>. 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:
* {<OpenLayers.Feature.Vector>} 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:
* {<OpenLayers.Geometry>} 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:
* {<OpenLayers.Geometry>} 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:
* {<OpenLayers.Geometry>} 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:
* {<OpenLayers.Geometry>} 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:
* {<OpenLayers.Geometry>} 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
* <OpenLayers.Geometry>.
*
* Returns:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* Return:
* {<OpenLayers.Geometry>} 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:
* {<OpenLayers.Geometry>} 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:
* {<OpenLayers.Geometry>} 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 - {<OpenLayers.Feature.Vector>}
*
* 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 - {<OpenLayers.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 - {<OpenLayers.Geometry.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 - {<OpenLayers.Geometry.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 - {<OpenLayers.Geometry.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 - {<OpenLayers.Geometry.MultiLineString>}
*
* 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 - {<OpenLayers.Geometry.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 - {<OpenLayers.Geometry.MultiPolygon>}
*
* Returns:
* Return:
* {Array} An array of polygon arrays representing
* the multipolygon
*/

2
lib/OpenLayers/Format/GeoRSS.js
View File

@@ -67,7 +67,7 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* feature - {<OpenLayers.Feature.Vector>}
*
* Returns:
* Return:
* {DOMElement}
*/
createFeatureXML: function(feature) {

22
lib/OpenLayers/Format/JSON.js
View File

@@ -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) {

2
lib/OpenLayers/Format/KML.js
View File

@@ -148,7 +148,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {<XMLNode>}
*
* Returns:
* Return:
* An array of <OpenLayers.Geometry.Point> points.
*/
parseCoords: function(xmlNode) {

16
lib/OpenLayers/Format/XML.js
View File

@@ -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) {

2
lib/OpenLayers/Handler.js
View File

@@ -124,7 +124,7 @@ OpenLayers.Handler = OpenLayers.Class({
* returns true. If a <keyMask> 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) {

7
lib/OpenLayers/Handler/Feature.js
View File

@@ -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)) {

54
lib/OpenLayers/Icon.js
View File

@@ -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 - {<OpenLayers.Size>}
* calculateOffset - {Function}
*/
* Constructor: OpenLayers.Icon
* Creates an icon, which is an image tag in a div.
*
* url - {String}
* size - {<OpenLayers.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:
* {<OpenLayers.Icon>} A fresh copy of the icon.
*/
* Method: clone
*
* Return:
* {<OpenLayers.Icon>} 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 - {<OpenLayers.Pixel>}
*
* 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 - {<OpenLayers.Pixel>}
*
* 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 - {<OpenLayers.Pixel>}
*/
* Method: moveTo
* move icon to passed in px.
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*/
moveTo: function (px) {
//if no px passed in, use stored location
if (px != null) {

2
lib/OpenLayers/Layer.js
View File

@@ -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:
* {<OpenLayers.Bounds>}
*/
getDataExtent: function () {

2
lib/OpenLayers/Layer/Markers.js
View File

@@ -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:
* {<OpenLayers.Bounds>}
*/
getDataExtent: function () {

63
lib/OpenLayers/Layer/TileCache.js
View File

@@ -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
* {<OpenLayers.LonLat>} 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 <OpenLayers.Layer.TileCache>
* Return:
* {<OpenLayers.Layer.TileCache>} An exact clone of this
* <OpenLayers.Layer.TileCache>
*/
clone: function (obj) {
@@ -90,10 +92,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.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 - {<OpenLayers.Bounds>}
*
* Returns:
* The added {<OpenLayers.Tile.Image>}
*/
* Method: addTile
* Create a tile, initialize it, and add it to the layer div.
*
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* {<OpenLayers.Tile.Image>} The added <OpenLayers.Tile.Image>
*/
addTile:function(bounds, position) {
var url = this.getURL(bounds);
return new OpenLayers.Tile.Image(this, position, bounds,

4
lib/OpenLayers/Layer/Vector.js
View File

@@ -357,7 +357,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* evt - {Event}
*
* Returns:
* Return:
* {<OpenLayers.Feature.Vector>} 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:
* {<OpenLayers.Feature.Vector>} A feature corresponding to the given
* featureId
*/

32
lib/OpenLayers/Layer/WFS.js
View File

@@ -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
* {<OpenLayers.Feature>} 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:
* {<OpenLayers.Layer.WFS>} LAn exact clone of this OpenLayers.Layer.WFS
* Return:
* {<OpenLayers.Layer.WFS>} 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

2
lib/OpenLayers/Layer/WorldWind.js
View File

@@ -85,7 +85,7 @@ OpenLayers.Layer.WorldWind = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.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

2
lib/OpenLayers/Marker.js
View File

@@ -189,7 +189,7 @@ OpenLayers.Marker = OpenLayers.Class({
* Function: defaultIcon
* Creates a default <OpenLayers.Icon>.
*
* Returns:
* Return:
* {<OpenLayers.Icon>} A default OpenLayers.Icon to use for a marker
*/
OpenLayers.Marker.defaultIcon = function() {

2
lib/OpenLayers/Popup.js
View File

@@ -246,7 +246,7 @@ OpenLayers.Popup = OpenLayers.Class({
/**
* Method: visible
*
* Returns:
* Return:
* {Boolean} Boolean indicating whether or not the popup is visible
*/
visible: function() {

6
lib/OpenLayers/Renderer.js
View File

@@ -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 - {<OpenLayers.Event>}
*
* Returns:
* Return:
* {String} A feature id or null.
*/
getFeatureIdFromEvent: function(evt) {},