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

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