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

[commits-20090109 at openlayers.org]

Author: tschaub
Date: 2011-09-17 12:57:12 -0700 (Sat, 17 Sep 2011)
New Revision: 12391

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:53:14 UTC (rev 12390)
+++ sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js	2011-09-17 19:57:12 UTC (rev 12391)
@@ -9,36 +9,6 @@
  * @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
-  */
 OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
 
     /**
@@ -99,32 +69,36 @@
      */
     yx: {'EPSG:4326': true},
     
-    /**
-     * Constructor: OpenLayers.Layer.WMS
-     * Create a new WMS layer object
-     *
-     * Examples:
-     *
-     * The code below creates a simple WMS layer using the image/jpeg format.
-     * (code)
-     * var wms = new OpenLayers.Layer.WMS("NASA Global Mosaic",
-     *                                    "http://wms.jpl.nasa.gov/wms.cgi", 
-     *                                    {layers: "modis,global_mosaic"});
-     * (end)
-     * Note the 3rd argument (params). Properties added to this object will be
-     * added to the WMS GetMap requests used for this layer's tiles. The only
-     * mandatory parameter is "layers". Other common WMS params include
-     * "transparent", "styles" and "format". Note that the "srs" param will
-     * always be ignored. Instead, it will be derived from the baseLayer's or
-     * map's projection.
-     *
-     * Note that by default, a WMS layer is configured as baseLayer. Setting
-     * 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
-     */
+     /**
+      * 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
+      */
     initialize: function(name, url, params, options) {
         var newArguments = [];
         //uppercase params