diff --git a/lib/OpenLayers/Layer/WMS.js b/lib/OpenLayers/Layer/WMS.js index 3984a3e6f6..a015fff81d 100644 --- a/lib/OpenLayers/Layer/WMS.js +++ b/lib/OpenLayers/Layer/WMS.js @@ -1,45 +1,57 @@ +/** +* @class +*/ OpenLayers.Layer.WMS = Class.create(); OpenLayers.Layer.WMS.prototype = Object.extend( new OpenLayers.Layer.Grid(), { - // hash - DEFAULT_PARAMS: { - service: "WMS", - version: "1.1.1", - request: "GetMap", - srs: "EPSG:4326", - styles: "", - exceptions: "application/vnd.ogc.se_inimage", - format: "image/jpeg" - }, + /** @final @type hash */ + DEFAULT_PARAMS: { service: "WMS", + version: "1.1.1", + request: "GetMap", + srs: "EPSG:4326", + styles: "", + exceptions: "application/vnd.ogc.se_inimage", + format: "image/jpeg" + }, /** + * @constructor + * * @param {str} name * @param {str} url * @param {hash} params */ initialize: function(name, url, params) { OpenLayers.Layer.Grid.prototype.initialize.apply(this, arguments); - OpenLayers.Util.applyDefaults( this.params, this.DEFAULT_PARAMS ); + OpenLayers.Util.applyDefaults(this.params, this.DEFAULT_PARAMS); }, /** - * @param + * @param {String} name + * @param {hash} params + * + * @returns A clone of this OpenLayers.Layer.WMS, with the passed-in + * parameters merged in. + * @type OpenLayers.Layer.WMS */ clone: function (name, params) { - var mergedParams = {} + var mergedParams = {}; Object.extend(mergedParams, this.params); Object.extend(mergedParams, params); var obj = new OpenLayers.Layer.WMS(name, this.url, mergedParams); - obj.setTileSize( this.tileSize ); + obj.setTileSize(this.tileSize); return obj; }, /** * addTile creates a tile, initializes it (via 'draw' in this case), and - * adds it to the layer div. THe tile itself is then returned so that info - * about it can be stored for later reuse. + * adds it to the layer div. + * * @param {OpenLayers.Bounds} bounds + * + * @returns The added OpenLayers.Tile.Image + * @type OpenLayers.Tile.Image */ addTile:function(bounds,position) { url = this.getFullRequestString( @@ -53,8 +65,13 @@ OpenLayers.Layer.WMS.prototype = return tile; }, + /** clear out the layer's main div + */ _initTiles: function () { this.div.innerHTML=""; OpenLayers.Layer.Grid.prototype._initTiles.apply(this, arguments); } + + /** @final @type String */ + CLASS_NAME: "OpenLayers.Layer.WMS" });