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

git-svn-id: http://svn.openlayers.org/trunk/openlayers@4109 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2007-08-29 18:08:32 +00:00
parent e5641c76e0
commit b5ef77096c
27 changed files with 192 additions and 196 deletions
+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,