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

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

Browse Source 
git-svn-id: http://svn.openlayers.org/trunk/openlayers@4109 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2007-08-29 18:08:32 +00:00
parent e5641c76e0
commit b5ef77096c
27 changed files with 192 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/OpenLayers/Layer/Markers.js
+1 -1
View File
@@ -144,7 +144,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, {
* APIMethod: getDataExtent
* Calculates the max extent which includes all of the markers.
*
* Returns:
* Return:
* {<OpenLayers.Bounds>}
*/
getDataExtent: function () {
lib/OpenLayers/Layer/TileCache.js
+32 -31
View File
@@ -20,38 +20,39 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* APIProperty: reproject
* {Boolean} Try to reproject this layer if it is used as an overlay.
* Default is false.
**/
*/
reproject: false,
/**
* APIProperty: isBaseLayer
* {Boolean} Treat this layer as a base layer. Default is true.
**/
*/
isBaseLayer: true,
/**
* APIProperty: tileOrigin
* {<OpenLayers.LonLat>} Location of the tile lattice origin. Default is
* bottom left of the maxExtent.
**/
*/
tileOrigin: null,
/**
* APIProperty: format
* {String} Mime type of the images returned. Default is image/png.
**/
*/
format: 'image/png',
/**
* Constructor: OpenLayers.Layer.TileCache
* Create a new read only TileCache layer.
*
* Parameters:
* name - {String} Name of the layer displayed in the interface
* url - {String} Location of the web accessible cache
* layername - {String} Layer name as defined in the TileCache configuration
* options - {Object} Hashtable of extra options to tag onto the layer
*/
* Constructor: OpenLayers.Layer.TileCache
* Create a new read only TileCache layer.
*
* Parameters:
* name - {String} Name of the layer displayed in the interface
* url - {String} Location of the web accessible cache
* layername - {String} Layer name as defined in the TileCache
* configuration
* options - {Object} Hashtable of extra options to tag onto the layer
*/
initialize: function(name, url, layername, options) {
options = OpenLayers.Util.extend({maxResolution: 180/256}, options);
this.layername = layername;
@@ -65,8 +66,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* APIMethod: clone
* obj - {Object}
*
* Returns:
* An exact clone of this <OpenLayers.Layer.TileCache>
* Return:
* {<OpenLayers.Layer.TileCache>} An exact clone of this
* <OpenLayers.Layer.TileCache>
*/
clone: function (obj) {
@@ -90,10 +92,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Returns:
* A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as
* parameters
* Return:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as parameters.
*/
getURL: function(bounds) {
var res = this.map.getResolution();
@@ -106,9 +107,9 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Zero-pad a positive integer.
* number - {Int}
* length - {Int}
* Returns:
* A zero-padded string
*
* Return:
* {String} A zero-padded string
*/
function zeroPad(number, length) {
number = String(number);
@@ -138,15 +139,15 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
},
/**
* Method: addTile
* Create a tile, initialize it, and add it to the layer div.
*
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Returns:
* The added {<OpenLayers.Tile.Image>}
*/
* Method: addTile
* Create a tile, initialize it, and add it to the layer div.
*
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Return:
* {<OpenLayers.Tile.Image>} The added <OpenLayers.Tile.Image>
*/
addTile:function(bounds, position) {
var url = this.getURL(bounds);
return new OpenLayers.Tile.Image(this, position, bounds,
lib/OpenLayers/Layer/Vector.js
+2 -2
View File
@@ -357,7 +357,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* evt - {Event}
*
* Returns:
* Return:
* {<OpenLayers.Feature.Vector>} A feature if one was under the event.
*/
getFeatureFromEvent: function(evt) {
@@ -372,7 +372,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
* Parameters:
* featureId - {String}
*
* Returns:
* Return:
* {<OpenLayers.Feature.Vector>} A feature corresponding to the given
* featureId
*/
lib/OpenLayers/Layer/WFS.js
+16 -16
View File
@@ -25,7 +25,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/**
* APIProperty: ratio
* {Float} the ratio of image/tile size to map size (this is the untiled
* buffer)
* buffer)
*/
ratio: 2,
@@ -41,8 +41,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/**
* APIProperty: featureClass
* {<OpenLayers.Feature>} If featureClass is defined, an old-style markers
* based WFS layer is created instead of a new-style vector layer. If
* sent, this should be a subclass of OpenLayers.Feature
* based WFS layer is created instead of a new-style vector layer. If
* sent, this should be a subclass of OpenLayers.Feature
*/
featureClass: null,
@@ -55,19 +55,19 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/**
* APIProperty: encodeBBOX
* {Boolean} Should the BBOX commas be encoded? The WMS spec says 'no',
* but some services want it that way. Default false.
* but some services want it that way. Default false.
*/
encodeBBOX: false,
/**
* Constructor: OpenLayers.Layer.WFS
*
* Parameters:
* name - {String}
* url - {String}
* params - {Object}
* options - {Object} Hashtable of extra options to tag onto the layer
*/
* Constructor: OpenLayers.Layer.WFS
*
* Parameters:
* name - {String}
* url - {String}
* params - {Object}
* options - {Object} Hashtable of extra options to tag onto the layer
*/
initialize: function(name, url, params, options) {
if (options == undefined) { options = {}; }
@@ -277,8 +277,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
* Parameters:
* obj - {Object}
*
* Returns:
* {<OpenLayers.Layer.WFS>} LAn exact clone of this OpenLayers.Layer.WFS
* Return:
* {<OpenLayers.Layer.WFS>} An exact clone of this OpenLayers.Layer.WFS
*/
clone: function (obj) {
@@ -387,8 +387,8 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
/**
* APIMethod: commitReport
* Called with a 'success' message if the commit succeeded, otherwise
* a failure message, and the full request text as a second parameter.
* Override this function to provide custom transaction reporting.
* a failure message, and the full request text as a second parameter.
* Override this function to provide custom transaction reporting.
*
* string - {String} reporting string
* response - {String} full XML response
lib/OpenLayers/Layer/WorldWind.js
+1 -1
View File
@@ -85,7 +85,7 @@ OpenLayers.Layer.WorldWind = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Parameters:
* bounds - {<OpenLayers.Bounds>}
*
* Returns:
* Return:
* {String} A string with the layer's url and parameters and also the
* passed-in bounds and appropriate tile size specified as
* parameters