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

Filling our log with cruft, adding meaningless conflicts for merges, and changing a comment style that ndocs could care less about, this commit changes Return to Returns (closes #945).

Browse Source 
git-svn-id: http://svn.openlayers.org/trunk/openlayers@4110 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Tim Schaub
2007-08-29 18:44:10 +00:00
parent b5ef77096c
commit c2148651ed
78 changed files with 397 additions and 388 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lib/OpenLayers.js
View File

@@ -31,7 +31,7 @@
* Function: _getScriptLocation
* Return the path to this script.
*
* Return:
* Returns:
* Path to this script
*/
_getScriptLocation: function () {

18
lib/OpenLayers/Ajax.js
View File

@@ -80,7 +80,7 @@ OpenLayers.loadURL = function(uri, params, caller,
* Parameters:
* text - {String}
*
* Return:
* Returns:
* {?} Parsed AJAX Responsev
*/
OpenLayers.parseXMLString = function(text) {
@@ -129,7 +129,7 @@ OpenLayers.Ajax = {
/**
* Method: getTransport
*
* Return:
* Returns:
* {Object} Transport mechanism for whichever browser we're in, or false if
* none available.
*/
@@ -239,7 +239,7 @@ OpenLayers.Ajax.Base.prototype = {
/**
* Function: responseIsSuccess
*
* Return:
* Returns:
* {Boolean}
*/
responseIsSuccess: function() {
@@ -251,7 +251,7 @@ OpenLayers.Ajax.Base.prototype = {
/**
* Function: responseIsFailure
*
* Return:
* Returns:
* {Boolean}
*/
responseIsFailure: function() {
@@ -379,7 +379,7 @@ OpenLayers.Ajax.Request = OpenLayers.Class(OpenLayers.Ajax.Base, {
/**
* Method: header
*
* Return:
* Returns:
* {?}
*/
header: function(name) {
@@ -391,7 +391,7 @@ OpenLayers.Ajax.Request = OpenLayers.Class(OpenLayers.Ajax.Base, {
/**
* Method: evalJSON
*
* Return:
* Returns:
* {?}
*/
evalJSON: function() {
@@ -403,7 +403,7 @@ OpenLayers.Ajax.Request = OpenLayers.Class(OpenLayers.Ajax.Base, {
/**
* Method: evalResponse
*
* Return:
* Returns:
* {?}
*/
evalResponse: function() {
@@ -495,7 +495,7 @@ OpenLayers.Ajax.Request.Events =
* nsprefix - {?}
* tagname - {?}
*
* Return:
* Returns:
* {?}
*/
OpenLayers.Ajax.getElementsByTagNameNS = function(parentnode, nsuri,
@@ -519,7 +519,7 @@ OpenLayers.Ajax.getElementsByTagNameNS = function(parentnode, nsuri,
* Parameters:
* xmldom {XMLNode} xml dom to serialize
*
* Return:
* Returns:
* {?}
*/
OpenLayers.Ajax.serializeXMLToString = function(xmldom) {

16
lib/OpenLayers/BaseTypes.js
View File

@@ -21,7 +21,7 @@
* Parameters:
* sStart - {Sring} The string we're testing for.
*
* Return:
* Returns:
* {Boolean} Whether or not this string starts with the string passed in.
*/
String.prototype.startsWith = function(sStart) {
@@ -35,7 +35,7 @@ String.prototype.startsWith = function(sStart) {
* Parameters:
* str - {String} The string that we're testing for.
*
* Return:
* Returns:
* {Boolean} Whether or not this string contains with the string passed in.
*/
String.prototype.contains = function(str) {
@@ -46,7 +46,7 @@ String.prototype.contains = function(str) {
* APIMethod: String.trim
* Removes leading and trailing whitespace characters from a string.
*
* Return:
* Returns:
* {String} A trimmed version of the string - all leading and
* trailing spaces removed
*/
@@ -72,7 +72,7 @@ String.prototype.trim = function() {
* Parameters:
* object - {Object} Can be a string or a number
*
* Return:
* Returns:
* {Integer} The index of the encountered object, or -1 if not found.
*/
String.indexOf = function(object) {
@@ -92,7 +92,7 @@ String.indexOf = function(object) {
* Ex. "chicken-head" becomes "chickenHead", and
* "-chicken-head" becomes "ChickenHead".
*
* Return:
* Returns:
* {String} The string, camelized
*/
String.prototype.camelize = function() {
@@ -120,7 +120,7 @@ String.prototype.camelize = function() {
* Parameters:
* sig - {Integer}
*
* Return:
* Returns:
* {Integer} The number, rounded to the specified number of significant digits.
* If null, 0, or negative value passed in, returns 0
*/
@@ -153,7 +153,7 @@ Number.prototype.limitSigDigs = function(sig) {
* Parameters:
* object - {Object} the this parameter
*
* Return:
* Returns:
* {Function} A closure with 'this' altered to the first
* argument.
*/
@@ -187,7 +187,7 @@ Function.prototype.bind = function() {
* Parameters:
* object - {Object} A reference to this.
*
* Return:
* Returns:
* {Function}
*/
Function.prototype.bindAsEventListener = function(object) {

44
lib/OpenLayers/BaseTypes/Bounds.js
View File

@@ -71,7 +71,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* Method: clone
* Create a cloned instance of this bounds.
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A fresh copy of the bounds
*/
clone:function() {
@@ -86,7 +86,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {Boolean} The passed-in OpenLayers.Bounds object has the same left,
* right, top, bottom components as this. Note that if bounds
* passed in is null, returns false.
@@ -105,7 +105,7 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* APIMethod: toString
*
* Return:
* Returns:
* {String} String representation of OpenLayers.Bounds object.
* (ex.<i>"left-bottom=(5,42) right-top=(10,45)"</i>)
*/
@@ -117,7 +117,7 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* APIMethod: toArray
*
* Return:
* Returns:
* {Array} array of left, bottom, right, top
*/
toArray: function() {
@@ -131,7 +131,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* decimal - {Integer} How many significant digits in the bbox coords?
* Default is 6
*
* Return:
* Returns:
* {String} Simple String representation of OpenLayers.Bounds object.
* (ex. <i>"5,42,10,45"</i>)
*/
@@ -151,7 +151,7 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* APIMethod: getWidth
*
* Return:
* Returns:
* {Float} The width of the bounds
*/
getWidth:function() {
@@ -161,7 +161,7 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* APIMethod: getHeight
*
* Return:
* Returns:
* {Float} The height of the bounds
*/
getHeight:function() {
@@ -171,7 +171,7 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* APIMethod: getSize
*
* Return:
* Returns:
* {<OpenLayers.Size>} An <OpenLayers.Size> which represents the size of the box
*/
getSize:function() {
@@ -181,7 +181,7 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* APIMethod: getCenterPixel
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} An <OpenLayers.Pixel> which represents the center
* of the bounds
*/
@@ -193,7 +193,7 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* APIMethod: getCenterLonLat
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} An <OpenLayers.LonLat> which represents the center
* of the bounds
*/
@@ -209,7 +209,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* x - {Float}
* y - {Float}
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A new <OpenLayers.Bounds> whose coordinates are
* the same as this, but shifted by the passed-in
* x and y values
@@ -276,7 +276,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* inclusive - {Boolean} Whether or not to include the border.
* Default is true.
*
* Return:
* Returns:
* {Boolean} Whether or not the passed-in lonlat is within this bounds.
*/
containsLonLat:function(ll, inclusive) {
@@ -291,7 +291,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* inclusive - {Boolean} Whether or not to include the border.
* Default is true.
*
* Return:
* Returns:
* {Boolean} Whether or not the passed-in pixel is within this bounds.
*/
containsPixel:function(px, inclusive) {
@@ -307,7 +307,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* inclusive - {Boolean} Whether or not to include the border.
* Default is true.
*
* Return:
* Returns:
* {Boolean} Whether or not the passed-in coordinates are within this
* bounds.
*/
@@ -337,7 +337,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* inclusive - {<Boolean>} Whether or not to include the border.
* Default is true.
*
* Return:
* Returns:
* {Boolean} Whether or not the passed-in OpenLayers.Bounds object
* intersects this bounds. Simple math just check if either
* contains the other, allowing for partial.
@@ -376,7 +376,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* inclusive - {<Boolean>} Whether or not to include the border.
* Default is true.
*
* Return:
* Returns:
* {Boolean} Whether or not the passed-in OpenLayers.Bounds object is
* contained within this bounds.
*/
@@ -417,7 +417,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* Parameters:
* lonlat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {String} The quadrant ("br" "tr" "tl" "bl") of the bounds in which
* the coordinate lies.
*/
@@ -447,7 +447,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* this bound.
* Default is 0.
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A copy of this bounds, but wrapped around the
* "dateline" (as specified by the borders of
* maxExtent). Note that this function only returns
@@ -494,7 +494,7 @@ OpenLayers.Bounds = OpenLayers.Class({
* Parameters:
* str - {String}Comma-separated bounds string. (ex. <i>"5,42,10,45"</i>)
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} New <OpenLayers.Bounds> object built from the
* passed-in String.
*/
@@ -511,7 +511,7 @@ OpenLayers.Bounds.fromString = function(str) {
* Parameters:
* bbox - {Array(Float)} Array of bounds values (ex. <i>[5,42,10,45]</i>)
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} New <OpenLayers.Bounds> object built from the
* passed-in Array.
*/
@@ -530,7 +530,7 @@ OpenLayers.Bounds.fromArray = function(bbox) {
* Parameters:
* size - {<OpenLayers.Size>}
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} New <OpenLayers.Bounds> object built from the
* passed-in size.
*/
@@ -548,7 +548,7 @@ OpenLayers.Bounds.fromSize = function(size) {
* Parameters:
* quadrant - {String} two character quadrant shortstring
*
* Return:
* Returns:
* {String} The opposing quadrant ("br" "tr" "tl" "bl"). For Example, if
* you pass in "bl" it returns "tr", if you pass in "br" it
* returns "tl", etc.

4
lib/OpenLayers/BaseTypes/Class.js
View File

@@ -59,7 +59,7 @@ OpenLayers.Class.isPrototype = function () {};
* *Deprecated*. Old method to create an OpenLayers style class. Use the
* <OpenLayers.Class> constructor instead.
*
* Return:
* Returns:
* An OpenLayers class
*/
OpenLayers.Class.create = function() {
@@ -78,7 +78,7 @@ OpenLayers.Class.create = function() {
* Parameters:
* class - One or more classes can be provided as arguments
*
* Return:
* Returns:
* An object prototype
*/
OpenLayers.Class.inherit = function () {

8
lib/OpenLayers/BaseTypes/Element.js
View File

@@ -13,7 +13,7 @@ OpenLayers.Element = {
* Parameters:
* element - {DOMElement}
*
* Return:
* Returns:
* {Boolean} Is the element visible?
*/
visible: function(element) {
@@ -83,7 +83,7 @@ OpenLayers.Element = {
* Parameters:
* element - {DOMElement}
*
* Return:
* Returns:
* {Integer} The offset height of the element passed in
*/
getHeight: function(element) {
@@ -97,7 +97,7 @@ OpenLayers.Element = {
* Parameters:
* element - {DOMElement}
*
* Return:
* Returns:
* {Object} Object with 'width' and 'height' properties which are the
* dimensions of the element passed in.
*/
@@ -130,7 +130,7 @@ OpenLayers.Element = {
* element - {DOMElement}
* style - {?}
*
* Return:
* Returns:
* {?}
*/
getStyle: function(element, style) {

14
lib/OpenLayers/BaseTypes/LonLat.js
View File

@@ -41,7 +41,7 @@ OpenLayers.LonLat = OpenLayers.Class({
* Method: toString
* Return a readable string version of the lonlat
*
* Return:
* Returns:
* {String} String representation of OpenLayers.LonLat object.
* (ex. <i>"lon=5,lat=42"</i>)
*/
@@ -52,7 +52,7 @@ OpenLayers.LonLat = OpenLayers.Class({
/**
* APIMethod: toShortString
*
* Return:
* Returns:
* {String} Shortened String representation of OpenLayers.LonLat object.
* (ex. <i>"5, 42"</i>)
*/
@@ -63,7 +63,7 @@ OpenLayers.LonLat = OpenLayers.Class({
/**
* APIMethod: clone
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} New OpenLayers.LonLat object with the same lon
* and lat values
*/
@@ -78,7 +78,7 @@ OpenLayers.LonLat = OpenLayers.Class({
* lon - {Float}
* lat - {Float}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} A new OpenLayers.LonLat object with the lon and
* lat passed-in added to this's.
*/
@@ -98,7 +98,7 @@ OpenLayers.LonLat = OpenLayers.Class({
* Parameters:
* ll - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {Boolean} Boolean value indicating whether the passed-in
* <OpenLayers.LonLat> object has the same lon and lat
* components as this.
@@ -119,7 +119,7 @@ OpenLayers.LonLat = OpenLayers.Class({
* Parameters:
* maxExtent - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} A copy of this lonlat, but wrapped around the
* "dateline" (as specified by the borders of
* maxExtent)
@@ -155,7 +155,7 @@ OpenLayers.LonLat = OpenLayers.Class({
* str - {String} Comma-separated Lon,Lat coordinate string.
* (ex. <i>"5,40"</i>)
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} New <OpenLayers.LonLat> object built from the
* passed-in String.
*/

12
lib/OpenLayers/BaseTypes/Pixel.js
View File

@@ -28,7 +28,7 @@ OpenLayers.Pixel = OpenLayers.Class({
* x - {Number} The x coordinate
* y - {Number} The y coordinate
*
* Return:
* Returns:
* An instance of OpenLayers.Pixel
*/
initialize: function(x, y) {
@@ -40,7 +40,7 @@ OpenLayers.Pixel = OpenLayers.Class({
* Method: toString
* Cast this object into a string
*
* Return:
* Returns:
* {String} The string representation of Pixel. ex: "x=200.4,y=242.2"
*/
toString:function() {
@@ -51,7 +51,7 @@ OpenLayers.Pixel = OpenLayers.Class({
* APIMethod: clone
* Return a clone of this pixel object
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} A clone pixel
*/
clone:function() {
@@ -65,7 +65,7 @@ OpenLayers.Pixel = OpenLayers.Class({
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {Boolean} The point passed in as parameter is equal to this. Note that
* if px passed in is null, returns false.
*/
@@ -85,7 +85,7 @@ OpenLayers.Pixel = OpenLayers.Class({
* x - {Integer}
* y - {Integer}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} A new Pixel with this pixel's x&y augmented by the
* values passed in.
*/
@@ -104,7 +104,7 @@ OpenLayers.Pixel = OpenLayers.Class({
* Parameters
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} A new Pixel with this pixel's x&y augmented by the
* x&y values of the pixel passed in.
*/

6
lib/OpenLayers/BaseTypes/Size.js
View File

@@ -38,7 +38,7 @@ OpenLayers.Size = OpenLayers.Class({
* Method: toString
* Return the string representation of a size object
*
* Return:
* Returns:
* {String} The string representation of OpenLayers.Size object.
* (ex. <i>"w=55,h=66"</i>)
*/
@@ -50,7 +50,7 @@ OpenLayers.Size = OpenLayers.Class({
* APIMethod: clone
* Create a clone of this size object
*
* Return:
* Returns:
* {<OpenLayers.Size>} A new OpenLayers.Size object with the same w and h
* values
*/
@@ -66,7 +66,7 @@ OpenLayers.Size = OpenLayers.Class({
* Parameters:
* sz - {<OpenLayers.Size>}
*
* Return:
* Returns:
* {Boolean} The passed in size has the same h and w properties as this one.
* Note that if sz passed in is null, returns false.
*

6
lib/OpenLayers/Control.js
View File

@@ -161,7 +161,7 @@ OpenLayers.Control = OpenLayers.Class({
* px - {<OpenLayers.Pixel>} The top-left pixel position of the control
* or null.
*
* Return:
* Returns:
* {DOMElement} A reference to the DIV DOMElement containing the control
*/
draw: function (px) {
@@ -198,7 +198,7 @@ OpenLayers.Control = OpenLayers.Class({
* handler if one has been set. Controls can be
* deactivated by calling the deactivate() method.
*
* Return:
* Returns:
* {Boolean} True if the control was successfully activated or
* false if the control was already active.
*/
@@ -218,7 +218,7 @@ OpenLayers.Control = OpenLayers.Class({
* Deactivates a control and it's associated handler if any. The exact
* effect of this depends on the control itself.
*
* Return:
* Returns:
* {Boolean} True if the control was effectively deactivated or false
* if the control was already inactive.
*/

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.
*
* Return:
* Returns:
* {Boolean} Successfully activated the control and feature handler.
*/
activate: function() {
@@ -147,7 +147,7 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: deactivate
* Deactivate the control and all handlers.
*
* Return:
* Returns:
* {Boolean} Successfully deactivated the control.
*/
deactivate: function() {

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

@@ -126,7 +126,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Return:
* Returns:
* {DOMElement} A reference to the DIV DOMElement containing the switcher
* tabs
*/
@@ -175,7 +175,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
* control to display that state. Groups base layers into a radio-button
* group and lists each data layer with a checkbox.
*
* Return:
* Returns:
* {DOMElement} A reference to the DIV DOMElement containing the control
*/
redraw: function() {

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

@@ -98,7 +98,7 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* evt - {Event}
*
* Return:
* Returns:
* {Boolean}
*/
defaultClick: function (evt) {

10
lib/OpenLayers/Control/OverviewMap.js
View File

@@ -555,7 +555,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
* Method: getRectPxBounds
* Get extent rectangle pixel bounds
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A bounds which is the extent rectangle's pixel
* bounds (relative to the parent element)
*/
@@ -594,7 +594,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* lonLatBounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.Bounds>}A bounds which is the passed-in map lon/lat extent
* translated into pixel bounds for the overview map
*/
@@ -620,7 +620,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* pxBounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} Bounds which is the passed-in overview rect bounds
* translated into lon/lat bounds for the overview map
*/
@@ -642,7 +642,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* overviewMapPx - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} Location which is the passed-in overview map
* OpenLayers.Pixel, translated into lon/lat by the overview map
*/
@@ -665,7 +665,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* lonlat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} Location which is the passed-in OpenLayers.LonLat,
* translated into overview map pixels
*/

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

@@ -60,7 +60,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {DOMElement} A reference to the container div for the PanZoom control
*/
draw: function(px) {
@@ -98,7 +98,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
* xy - {<OpenLayers.Pixel>}
* sz - {<OpenLayers.Size>}
*
* Return:
* Returns:
* {DOMElement} A Div (an alphaImageDiv, to be precise) that contains the
* image of the button, and has all the proper event handlers set.
*/
@@ -132,7 +132,8 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* evt - {Event}
*
* Return: {Boolean}
* Returns:
* {Boolean}
*/
doubleClick: function (evt) {
OpenLayers.Event.stop(evt);

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

@@ -82,7 +82,8 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Return: {DOMElement}
* Returns:
* {DOMElement}
*/
draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments);

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

@@ -78,7 +78,8 @@ OpenLayers.Control.Permalink = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Return: {DOMElement}
* Returns:
* {DOMElement}
*/
draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments);

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

@@ -34,7 +34,8 @@ OpenLayers.Control.Scale = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Return: {DOMElemen}
* Returns:
* {DOMElemen}
*/
draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments);

4
lib/OpenLayers/Events.js
View File

@@ -138,7 +138,7 @@ OpenLayers.Event = {
* event - {Event}
* tagName - {String}
*
* Return:
* Returns:
* {DOMElement} The first node with the given tagName, starting from the
* node the event was triggered on and traversing the DOM upwards
*/
@@ -252,7 +252,7 @@ OpenLayers.Event = {
* observer - {function}
* useCapture - {Boolean}
*
* Return:
* Returns:
* {Boolean} Whether or not the event observer was removed
*/
stopObserving: function(elementParam, name, observer, useCapture) {

8
lib/OpenLayers/Feature.js
View File

@@ -58,7 +58,7 @@ OpenLayers.Feature = OpenLayers.Class({
* lonlat - {<OpenLayers.LonLat>}
* data - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Feature>}
*/
initialize: function(layer, lonlat, data) {
@@ -98,7 +98,7 @@ OpenLayers.Feature = OpenLayers.Class({
/**
* Method: onScreen
*
* Return:
* Returns:
* {Boolean} Whether or not the feature is currently visible on screen
* (based on its 'lonlat' property)
*/
@@ -117,7 +117,7 @@ OpenLayers.Feature = OpenLayers.Class({
* Method: createMarker
* Based on the data associated with the Feature, create and return a marker object.
*
* Return:
* Returns:
* {<OpenLayers.Marker>} A Marker Object created from the 'lonlat' and 'icon' properties
* set in this.data. If no 'lonlat' is set, returns null. If no
* 'icon' is set, OpenLayers.Marker() will load the default image.
@@ -157,7 +157,7 @@ OpenLayers.Feature = OpenLayers.Class({
* Parameters:
* closeBox - {Boolean} create popup with closebox or not
*
* Return:
* Returns:
* {<OpenLayers.Popup.AnchoredBubble>}
*
*/

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

@@ -101,7 +101,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* Create a clone of this vector feature. Does not set any non-standard
* properties.
*
* Return:
* Returns:
* {<OpenLayers.Feature.Vector>} An exact clone of this vector feature.
*/
clone: function () {
@@ -114,7 +114,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* Method: onScreen
* HACK - we need to rewrite this for non-point geometry
*
* Return:
* Returns:
* {Boolean} For now just returns null
*/
onScreen:function() {
@@ -126,7 +126,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* HACK - we need to decide if all vector features should be able to
* create markers
*
* Return:
* Returns:
* {<OpenLayers.Marker>} For now just returns null
*/
createMarker: function() {
@@ -150,7 +150,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* HACK - we need to decide if all vector features should be able to
* create popups
*
* Return:
* Returns:
* {<OpenLayers.Popup>} For now just returns null
*/
createPopup: function() {
@@ -166,7 +166,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* toleranceLon - {float} Optional tolerance in Geometric Coords
* toleranceLat - {float} Optional tolerance in Geographic Coords
*
* Return:
* Returns:
* {Boolean} Whether or not the feature is at the specified location
*/
atPoint: function(lonlat, toleranceLon, toleranceLat) {

2
lib/OpenLayers/Feature/WFS.js
View File

@@ -54,7 +54,7 @@ OpenLayers.Feature.WFS = OpenLayers.Class(OpenLayers.Feature, {
* Parameters:
* xmlNode - {XMLNode}
*
* Return:
* Returns:
* {Object} Data Object with 'id', 'lonlat', and private properties set
*/
processXMLNode: function(xmlNode) {

6
lib/OpenLayers/Format.js
View File

@@ -19,7 +19,7 @@ OpenLayers.Format = OpenLayers.Class({
* options - {Object} An optional object with properties to set on the
* format
*
* Return:
* Returns:
* An instance of OpenLayers.Format
*/
initialize: function(options) {
@@ -34,7 +34,7 @@ OpenLayers.Format = OpenLayers.Class({
* Parameters:
* data - {string} Data to read/parse.
*
* Return:
* Returns:
* Depends on the subclass
*/
read: function(data) {
@@ -48,7 +48,7 @@ OpenLayers.Format = OpenLayers.Class({
* Parameters:
* object - {Object} Object to be serialized
*
* Return:
* Returns:
* {String} A string representation of the object.
*/
write: function(object) {

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

@@ -264,7 +264,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {XMLNode}
*
* Return:
* Returns:
* {<OpenLayers.Geometry.Polygon>} polygon geometry
*/
parsePolygonNode: function(polygonNode) {
@@ -291,7 +291,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* xmlNode - {<XMLNode>}
*
* Return:
* Returns:
* 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>}
*
* Return:
* Returns:
* {DOMElement}
*/
createFeatureXML: function(feature) {
@@ -475,7 +475,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {XmlNode} created xmlNode
*/
buildCoordinatesNode: function(geometry) {

40
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.
*
* Return:
* Returns:
* {Object} The return depends on the value of the type argument. If type
* is "FeatureCollection" (the default), the return will be an array
* of <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.
*
* Return:
* Returns:
* {Boolean} The object is valid GeoJSON object of the given type.
*/
isValidType: function(obj, type) {
@@ -188,7 +188,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* obj - {Object} An object created from a GeoJSON object
*
* Return:
* Returns:
* {<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
*
* Return:
* Returns:
* {<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.
*
* Return:
* Returns:
* {<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.
*
* Return:
* Returns:
* {<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.
*
* Return:
* Returns:
* {<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.
*
* Return:
* Returns:
* {<OpenLayers.Geometry>} A geometry.
*/
"multilinestring": function(array) {
@@ -338,7 +338,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Convert a coordinate array from GeoJSON into an
* <OpenLayers.Geometry>.
*
* Return:
* Returns:
* {<OpenLayers.Geometry>} A geometry.
*/
"polygon": function(array) {
@@ -364,7 +364,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Return:
* Returns:
* {<OpenLayers.Geometry>} A geometry.
*/
"multipolygon": function(array) {
@@ -389,7 +389,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Return:
* Returns:
* {<OpenLayers.Geometry>} A geometry.
*/
"box": function(array) {
@@ -420,7 +420,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* pretty - {Boolean} Structure the output with newlines and indentation.
* Default is false.
*
* Return:
* Returns:
* {String} The GeoJSON string representation of the input geometry,
* features, array of geometries, or array of features.
*/
@@ -494,7 +494,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* feature - {<OpenLayers.Feature.Vector>}
*
* Return:
* Returns:
* {Object} An object representing the point.
*/
'feature': function(feature) {
@@ -514,7 +514,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {Object} An object representing the geometry.
*/
'geometry': function(geometry) {
@@ -533,7 +533,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* point - {<OpenLayers.Geometry.Point>}
*
* Return:
* Returns:
* {Array} An array of coordinates representing the point.
*/
'point': function(point) {
@@ -547,7 +547,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* multipoint - {<OpenLayers.Geometry.MultiPoint>}
*
* Return:
* Returns:
* {Array} An array of point coordinate arrays representing
* the multipoint.
*/
@@ -566,7 +566,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* linestring - {<OpenLayers.Geometry.LineString>}
*
* Return:
* Returns:
* {Array} An array of coordinate arrays representing
* the linestring.
*/
@@ -585,7 +585,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* linestring - {<OpenLayers.Geometry.MultiLineString>}
*
* Return:
* Returns:
* {Array} An array of linestring arrays representing
* the multilinestring.
*/
@@ -604,7 +604,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* polygon - {<OpenLayers.Geometry.Polygon>}
*
* Return:
* Returns:
* {Array} An array of linear ring arrays representing the polygon.
*/
'polygon': function(polygon) {
@@ -622,7 +622,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Parameters:
* multipolygon - {<OpenLayers.Geometry.MultiPolygon>}
*
* Return:
* Returns:
* {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>}
*
* Return:
* Returns:
* {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.
*
* Return:
* Returns:
* {Object} An object, array, string, or number .
*/
read: function(json, filter) {
@@ -141,7 +141,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* pretty - {Boolean} Structure the output with newlines and indentation.
* Default is false.
*
* Return:
* Returns:
* {String} The JSON string representation of the input value.
*/
write: function(value, pretty) {
@@ -158,7 +158,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeIndent
* Output an indentation string depending on the indentation level.
*
* Return:
* Returns:
* {String} An appropriate indentation string.
*/
writeIndent: function() {
@@ -175,7 +175,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeNewline
* Output a string representing a newline if in pretty printing mode.
*
* Return:
* Returns:
* {String} A string representing a new line.
*/
writeNewline: function() {
@@ -186,7 +186,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Method: writeSpace
* Output a string representing a space if in pretty printing mode.
*
* Return:
* Returns:
* {String} A space.
*/
writeSpace: function() {
@@ -206,7 +206,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* object - {Object} The object to be serialized.
*
* Return:
* Returns:
* {String} A JSON string representing the object.
*/
'object': function(object) {
@@ -255,7 +255,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* array - {Array} The array to be serialized
*
* Return:
* Returns:
* {String} A JSON string representing the array.
*/
'array': function(array) {
@@ -287,7 +287,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters
* string - {String} The string to be serialized
*
* Return:
* Returns:
* {String} A JSON string representing the string.
*/
'string': function(string) {
@@ -326,7 +326,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* number - {Number} The number to be serialized.
*
* Return:
* Returns:
* {String} A JSON string representing the number.
*/
'number': function(number) {
@@ -340,7 +340,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* bool - {Boolean} The boolean to be serialized.
*
* Return:
* Returns:
* {String} A JSON string representing the boolean.
*/
'boolean': function(bool) {
@@ -354,7 +354,7 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* date - {Date} The date to be serialized.
*
* Return:
* Returns:
* {String} A JSON string representing the date.
*/
'date': function(date) {

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

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

6
lib/OpenLayers/Format/WKT.js
View File

@@ -22,7 +22,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
* options - {Object} An optional object whose properties will be set on
* this instance
*
* Return:
* Returns:
* {<OpenLayers.Format.WKT>} A new WKT parser.
*/
initialize: function(options) {
@@ -46,7 +46,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
* Parameters:
* wkt - {String} A WKT string
*
* Return:
* Returns:
* {<OpenLayers.Feature.Vector>|Array} A feature or array of features for
* GEOMETRYCOLLECTION WKT.
*/
@@ -71,7 +71,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
* features - {<OpenLayers.Feature.Vector>|Array} A feature or array of
* features
*
* Return:
* Returns:
* {String} The WKT string representation of the input geometries
*/
write: function(features) {

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

@@ -53,7 +53,7 @@ OpenLayers.Format.XML.prototype =
* Parameters:
* text - {String} A XML string
* Return:
* Returns:
* {DOMElement} A DOM node
*/
read: function(text) {
@@ -101,7 +101,7 @@ OpenLayers.Format.XML.prototype =
* Parameters:
* node - {DOMElement} A DOM node.
*
* Return:
* Returns:
* {String} The XML string representation of the input node.
*/
write: function(node) {
@@ -126,7 +126,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI for the element.
* name - {String} The qualified name of the element (prefix:localname).
*
* Return:
* Returns:
* {Element} A DOM element with namespace.
*/
createElementNS: function(uri, name) {
@@ -148,7 +148,7 @@ OpenLayers.Format.XML.prototype =
* Parameters:
* text - {String} The text of the node.
*
* Return:
* Returns:
* {DOMElement} A DOM text node.
*/
createTextNode: function(text) {
@@ -173,7 +173,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the tag (without the prefix).
*
* Return:
* Returns:
* {NodeList} A node list or array of elements.
*/
getElementsByTagNameNS: function(node, uri, name) {
@@ -207,7 +207,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix).
*
* Return:
* Returns:
* {DOMElement} An attribute node or null if none found.
*/
getAttributeNodeNS: function(node, uri, name) {
@@ -241,7 +241,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix).
*
* Return:
* Returns:
* {String} An attribute value or and empty string if none found.
*/
getAttributeNS: function(node, uri, name) {
@@ -267,7 +267,7 @@ OpenLayers.Format.XML.prototype =
* uri - {String} Namespace URI.
* name - {String} Local name of the attribute (without the prefix).
*
* Return:
* Returns:
* {Boolean} The node has an attribute matching the name and namespace.
*/
hasAttributeNS: function(node, uri, name) {

12
lib/OpenLayers/Geometry.js
View File

@@ -54,7 +54,7 @@ OpenLayers.Geometry = OpenLayers.Class({
* Create a clone of this geometry. Does not set any non-standard
* properties of the cloned geometry.
*
* Return:
* Returns:
* {<OpenLayers.Geometry>} An exact clone of this geometry.
*/
clone: function() {
@@ -106,7 +106,7 @@ OpenLayers.Geometry = OpenLayers.Class({
* Get the bounds for this Geometry. If bounds is not set, it
* is calculated again, this makes queries faster.
*
* Return:
* Returns:
* {<OpenLayers.Bounds>}
*/
getBounds: function() {
@@ -136,7 +136,7 @@ OpenLayers.Geometry = OpenLayers.Class({
* toleranceLon - {float} Optional tolerance in Geometric Coords
* toleranceLat - {float} Optional tolerance in Geographic Coords
*
* Return:
* Returns:
* {Boolean} Whether or not the geometry is at the specified location
*/
atPoint: function(lonlat, toleranceLon, toleranceLat) {
@@ -163,7 +163,7 @@ OpenLayers.Geometry = OpenLayers.Class({
* Calculate the length of this geometry. This method is defined in
* subclasses.
*
* Return:
* Returns:
* {Float} The length of the collection by summing its parts
*/
getLength: function() {
@@ -176,7 +176,7 @@ OpenLayers.Geometry = OpenLayers.Class({
* Method: getArea
* Calculate the area of this geometry. This method is defined in subclasses.
*
* Return:
* Returns:
* {Float} The area of the collection by summing its parts
*/
getArea: function() {
@@ -189,7 +189,7 @@ OpenLayers.Geometry = OpenLayers.Class({
* Method: toString
* Returns the Well-Known Text representation of a geometry
*
* Return:
* Returns:
* {String} Well-Known Text
*/
toString: function() {

12
lib/OpenLayers/Geometry/Collection.js
View File

@@ -67,7 +67,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* APIMethod: clone
* Clone this geometry.
*
* Return:
* Returns:
* {<OpenLayers.Geometry.Collection>} An exact clone of this collection
*/
clone: function() {
@@ -86,7 +86,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* Method: getComponentsString
* Get a string representing the components for this collection
*
* Return:
* Returns:
* {String} A string representation of the components of this geometry
*/
getComponentsString: function(){
@@ -139,7 +139,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* component - {<OpenLayers.Geometry>} A geometry to add
* index - {int} Optional index into the array to insert the component
*
* Return:
* Returns:
* {Boolean} The component geometry was successfully added
*/
addComponent: function(component, index) {
@@ -202,7 +202,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* APIMethod: getLength
* Calculate the length of this geometry
*
* Return:
* Returns:
* {Float} The length of the geometry
*/
getLength: function() {
@@ -218,7 +218,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* Calculate the area of this geometry. Note how this function is overridden
* in <OpenLayers.Geometry.Polygon>.
*
* Return:
* Returns:
* {Float} The area of the collection by summing its parts
*/
getArea: function() {
@@ -283,7 +283,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {Boolean} The coordinates are equivalent
*/
equals: function(geometry) {

2
lib/OpenLayers/Geometry/Curve.js
View File

@@ -37,7 +37,7 @@ OpenLayers.Geometry.Curve = OpenLayers.Class(OpenLayers.Geometry.MultiPoint, {
/**
* APIMethod: getLength
*
* Return:
* Returns:
* {Float} The length of the curve
*/
getLength: function() {

4
lib/OpenLayers/Geometry/LinearRing.js
View File

@@ -58,7 +58,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
* point - {<OpenLayers.Geometry.Point>}
* index - {Integer} Index into the array to insert the component
*
* Return:
* Returns:
* {Boolean} Was the Point successfully added?
*/
addComponent: function(point, index) {
@@ -157,7 +157,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
* Note - The area is positive if the ring is oriented CW, otherwise
* it will be negative.
*
* Return:
* Returns:
* {Float} The signed area for a ring.
*/
getArea: function() {

2
lib/OpenLayers/Geometry/MultiPoint.js
View File

@@ -31,7 +31,7 @@ OpenLayers.Geometry.MultiPoint = OpenLayers.Class(
* Parameters:
* components - Array({<OpenLayers.Geometry.Point>})
*
* Return:
* Returns:
* {<OpenLayers.Geometry.MultiPoint>}
*/
initialize: function(components) {

6
lib/OpenLayers/Geometry/Point.js
View File

@@ -44,7 +44,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
/**
* APIMethod: clone
*
* Return:
* Returns:
* {<OpenLayers.Geometry.Point>} An exact clone of this OpenLayers.Geometry.Point
*/
clone: function(obj) {
@@ -91,7 +91,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
* Parameters:
* xy - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {Boolean} Boolean value indicating whether the passed-in
* {<OpenLayers.Geometry>} object has the same components as this
* note that if ll passed in is null, returns false
@@ -109,7 +109,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
/**
* Method: toShortString
*
* Return:
* Returns:
* {String} Shortened String representation of Point object.
* (ex. <i>"5, 42"</i>)
*/

2
lib/OpenLayers/Geometry/Polygon.js
View File

@@ -43,7 +43,7 @@ OpenLayers.Geometry.Polygon = OpenLayers.Class(
* Calculated by subtracting the areas of the internal holes from the
* area of the outer hole.
*
* Return:
* Returns:
* {float} The area of the geometry
*/
getArea: function() {

4
lib/OpenLayers/Geometry/Rectangle.js
View File

@@ -70,7 +70,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, {
/**
* APIMethod: getLength
*
* Return:
* Returns:
* {Float} The length of the geometry
*/
getLength: function() {
@@ -81,7 +81,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, {
/**
* APIMethod: getArea
*
* Return:
* Returns:
* {Float} The area of the geometry
*/
getArea: function() {

6
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.
*
* Return:
* Returns:
* {Boolean} The keyMask matches the keys down on an event.
*/
checkModifiers: function (evt) {
@@ -146,7 +146,7 @@ OpenLayers.Handler = OpenLayers.Class({
* APIMethod: activate
* Turn on the handler. Returns false if the handler was already active.
*
* Return:
* Returns:
* {Boolean} The handler was activated.
*/
activate: function() {
@@ -168,7 +168,7 @@ OpenLayers.Handler = OpenLayers.Class({
* APIMethod: deactivate
* Turn off the handler. Returns false if the handler was already inactive.
*
* Return:
* Returns:
* {Boolean} The handler was deactivated.
*/
deactivate: function() {

14
lib/OpenLayers/Handler/Drag.js
View File

@@ -139,7 +139,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event}
*
* Return:
* Returns:
* {Boolean} Let the event propagate.
*/
mousedown: function (evt) {
@@ -165,7 +165,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event}
*
* Return:
* Returns:
* {Boolean} Let the event propagate.
*/
mousemove: function (evt) {
@@ -191,7 +191,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event}
*
* Return:
* Returns:
* {Boolean} Let the event propagate.
*/
mouseup: function (evt) {
@@ -215,7 +215,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event}
*
* Return:
* Returns:
* {Boolean} Let the event propagate.
*/
mouseout: function (evt) {
@@ -243,7 +243,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event}
*
* Return:
* Returns:
* {Boolean} Let the event propagate.
*/
click: function (evt) {
@@ -260,7 +260,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, {
* Method: activate
* Activate the handler.
*
* Return:
* Returns:
* {Boolean} The handler was successfully activated.
*/
activate: function() {
@@ -276,7 +276,7 @@ OpenLayers.Handler.Drag = OpenLayers.Class(OpenLayers.Handler, {
* Method: deactivate
* Deactivate the handler.
*
* Return:
* Returns:
* {Boolean} The handler was successfully deactivated.
*/
deactivate: function() {

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

@@ -100,7 +100,7 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* type - {String} Callback key
*
* Return:
* Returns:
* {Boolean} A feature was selected
*/
select: function(type, evt) {
@@ -133,7 +133,8 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
* Method: activate
* Turn on the handler. Returns false if the handler was already active.
*
* Return: {Boolean}
* Returns:
* {Boolean}
*/
activate: function() {
if(OpenLayers.Handler.prototype.activate.apply(this, arguments)) {
@@ -149,7 +150,7 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
* Method: activate
* Turn of the handler. Returns false if the handler was already active.
*
* Return:
* Returns:
* {Boolean}
*/
deactivate: function() {

2
lib/OpenLayers/Handler/MouseWheel.js
View File

@@ -123,7 +123,7 @@ OpenLayers.Handler.MouseWheel = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
mousemove: function (evt) {

14
lib/OpenLayers/Handler/Path.js
View File

@@ -98,7 +98,8 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
* Method: freehandMode
* Determine whether to behave in freehand mode or not.
*
* Return: {Boolean}
* Returns:
* {Boolean}
*/
freehandMode: function(evt) {
return (this.freehandToggle && evt[this.freehandToggle]) ?
@@ -129,7 +130,8 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
* Method: geometryClone
* Return a clone of the relevant geometry.
*
* Return: {<OpenLayers.Geometry.LineString>}
* Returns:
* {<OpenLayers.Geometry.LineString>}
*/
geometryClone: function() {
return this.line.geometry.clone();
@@ -143,7 +145,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
mousedown: function(evt) {
@@ -175,7 +177,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
mousemove: function (evt) {
@@ -201,7 +203,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
mouseup: function (evt) {
@@ -228,7 +230,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
dblclick: function(evt) {

11
lib/OpenLayers/Handler/Point.js
View File

@@ -164,7 +164,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
dblclick: function(evt) {
@@ -184,7 +184,8 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, {
* Method: geometryClone
* Return a clone of the relevant geometry.
*
* Return: {<OpenLayers.Geometry.Point>}
* Returns:
* {<OpenLayers.Geometry.Point>}
*/
geometryClone: function() {
return this.point.geometry.clone();
@@ -198,7 +199,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
mousedown: function(evt) {
@@ -230,7 +231,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
mousemove: function (evt) {
@@ -252,7 +253,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, {
* Parameters:
* evt - {Event} The browser event
*
* Return:
* Returns:
* {Boolean} Allow event propagation
*/
mouseup: function (evt) {

2
lib/OpenLayers/Handler/Polygon.js
View File

@@ -93,7 +93,7 @@ OpenLayers.Handler.Polygon = OpenLayers.Class(OpenLayers.Handler.Path, {
* Method: geometryClone
* Return a clone of the relevant geometry.
*
* Return:
* Returns:
* {<OpenLayers.Geometry.Polygon>}
*/
geometryClone: function() {

4
lib/OpenLayers/Icon.js
View File

@@ -85,7 +85,7 @@ OpenLayers.Icon = OpenLayers.Class({
/**
* Method: clone
*
* Return:
* Returns:
* {<OpenLayers.Icon>} A fresh copy of the icon.
*/
clone: function() {
@@ -114,7 +114,7 @@ OpenLayers.Icon = OpenLayers.Class({
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {DOMElement} A new DOM Image of this icon set at the location passed-in
*/
draw: function(px) {

24
lib/OpenLayers/Layer.js
View File

@@ -277,7 +277,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Parameters:
* obj - {<OpenLayers.Layer>} The layer to be cloned
*
* Return:
* Returns:
* {<OpenLayers.Layer>} An exact clone of this <OpenLayers.Layer>
*/
clone: function (obj) {
@@ -344,7 +344,7 @@ OpenLayers.Layer = OpenLayers.Class({
* APIMethod: redraw
* Redraws the layer. Returns true if the layer was redrawn, false if not.
*
* Return:
* Returns:
* {Boolean} The layer was redrawn.
*/
redraw: function() {
@@ -437,7 +437,7 @@ OpenLayers.Layer = OpenLayers.Class({
/**
* APIMethod: getImageSize
*
* Return:
* Returns:
* {<OpenLayers.Size>} The size that the image should be, taking into
* account gutters.
*/
@@ -474,7 +474,7 @@ OpenLayers.Layer = OpenLayers.Class({
/**
* APIMethod: getVisibility
*
* Return:
* Returns:
* {Boolean} The layer should be displayed (if in range).
*/
getVisibility: function() {
@@ -525,7 +525,7 @@ OpenLayers.Layer = OpenLayers.Class({
/**
* Method: calculateInRange
*
* Return:
* Returns:
* {Boolean} The layer is displayable at the current map's current
* resolution.
*/
@@ -695,7 +695,7 @@ OpenLayers.Layer = OpenLayers.Class({
/**
* APIMethod: getResolution
*
* Return:
* Returns:
* {Float} The currently selected resolution of the map, taken from the
* resolutions array, indexed by current zoom level.
*/
@@ -707,7 +707,7 @@ OpenLayers.Layer = OpenLayers.Class({
/**
* APIMethod: getExtent
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A Bounds object which represents the lon/lat
* bounds of the current viewPort.
*/
@@ -724,7 +724,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {Integer} The index of the zoomLevel (entry in the resolutions array)
* that still contains the passed-in extent. We do this by calculating
* the ideal resolution for the given exteng (based on the map size)
@@ -744,7 +744,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Calculates the max extent which includes all of the data for the layer.
* This function is to be implemented by subclasses.
*
* Return:
* Returns:
* {<OpenLayers.Bounds>}
*/
getDataExtent: function () {
@@ -757,7 +757,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Parameters:
* resolution - {Float}
*
* Return:
* Returns:
* {Integer} The index of the zoomLevel (entry in the resolutions array)
* that is the smallest resolution that is greater than the passed-in
* resolution.
@@ -778,7 +778,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Parameters:
* viewPortPx - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} An OpenLayers.LonLat which is the passed-in
* view port <OpenLayers.Pixel>, translated into lon/lat by the layer.
*/
@@ -810,7 +810,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Parameters:
* lonlat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} An <OpenLayers.Pixel> which is the passed-in
* <OpenLayers.LonLat>,translated into view port pixels.
*/

14
lib/OpenLayers/Layer/EventPane.js
View File

@@ -163,7 +163,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
* Method: getWarningHTML
* To be implemented by subclasses.
*
* Return:
* Returns:
* {String} String with information on why layer is broken, how to get
* it working.
*/
@@ -246,7 +246,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* viewPortPx - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} An OpenLayers.LonLat which is the passed-in view
* port OpenLayers.Pixel, translated into lon/lat by map lib
* If the map lib is not loaded or not centered, returns null
@@ -270,7 +270,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* lonlat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} An OpenLayers.Pixel which is the passed-in
* OpenLayers.LonLat, translated into view port pixels by map lib
* If map lib is not loaded or not centered, returns null
@@ -308,7 +308,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
* Parameters
* moLonLat - {Object}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} An OpenLayers.LonLat, translated from the passed in
* MapObject LonLat
* Returns null if null value is passed in
@@ -330,7 +330,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* olLonLat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {Object} A MapObject LonLat, translated from the passed in
* OpenLayers.LonLat
* Returns null if null value is passed in
@@ -356,7 +356,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* moPixel - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} An OpenLayers.Pixel, translated from the passed in
* MapObject Pixel
* Returns null if null value is passed in
@@ -378,7 +378,7 @@ OpenLayers.Layer.EventPane = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* olPixel - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {Object} A MapObject Pixel, translated from the passed in
* OpenLayers.Pixel
* Returns null if null value is passed in

10
lib/OpenLayers/Layer/FixedZoomLevels.js
View File

@@ -115,7 +115,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
* APIMethod: getResolution
* Get the current map resolution
*
* Return:
* Returns:
* {Float} Map units per Pixel
*/
getResolution: function() {
@@ -141,7 +141,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
* Calculates using px-> lonlat translation functions on tl and br
* corners of viewport
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A Bounds object which represents the lon/lat
* bounds of the current viewPort.
*/
@@ -174,7 +174,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
* Parameters:
* resolution - {Float}
*
* Return:
* Returns:
* {Integer} A suitable zoom level for the specified resolution.
* If no baselayer is set, returns null.
*/
@@ -214,7 +214,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
* Parameters:
* moZoom - {Integer}
*
* Return:
* Returns:
* {Integer} An OpenLayers Zoom level, translated from the passed in zoom
* Returns null if null value is passed in
*/
@@ -233,7 +233,7 @@ OpenLayers.Layer.FixedZoomLevels = OpenLayers.Class({
* Parameters:
* olZoom - {Integer}
*
* Return:
* Returns:
* {Integer} A MapObject level, translated from the passed in olZoom
* Returns null if null value is passed in
*/

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

@@ -158,7 +158,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {Integer} Corresponding zoom level for a specified Bounds.
* If mapObject is not loaded or not centered, returns null
*
@@ -189,7 +189,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moBounds - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} An <OpenLayers.Bounds>, translated from the
* passed-in MapObject Bounds.
* Returns null if null value is passed in.
@@ -213,7 +213,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* olBounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {Object} A MapObject Bounds, translated from olBounds
* Returns null if null value is passed in
*/
@@ -238,7 +238,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* gLatLng - {GLatLng}
*
* Return:
* Returns:
* {GPoint} A GPoint specifying gLatLng translated into "Container" coords
*/
addContainerPxFunction: function() {
@@ -265,7 +265,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
/**
* APIMethod: getWarningHTML
*
* Return:
* Returns:
* {String} String with information on why layer is broken, how to get
* it working.
*/
@@ -315,7 +315,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
/**
* APIMethod: getMapObjectCenter
*
* Return:
* Returns:
* {Object} The mapObject's current center in Map Object format
*/
getMapObjectCenter: function() {
@@ -325,7 +325,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
/**
* APIMethod: getMapObjectZoom
*
* Return:
* Returns:
* {Integer} The mapObject's current zoom, in Map Object format
*/
getMapObjectZoom: function() {
@@ -341,7 +341,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Object} MapObject LonLat translated from MapObject Pixel
*/
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
@@ -354,7 +354,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Object} MapObject Pixel transtlated from MapObject LonLat
*/
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
@@ -370,7 +370,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moBounds - {Object} MapObject Bounds format
*
* Return:
* Returns:
* {Object} MapObject Zoom for specified MapObject Bounds
*/
getMapObjectZoomFromMapObjectBounds: function(moBounds) {
@@ -392,7 +392,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Longitude of the given MapObject LonLat
*/
getLongitudeFromMapObjectLonLat: function(moLonLat) {
@@ -405,7 +405,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Latitude of the given MapObject LonLat
*/
getLatitudeFromMapObjectLonLat: function(moLonLat) {
@@ -419,7 +419,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* lon - {Float}
* lat - {Float}
*
* Return:
* Returns:
* {Object} MapObject LonLat built from lon and lat params
*/
getMapObjectLonLatFromLonLat: function(lon, lat) {
@@ -434,7 +434,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} X value of the MapObject Pixel
*/
getXFromMapObjectPixel: function(moPixel) {
@@ -447,7 +447,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} Y value of the MapObject Pixel
*/
getYFromMapObjectPixel: function(moPixel) {
@@ -461,7 +461,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(OpenLayers.Layer.EventPane,
* x - {Integer}
* y - {Integer}
*
* Return:
* Returns:
* {Object} MapObject Pixel from x and y parameters
*/
getMapObjectPixelFromXY: function(x, y) {

6
lib/OpenLayers/Layer/Grid.js
View File

@@ -118,7 +118,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
* Parameters:
* obj - {Object} Is this ever used?
*
* Return:
* Returns:
* {<OpenLayers.Layer.Grid>} An exact clone of this OpenLayers.Layer.Grid
*/
clone: function (obj) {
@@ -216,7 +216,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
* Deprecated. This function will be removed in 3.0. Please use
* getTilesBounds() instead.
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A Bounds object representing the bounds of all the
* currently loaded tiles (including those partially or not at all seen
* onscreen)
@@ -471,7 +471,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
* Parameters
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.Tile>} The added OpenLayers.Tile
*/
addTile:function(bounds, position) {

6
lib/OpenLayers/Layer/HTTPRequest.js
View File

@@ -74,7 +74,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* obj - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Layer.HTTPRequest>} An exact clone of this
* <OpenLayers.Layer.HTTPRequest>
*/
@@ -128,7 +128,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, {
* paramString - {String}
* urls - {Array(String)}
*
* Return:
* Returns:
* {String} An entry from the urls array, deterministically selected based
* on the paramString.
*/
@@ -157,7 +157,7 @@ OpenLayers.Layer.HTTPRequest = OpenLayers.Class(OpenLayers.Layer, {
* newParams - {Object}
* altUrl - {String} Use this as the url instead of the layer's url
*
* Return:
* Returns:
* {String}
*/
getFullRequestString:function(newParams, altUrl) {

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

@@ -91,7 +91,7 @@ OpenLayers.Layer.Image = OpenLayers.Class(OpenLayers.Layer, {
* Paramters:
* obj - {Object} An optional layer (is this ever used?)
*
* Return:
* Returns:
* {<OpenLayers.Layer.Image>} An exact copy of this layer
*/
clone: function(obj) {

6
lib/OpenLayers/Layer/KaMap.js
View File

@@ -77,7 +77,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as
* parameters
@@ -102,7 +102,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, {
* bounds - {<OpenLayers.Bounds>}
* position - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.Tile.Image>}
*/
addTile:function(bounds,position) {
@@ -200,7 +200,7 @@ OpenLayers.Layer.KaMap = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* obj - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Layer.Kamap>} An exact clone of this OpenLayers.Layer.KaMap
*/
clone: function (obj) {

8
lib/OpenLayers/Layer/MapServer.js
View File

@@ -59,7 +59,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Method: clone
* Create a clone of this layer
*
* Return:
* Returns:
* {<OpenLayers.Layer.MapServer>} An exact clone of this layer
*/
clone: function (obj) {
@@ -84,7 +84,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
*/
addTile:function(bounds,position) {
@@ -100,7 +100,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
* bounds - {<OpenLayers.Bounds>} A bounds representing the bbox
* for the request
*
* Return:
* Returns:
* {String} A string with the layer's url and parameters and also
* the passed-in bounds and appropriate tile size specified
* as parameters.
@@ -135,7 +135,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
* altUrl - {String} (optional) Replace the URL in the full request
* string with the provided URL.
*
* Return:
* Returns:
* {String} A string with the layer's url and parameters embedded in it.
*/
getFullRequestString:function(newParams, altUrl) {

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

22
lib/OpenLayers/Layer/MultiMap.js
View File

@@ -83,7 +83,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
/**
* APIMethod: getWarningHTML
*
* Return:
* Returns:
* {String} String with information on why layer is broken, how to get
* it working.
*/
@@ -133,7 +133,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
/**
* APIMethod: getMapObjectCenter
*
* Return:
* Returns:
* {Object} The mapObject's current center in Map Object format
*/
getMapObjectCenter: function() {
@@ -143,7 +143,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
/**
* APIMethod: getMapObjectZoom
*
* Return:
* Returns:
* {Integer} The mapObject's current zoom, in Map Object format
*/
getMapObjectZoom: function() {
@@ -159,7 +159,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Object} MapObject LonLat translated from MapObject Pixel
*/
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
@@ -174,7 +174,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Object} MapObject Pixel transtlated from MapObject LonLat
*/
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
@@ -197,7 +197,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Longitude of the given MapObject LonLat
*/
getLongitudeFromMapObjectLonLat: function(moLonLat) {
@@ -210,7 +210,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Latitude of the given MapObject LonLat
*/
getLatitudeFromMapObjectLonLat: function(moLonLat) {
@@ -224,7 +224,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* lon - {Float}
* lat - {Float}
*
* Return:
* Returns:
* {Object} MapObject LonLat built from lon and lat params
*/
getMapObjectLonLatFromLonLat: function(lon, lat) {
@@ -239,7 +239,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} X value of the MapObject Pixel
*/
getXFromMapObjectPixel: function(moPixel) {
@@ -252,7 +252,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} Y value of the MapObject Pixel
*/
getYFromMapObjectPixel: function(moPixel) {
@@ -266,7 +266,7 @@ OpenLayers.Layer.MultiMap = OpenLayers.Class(
* x - {Integer}
* y - {Integer}
*
* Return:
* Returns:
* {Object} MapObject Pixel from x and y parameters
*/
getMapObjectPixelFromXY: function(x, y) {

6
lib/OpenLayers/Layer/TMS.js
View File

@@ -61,7 +61,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* obj - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Layer.TMS>} An exact clone of this <OpenLayers.Layer.TMS>
*/
clone: function (obj) {
@@ -86,7 +86,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as
* parameters
@@ -112,7 +112,7 @@ OpenLayers.Layer.TMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
*/
addTile:function(bounds,position) {

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

@@ -66,7 +66,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* APIMethod: clone
* obj - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Layer.TileCache>} An exact clone of this
* <OpenLayers.Layer.TileCache>
*/
@@ -92,7 +92,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as parameters.
*/
@@ -108,7 +108,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* number - {Int}
* length - {Int}
*
* Return:
* Returns:
* {String} A zero-padded string
*/
function zeroPad(number, length) {
@@ -145,7 +145,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.Tile.Image>} The added <OpenLayers.Tile.Image>
*/
addTile:function(bounds, position) {

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

@@ -100,7 +100,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
* options - {Object} options Object with non-default properties to set on
* the layer.
*
* Return:
* Returns:
* {<OpenLayers.Layer.Vector>} A new vector layer
*/
initialize: function(name, options) {
@@ -357,7 +357,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* evt - {Event}
*
* Return:
* Returns:
* {<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}
*
* Return:
* Returns:
* {<OpenLayers.Feature.Vector>} A feature corresponding to the given
* featureId
*/

22
lib/OpenLayers/Layer/VirtualEarth.js
View File

@@ -98,7 +98,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
/**
* APIMethod: getWarningHTML
*
* Return:
* Returns:
* {String} String with information on why layer is broken, how to get
* it working.
*/
@@ -148,7 +148,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
/**
* APIMethod: getMapObjectCenter
*
* Return:
* Returns:
* {Object} The mapObject's current center in Map Object format
*/
getMapObjectCenter: function() {
@@ -158,7 +158,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
/**
* APIMethod: getMapObjectZoom
*
* Return:
* Returns:
* {Integer} The mapObject's current zoom, in Map Object format
*/
getMapObjectZoom: function() {
@@ -174,7 +174,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Object} MapObject LonLat translated from MapObject Pixel
*/
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
@@ -187,7 +187,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Object} MapObject Pixel transtlated from MapObject LonLat
*/
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
@@ -210,7 +210,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Longitude of the given MapObject LonLat
*/
getLongitudeFromMapObjectLonLat: function(moLonLat) {
@@ -223,7 +223,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Latitude of the given MapObject LonLat
*/
getLatitudeFromMapObjectLonLat: function(moLonLat) {
@@ -237,7 +237,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* lon - {Float}
* lat - {Float}
*
* Return:
* Returns:
* {Object} MapObject LonLat built from lon and lat params
*/
getMapObjectLonLatFromLonLat: function(lon, lat) {
@@ -252,7 +252,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} X value of the MapObject Pixel
*/
getXFromMapObjectPixel: function(moPixel) {
@@ -265,7 +265,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} Y value of the MapObject Pixel
*/
getYFromMapObjectPixel: function(moPixel) {
@@ -279,7 +279,7 @@ OpenLayers.Layer.VirtualEarth = OpenLayers.Class(
* x - {Integer}
* y - {Integer}
*
* Return:
* Returns:
* {Object} MapObject Pixel from x and y parameters
*/
getMapObjectPixelFromXY: function(x, y) {

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

@@ -277,7 +277,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
* Parameters:
* obj - {Object}
*
* Return:
* Returns:
* {<OpenLayers.Layer.WFS>} An exact clone of this OpenLayers.Layer.WFS
*/
clone: function (obj) {

8
lib/OpenLayers/Layer/WMS.js
View File

@@ -115,7 +115,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Method: clone
* Create a clone of this layer
*
* Return:
* Returns:
* {<OpenLayers.Layer.WMS>} An exact clone of this layer
*/
clone: function (obj) {
@@ -143,7 +143,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
* bounds - {<OpenLayers.Bounds>} A bounds representing the bbox for the
* request.
*
* Return:
* Returns:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as
* parameters.
@@ -165,7 +165,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {<OpenLayers.Tile.Image>} The added OpenLayers.Tile.Image
*/
addTile:function(bounds,position) {
@@ -201,7 +201,7 @@ OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* newParams - {Object}
*
* Return:
* Returns:
* {String}
*/
getFullRequestString:function(newParams) {

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

@@ -85,7 +85,7 @@ OpenLayers.Layer.WorldWind = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as
* parameters

28
lib/OpenLayers/Layer/Yahoo.js
View File

@@ -128,7 +128,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
/**
* APIMethod: getWarningHTML
*
* Return:
* Returns:
* {String} String with information on why layer is broken, how to get
* it working.
*/
@@ -172,7 +172,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* gZoom - {Integer}
*
* Return:
* Returns:
* {Integer} An OpenLayers Zoom level, translated from the passed in gZoom
* Returns null if null value is passed in.
*/
@@ -191,7 +191,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* olZoom - {Integer}
*
* Return:
* Returns:
* {Integer} A MapObject level, translated from the passed in olZoom
* Returns null if null value is passed in
*/
@@ -228,7 +228,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
/**
* APIMethod: getMapObjectCenter
*
* Return:
* Returns:
* {Object} The mapObject's current center in Map Object format
*/
getMapObjectCenter: function() {
@@ -238,7 +238,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
/**
* APIMethod: getMapObjectZoom
*
* Return:
* Returns:
* {Integer} The mapObject's current zoom, in Map Object format
*/
getMapObjectZoom: function() {
@@ -254,7 +254,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Object} MapObject LonLat translated from MapObject Pixel
*/
getMapObjectLonLatFromMapObjectPixel: function(moPixel) {
@@ -267,7 +267,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Object} MapObject Pixel transtlated from MapObject LonLat
*/
getMapObjectPixelFromMapObjectLonLat: function(moLonLat) {
@@ -290,7 +290,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Longitude of the given MapObject LonLat
*/
getLongitudeFromMapObjectLonLat: function(moLonLat) {
@@ -303,7 +303,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* moLonLat - {Object} MapObject LonLat format
*
* Return:
* Returns:
* {Float} Latitude of the given MapObject LonLat
*/
getLatitudeFromMapObjectLonLat: function(moLonLat) {
@@ -317,7 +317,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* lon - {Float}
* lat - {Float}
*
* Return:
* Returns:
* {Object} MapObject LonLat built from lon and lat params
*/
getMapObjectLonLatFromLonLat: function(lon, lat) {
@@ -332,7 +332,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} X value of the MapObject Pixel
*/
getXFromMapObjectPixel: function(moPixel) {
@@ -345,7 +345,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* moPixel - {Object} MapObject Pixel format
*
* Return:
* Returns:
* {Integer} Y value of the MapObject Pixel
*/
getYFromMapObjectPixel: function(moPixel) {
@@ -359,7 +359,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* x - {Integer}
* y - {Integer}
*
* Return:
* Returns:
* {Object} MapObject Pixel from x and y parameters
*/
getMapObjectPixelFromXY: function(x, y) {
@@ -374,7 +374,7 @@ OpenLayers.Layer.Yahoo = OpenLayers.Class(
* Parameters:
* olSize - {<OpenLayers.Size>}
*
* Return:
* Returns:
* {Object} MapObject Size from olSize parameter
*/
getMapObjectSizeFromOLSize: function(olSize) {

59
lib/OpenLayers/Map.js
View File

@@ -424,7 +424,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: getTileSize
* Get the tile size for the map
*
* Return:
* Returns:
* {<OpenLayers.Size>}
*/
getTileSize: function() {
@@ -447,7 +447,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameter:
* id - {String} A layer id
*
* Return:
* Returns:
* {<OpenLayers.Layer>} The Layer with the corresponding id from the map's
* layer collection, or null if not found.
*/
@@ -587,7 +587,8 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getNumLayers
*
* Return: {Int} The number of layers attached to the map.
* Returns:
* {Int} The number of layers attached to the map.
*/
getNumLayers: function () {
return this.layers.length;
@@ -599,7 +600,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* layer - {<OpenLayers.Layer>}
*
* Return:
* Returns:
* {Integer} The current (zero-based) index of the given layer in the map's
* layer stack. Returns -1 if the layer isn't on the map.
*/
@@ -756,7 +757,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* id - {String} ID of the control to return.
*
* Return:
* Returns:
* {<OpenLayers.Control>} The control from the map's list of controls
* which has a matching 'id'. If none found,
* returns null.
@@ -855,7 +856,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getSize
*
* Return:
* Returns:
* {<OpenLayers.Size>} An <OpenLayers.Size> object that represents the
* size, in pixels, of the div into which OpenLayers
* has been loaded.
@@ -907,7 +908,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* Method: getCurrentSize
*
* Return:
* Returns:
* {<OpenLayers.Size>} A new <OpenLayers.Size> object with the dimensions
* of the map div
*/
@@ -936,7 +937,7 @@ OpenLayers.Map = OpenLayers.Class({
* center - {<OpenLayers.LonLat>} Default is this.getCenter()
* resolution - {float} Default is this.getResolution()
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A bounds based on resolution, center, and
* current mapsize.
*/
@@ -980,7 +981,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getCenter
*
* Return:
* Returns:
* {<OpenLayers.LonLat>}
*/
getCenter: function () {
@@ -991,7 +992,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getZoom
*
* Return:
* Returns:
* {Integer}
*/
getZoom: function () {
@@ -1147,7 +1148,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* zoomLevel - {Integer}
*
* Return:
* Returns:
* {Boolean} Whether or not the zoom level passed in is non-null and
* within the min/max range of zoom levels.
*/
@@ -1163,7 +1164,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* lonlat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {Boolean} Whether or not the lonlat passed in is non-null and within
* the maxExtent bounds
*/
@@ -1187,7 +1188,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getProjection
*
* Return:
* Returns:
* {String} The Projection of the base layer.
*/
getProjection: function() {
@@ -1201,7 +1202,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getMaxResolution
*
* Return:
* Returns:
* {String} The Map's Maximum Resolution
*/
getMaxResolution: function() {
@@ -1215,7 +1216,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getMaxExtent
*
* Return:
* Returns:
* {<OpenLayers.Bounds>}
*/
getMaxExtent: function () {
@@ -1229,7 +1230,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getNumZoomLevels
*
* Return:
* Returns:
* {Integer} The total number of zoom levels that can be displayed by the
* current baseLayer.
*/
@@ -1255,7 +1256,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getExtent
*
* Return:
* Returns:
* {<OpenLayers.Bounds>} A Bounds object which represents the lon/lat
* bounds of the current viewPort.
* If no baselayer is set, returns null.
@@ -1271,7 +1272,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getResolution
*
* Return:
* Returns:
* {Float} The current resolution of the map.
* If no baselayer is set, returns null.
*/
@@ -1286,7 +1287,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getScale
*
* Return:
* Returns:
* {Float} The current scale denominator of the map.
* If no baselayer is set, returns null.
*/
@@ -1307,7 +1308,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* Returns:
* {Integer} A suitable zoom level for the specified bounds.
* If no baselayer is set, returns null.
*/
@@ -1325,7 +1326,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameter:
* resolution - {Float}
*
* Return:
* Returns:
* {Integer} A suitable zoom level for the specified resolution.
* If no baselayer is set, returns null.
*/
@@ -1463,7 +1464,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* viewPortPx - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} An OpenLayers.LonLat which is the passed-in view
* port <OpenLayers.Pixel>, translated into lon/lat
* by the current base layer.
@@ -1482,7 +1483,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* lonlat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} An OpenLayers.Pixel which is the passed-in
* <OpenLayers.LonLat>, translated into view port
* pixels by the current base layer.
@@ -1506,7 +1507,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>} An OpenLayers.LonLat corresponding to the given
* OpenLayers.Pixel, translated into lon/lat by the
* current base layer
@@ -1521,7 +1522,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* lonlat - {<OpenLayers.LonLat>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} An OpenLayers.Pixel corresponding to the
* <OpenLayers.LonLat> translated into view port
* pixels by the current base layer.
@@ -1542,7 +1543,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* layerPx - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} Layer Pixel translated into ViewPort Pixel
* coordinates
*/
@@ -1562,7 +1563,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* viewPortPx - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} ViewPort Pixel translated into Layer Pixel
* coordinates
*/
@@ -1589,7 +1590,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.LonLat>}
*/
getLonLatFromLayerPx: function (px) {
@@ -1604,7 +1605,7 @@ OpenLayers.Map = OpenLayers.Class({
* Parameters:
* lonlat - {<OpenLayers.LonLat>} lonlat
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} An OpenLayers.Pixel which is the passed-in
* <OpenLayers.LonLat>, translated into layer pixels
* by the current base layer

6
lib/OpenLayers/Marker.js
View File

@@ -105,7 +105,7 @@ OpenLayers.Marker = OpenLayers.Class({
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {DOMElement} A new DOM Image with this marker's icon set at the
* location passed-in
*/
@@ -130,7 +130,7 @@ OpenLayers.Marker = OpenLayers.Class({
/**
* Method: onScreen
*
* Return:
* Returns:
* {Boolean} Whether or not the marker is currently visible on screen.
*/
onScreen:function() {
@@ -189,7 +189,7 @@ OpenLayers.Marker = OpenLayers.Class({
* Function: defaultIcon
* Creates a default <OpenLayers.Icon>.
*
* Return:
* Returns:
* {<OpenLayers.Icon>} A default OpenLayers.Icon to use for a marker
*/
OpenLayers.Marker.defaultIcon = function() {

2
lib/OpenLayers/Marker/Box.js
View File

@@ -77,7 +77,7 @@ OpenLayers.Marker.Box = OpenLayers.Class(OpenLayers.Marker, {
* px - {<OpenLayers.Pixel>}
* sz - {<OpenLayers.Size>}
*
* Return:
* Returns:
* {DOMElement} A new DOM Image with this marker<65>s icon set at the
* location passed-in
*/

4
lib/OpenLayers/Popup.js
View File

@@ -198,7 +198,7 @@ OpenLayers.Popup = OpenLayers.Class({
* Parameters:
* px - {<OpenLayers.Pixel>} the position the popup in pixels.
*
* Return:
* Returns:
* {DOMElement} Reference to a div that contains the drawn popup
*/
draw: function(px) {
@@ -246,7 +246,7 @@ OpenLayers.Popup = OpenLayers.Class({
/**
* Method: visible
*
* Return:
* Returns:
* {Boolean} Boolean indicating whether or not the popup is visible
*/
visible: function() {

6
lib/OpenLayers/Popup/Anchored.js
View File

@@ -56,7 +56,7 @@ OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, {
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {DOMElement} Reference to a div that contains the drawn popup
*/
draw: function(px) {
@@ -78,7 +78,7 @@ OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, {
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {String} The relative position ("br" "tr" "tl "bl") at which the popup
* should be placed
*/
@@ -126,7 +126,7 @@ OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, {
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {<OpenLayers.Pixel>} The the new px position of the popup on the screen
* relative to the passed-in px
*/

4
lib/OpenLayers/Popup/AnchoredBubble.js
View File

@@ -43,7 +43,7 @@ OpenLayers.Popup.AnchoredBubble = OpenLayers.Class(OpenLayers.Popup.Anchored, {
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* {DOMElement} Reference to a div that contains the drawn popup
*/
draw: function(px) {
@@ -167,7 +167,7 @@ OpenLayers.Popup.AnchoredBubble = OpenLayers.Class(OpenLayers.Popup.Anchored, {
/**
* Method: getCornersToRound
*
* Return:
* Returns:
* {String} The proper corners string ("tr tl bl br") for rico to round
*/
getCornersToRound:function() {

6
lib/OpenLayers/Renderer.js
View File

@@ -76,7 +76,7 @@ OpenLayers.Renderer = OpenLayers.Class({
* APIMethod: supported
* This should be overridden by specific subclasses
*
* Return:
* Returns:
* {Boolean} Whether or not the browser supports the renderer class
*/
supported: function() {
@@ -119,7 +119,7 @@ OpenLayers.Renderer = OpenLayers.Class({
* Method: getResolution
* Uses cached copy of resolution if available to minimize computing
*
* Return:
* Returns:
* The current map's resolution
*/
getResolution: function() {
@@ -176,7 +176,7 @@ OpenLayers.Renderer = OpenLayers.Class({
* Parameters:
* evt - {<OpenLayers.Event>}
*
* Return:
* Returns:
* {String} A feature id or null.
*/
getFeatureIdFromEvent: function(evt) {},

6
lib/OpenLayers/Renderer/Elements.js
View File

@@ -93,7 +93,7 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {String} The corresponding node type for the specified geometry
*/
getNodeType: function(geometry) { },
@@ -284,7 +284,7 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, {
* Parameters:
* evt - {Object} An <OpenLayers.Event> object
*
* Return:
* Returns:
* {<OpenLayers.Geometry>} A geometry from an event that
* happened on a layer
*/
@@ -334,7 +334,7 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, {
* type - {String} type Kind of node to draw
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {DOMElement} A new node of the given type and id
*/
nodeFactory: function(id, type, geometry) {

14
lib/OpenLayers/Renderer/SVG.js
View File

@@ -57,7 +57,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
/**
* APIMethod: supported
*
* Return:
* Returns:
* {Boolean} Whether or not the browser supports the SVG renderer
*/
supported: function() {
@@ -133,7 +133,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {String} The corresponding node type for the specified geometry
*/
getNodeType: function(geometry) {
@@ -251,7 +251,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* type - {String} Kind of node to draw
* id - {String} Id for node
*
* Return:
* Returns:
* {DOMElement} A new node of the given type and id
*/
createNode: function(type, id) {
@@ -269,7 +269,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* node - {SVGDomElement} An SVG element
* type - {String} Kind of node
*
* Return:
* Returns:
* {Boolean} Whether or not the specified node is of the specified type
*/
nodeTypeCompare: function(node, type) {
@@ -279,7 +279,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
/**
* Method: createRenderRoot
*
* Return:
* Returns:
* {DOMElement} The specific render engine's root element
*/
createRenderRoot: function() {
@@ -291,7 +291,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
/**
* Method: createRoot
*
* Return:
* Returns:
* {DOMElement} The main root element to which we'll add vectors
*/
createRoot: function() {
@@ -530,7 +530,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* Parameters:
* point - {<OpenLayers.Geometry.Point>}
*
* Return:
* Returns:
* {String}
*/
getShortString: function(point) {

12
lib/OpenLayers/Renderer/VML.js
View File

@@ -55,7 +55,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* APIMethod: supported
* Determine whether a browser supports this renderer.
*
* Return:
* Returns:
* {Boolean} The browser supports the VML renderer
*/
supported: function() {
@@ -109,7 +109,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {String} The corresponding node type for the specified geometry
*/
getNodeType: function(geometry) {
@@ -280,7 +280,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* type - {String} Kind of node to draw
* id - {String} Id for node
*
* Return:
* Returns:
* {DOMElement} A new node of the given type and id
*/
createNode: function(type, id) {
@@ -299,7 +299,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* type - {String} Kind of node to draw
* id - {String} Id for node
*
* Return:
* Returns:
* {Boolean} Whether or not the specified node is of the specified type
*/
nodeTypeCompare: function(node, type) {
@@ -325,7 +325,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* Method: createRenderRoot
* Create the renderer root
*
* Return:
* Returns:
* {DOMElement} The specific render engine's root element
*/
createRenderRoot: function() {
@@ -338,7 +338,7 @@ OpenLayers.Renderer.VML = OpenLayers.Class(OpenLayers.Renderer.Elements, {
* Method: createRoot
* Create the main root element
*
* Return:
* Returns:
* {DOMElement} The main root element to which we'll add vectors
*/
createRoot: function() {

4
lib/OpenLayers/Tile.js
View File

@@ -129,7 +129,7 @@ OpenLayers.Tile = OpenLayers.Class({
* Clear whatever is currently in the tile, then return whether or not
* it should actually be re-drawn.
*
* Return:
* Returns:
* {Boolean} Whether or not the tile should actually be drawn. Note that
* this is not really the best way of doing things, but such is
* the way the code has been developed. Subclasses call this and
@@ -201,7 +201,7 @@ OpenLayers.Tile = OpenLayers.Class({
* Parameters:
* position - {<OpenLayers.Pixel>}
*
* Return:
* Returns:
* bounds - {<OpenLayers.Bounds>}
*/
getBoundsFromBaseLayer: function(position) {

2
lib/OpenLayers/Tile/Image.js
View File

@@ -84,7 +84,7 @@ OpenLayers.Tile.Image = OpenLayers.Class(OpenLayers.Tile, {
* Method: draw
* Check that a tile should be drawn, and draw it.
*
* Return:
* Returns:
* {Boolean} Always returns true.
*/
draw:function() {

50
lib/OpenLayers/Util.js
View File

@@ -193,7 +193,7 @@ OpenLayers.Util.modifyDOMElement = function(element, id, px, sz, position,
* overflow - {String} The style.overflow value. Eg. hidden
* opacity - {Float} Fractional value (0.0 - 1.0)
*
* Return:
* Returns:
* {DOMElement} A DOM Div created with the specified attributes.
*/
OpenLayers.Util.createDiv = function(id, px, sz, imgURL, position,
@@ -234,7 +234,7 @@ OpenLayers.Util.createDiv = function(id, px, sz, imgURL, position,
* loaded.
* opacity - {Float} Fractional value (0.0 - 1.0)
*
* Return:
* Returns:
* {DOMElement} A DOM Image created with the specified attributes.
*/
OpenLayers.Util.createImage = function(id, px, sz, imgURL, position, border,
@@ -353,7 +353,7 @@ OpenLayers.Util.onImageLoadError = function() {
* hack which allows alpha transparency for png images under Internet
* Explorer.
*
* Return:
* Returns:
* {Boolean} true if alpha has is necessary and possible, false otherwise.
*/
OpenLayers.Util.alphaHack = function() {
@@ -437,7 +437,7 @@ OpenLayers.Util.modifyAlphaImageDiv = function(div, id, px, sz, imgURL,
* sizing {String} 'crop', 'scale', or 'image'. Default is "scale"
* delayDisplay{Boolean}
*
* Return:
* Returns:
* {DOMElement} A DOM Div created with a DOM Image inside it. If the hack is
* needed for transparency in IE, it is added.
*/
@@ -509,7 +509,7 @@ OpenLayers.Util.applyDefaults = function (to, from) {
* Parameters:
* params - {Object}
*
* Return:
* Returns:
* {String} A concatenation of the properties of an object in
* http parameter notation.
* (ex. <i>"key1=value1&key2=value2&key3=value3"</i>)
@@ -552,7 +552,7 @@ OpenLayers.ImgPath = '';
/**
* Function: getImagesLocation
*
* Return:
* Returns:
* {String} The fully formatted image location string
*/
OpenLayers.Util.getImagesLocation = function() {
@@ -572,7 +572,7 @@ OpenLayers.Util.getImagesLocation = function() {
* successfully executes.
* If none executes successfully, returns null.
*
* Return:
* Returns:
* {*} The value returned by the first successfully executed function.
*/
OpenLayers.Util.Try = function() {
@@ -599,7 +599,7 @@ OpenLayers.Util.Try = function() {
* p - {}
* tagName - {String}
*
* Return:
* Returns:
* {Array}
*/
OpenLayers.Util.getNodes=function(p, tagName) {
@@ -622,7 +622,7 @@ OpenLayers.Util.getNodes=function(p, tagName) {
* nodes - {Array}
* tagName - {String}
*
* Return:
* Returns:
* {Array}
*/
OpenLayers.Util._getNodes=function(nodes, tagName) {
@@ -646,7 +646,7 @@ OpenLayers.Util._getNodes=function(nodes, tagName) {
* item - {String}
* index - {Integer}
*
* Return:
* Returns:
* {String}
*/
OpenLayers.Util.getTagText = function (parent, item, index) {
@@ -673,7 +673,7 @@ OpenLayers.Util.getTagText = function (parent, item, index) {
* Parameters:
* node - {XMLNode}
*
* Return:
* Returns:
* {String} The text value of the given node, without breaking in firefox or IE
*/
OpenLayers.Util.getXmlNodeValue = function(node) {
@@ -699,7 +699,7 @@ OpenLayers.Util.getXmlNodeValue = function(node) {
* evt - {Event}
* div - {HTMLDivElement}
*
* Return:
* Returns:
* {Boolean}
*/
OpenLayers.Util.mouseLeft = function (evt, div) {
@@ -719,7 +719,7 @@ OpenLayers.Util.mouseLeft = function (evt, div) {
* Parameters:
* x - {Float}
*
* Return:
* Returns:
* {Float}
*/
OpenLayers.Util.rad = function(x) {return x*Math.PI/180;};
@@ -731,7 +731,7 @@ OpenLayers.Util.rad = function(x) {return x*Math.PI/180;};
* p1 - {Float}
* p2 - {Float}
*
* Return:
* Returns:
* {Float}
*/
OpenLayers.Util.distVincenty=function(p1, p2) {
@@ -779,7 +779,7 @@ OpenLayers.Util.distVincenty=function(p1, p2) {
* url - {String} Optional url used to extract the query string.
* If null, query string is taken from page location.
*
* Return:
* Returns:
* {Object} An object of key/value pairs from the query string.
*/
OpenLayers.Util.getParameters = function(url) {
@@ -831,7 +831,7 @@ OpenLayers.Util.getParameters = function(url) {
* url - {String} Optional url used to extract the query string.
* If null, query string is taken from page location.
*
* Return:
* Returns:
* {Object} An object of key/value pairs from the query string.
*/
OpenLayers.Util.getArgs = function(url) {
@@ -856,7 +856,7 @@ OpenLayers.Util.lastSeqID = 0;
* prefix {String} String to prefix unique id.
* If null, default is "id_"
*
* Return:
* Returns:
* {String} A unique id string, built on the passed in prefix
*/
OpenLayers.Util.createUniqueID = function(prefix) {
@@ -894,7 +894,7 @@ OpenLayers.DOTS_PER_INCH = 72;
* Parameters:
* scale - {float}
*
* Return:
* Returns:
* {Float} A normalized scale value, in 1 / X format.
* This means that if a value less than one ( already 1/x) is passed
* in, it just returns scale directly. Otherwise, it returns
@@ -914,7 +914,7 @@ OpenLayers.Util.normalizeScale = function (scale) {
* units - {String} Index into OpenLayers.INCHES_PER_UNIT hashtable.
* Default is degrees
*
* Return:
* Returns:
* {Float} The corresponding resolution given passed-in scale and unit
* parameters.
*/
@@ -939,7 +939,7 @@ OpenLayers.Util.getResolutionFromScale = function (scale, units) {
* units - {String} Index into OpenLayers.INCHES_PER_UNIT hashtable.
* Default is degrees
*
* Return:
* Returns:
* {Float} The corresponding scale given passed-in resolution and unit
* parameters.
*/
@@ -979,7 +979,7 @@ OpenLayers.Util.safeStopPropagation = function(evt) {
* Parameters:
* forElement - {DOMElement}
*
* Return:<3A>
* Returns:<3A>
* {Array} two item array, L value then T value.
*/
OpenLayers.Util.pagePosition = function(forElement) {
@@ -1044,7 +1044,7 @@ OpenLayers.Util.pagePosition = function(forElement) {
* 'ignorePort80' - Default is True
* 'ignoreHash' - Default is True
*
* Return:
* Returns:
* {Boolean} Whether or not the two URLs are equivalent
*/
OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) {
@@ -1116,7 +1116,7 @@ OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) {
* ignorePort80: don't include explicit port if port is 80,
* ignoreHash: Don't include part of url after the hash (#).
*
* Return:
* Returns:
* {Object} An object with separate url, a, port, host, and args parsed out
* and ready for comparison
*/
@@ -1227,7 +1227,7 @@ OpenLayers.Util.createUrlObject = function(url, options) {
* Parameters:
* url - {String} The url to process
*
* Return:
* Returns:
* {String} The string with all queryString and Hash removed
*/
OpenLayers.Util.removeTail = function(url) {
@@ -1249,7 +1249,7 @@ OpenLayers.Util.removeTail = function(url) {
/**
* Function: getBrowserName
*
* Return:
* Returns:
* {String} A string which specifies which is the current
* browser in which we are running.
*