[OpenLayers-Commits] r12390 - sandbox/jsdoc/jsd/OpenLayers/Layer

[commits-20090109 at openlayers.org]

Author: tschaub
Date: 2011-09-17 12:53:14 -0700 (Sat, 17 Sep 2011)
New Revision: 12390

Modified:
   sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js
Log:
More doc.

Modified: sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js
===================================================================
--- sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js	2011-09-17 19:49:11 UTC (rev 12389)
+++ sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js	2011-09-17 19:53:14 UTC (rev 12390)
@@ -9,36 +9,36 @@
  * @requires OpenLayers/Tile/Image.js
  */
 
-/**
- * Instances of OpenLayers.Layer.WMS are used to display data from OGC Web
- *     Mapping Services. Create a new WMS layer with the <OpenLayers.Layer.WMS>
- *     constructor.
- *
- * <pre>
- * // The code below creates a transparent WMS layer with additional options.
- * var wms = new OpenLayers.Layer.WMS(
- *     "NASA Global Mosaic",
- *     "http://wms.jpl.nasa.gov/wms.cgi", 
- *     {
- *         layers: "modis,global_mosaic",
- *         transparent: true
- *     }, {
- *         opacity: 0.5,
- *         singleTile: true
- * });
- * </pre>
- *
- * @param {string} name  A name for the layer
- * @param {string} url  Base url for the WMS
- *                (e.g. http://wms.jpl.nasa.gov/wms.cgi)
- * @param {Object} params  An object with key/value pairs representing the
- *                   GetMap query string parameters and parameter values.
- * @param {Object=} options options - {Object} Hashtable of extra options to tag onto the layer.
- *     These options include all properties listed above, plus the ones
- *     inherited from superclasses.
- * @constructor OpenLayers.Layer.WMS
- * @extends OpenLayers.Layer.Grid
- */
+ /**
+  * Instances of OpenLayers.Layer.WMS are used to display data from OGC Web
+  *     Mapping Services. Create a new WMS layer with the <OpenLayers.Layer.WMS>
+  *     constructor.
+  *
+  * <pre>
+  * // The code below creates a transparent WMS layer with additional options.
+  * var wms = new OpenLayers.Layer.WMS(
+  *     "NASA Global Mosaic",
+  *     "http://wms.jpl.nasa.gov/wms.cgi", 
+  *     {
+  *         layers: "modis,global_mosaic",
+  *         transparent: true
+  *     }, {
+  *         opacity: 0.5,
+  *         singleTile: true
+  * });
+  * </pre>
+  *
+  * @param {string} name  A name for the layer
+  * @param {string} url  Base url for the WMS
+  *                (e.g. http://wms.jpl.nasa.gov/wms.cgi)
+  * @param {Object} params  An object with key/value pairs representing the
+  *                   GetMap query string parameters and parameter values.
+  * @param {Object=} options options - {Object} Hashtable of extra options to tag onto the layer.
+  *     These options include all properties listed above, plus the ones
+  *     inherited from superclasses.
+  * @constructor OpenLayers.Layer.WMS
+  * @extends OpenLayers.Layer.Grid
+  */
 OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
 
     /**
@@ -57,10 +57,11 @@
     /**
      * *Deprecated*. See http://trac.openlayers.org/wiki/SphericalMercator
      * for information on the replacement for this functionality. 
-     * @type {boolean}  Try to reproject this layer if its coordinate reference system
+     * Try to reproject this layer if its coordinate reference system
      *           is different than that of the base layer.  Default is false.  
      *           Set this in the layer options.  Should be set to false in 
      *           most cases.
+     * @type {boolean}
      * @memberOf OpenLayers.Layer.WMS.prototype
      */
     reproject: false,
@@ -76,7 +77,6 @@
      * Should the BBOX commas be encoded? The WMS spec says 'no', 
      * but some services want it that way. Default false.
      * @type {boolean}  
-     * @memberOf OpenLayers.Layer.WMS.prototype
      */
     encodeBBOX: false,
     
@@ -122,6 +122,8 @@
      * the "transparent" param to true will apply some magic (see <noMagic>).
      * The default image format changes from image/jpeg to image/png, and the
      * layer is not configured as baseLayer.
+     * @methodOf OpenLayers.Layer.WMS.prototype
+     * @constructor OpenLayers.Layer.WMS
      */
     initialize: function(name, url, params, options) {
         var newArguments = [];