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

[commits-20090109 at openlayers.org]

Author: tschaub
Date: 2011-09-17 13:49:21 -0700 (Sat, 17 Sep 2011)
New Revision: 12396

Modified:
   sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js
Log:
Doc corrections.

Modified: sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js
===================================================================
--- sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js	2011-09-17 20:26:49 UTC (rev 12395)
+++ sandbox/jsdoc/jsd/OpenLayers/Layer/WMS.js	2011-09-17 20:49:21 UTC (rev 12396)
@@ -17,8 +17,11 @@
 OpenLayers.Layer.WMS = OpenLayers.Class(OpenLayers.Layer.Grid, {
 
     /**
-     * @const Constant: DEFAULT_PARAMS
-     * @type {Object}  Hashtable of default parameter key/value pairs 
+     * Hashtable of default parameter key/value pairs.
+     * @const DEFAULT_PARAMS
+     * @type {Object}
+     * @private
+     * @memberOf OpenLayers.Layer.WMS.prototype
      */
     DEFAULT_PARAMS: { service: "WMS",
                       version: "1.1.1",
@@ -28,44 +31,49 @@
                      },
     
     /**
-     * @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}  
      * @private
      * @deprecated See http://trac.openlayers.org/wiki/SphericalMercator for 
      *     information on the replacement for this functionality. 
+     * @memberOf OpenLayers.Layer.WMS.prototype
      */
     reproject: false,
  
     /**
-     * APIProperty: isBaseLayer
-     * @type {boolean}  Default is true for WMS layer
+     * Default is true for WMS layer
+     * @type {boolean}
+     * @memberOf OpenLayers.Layer.WMS.prototype
      */
     isBaseLayer: true,
     
     /**
-     * APIProperty: encodeBBOX
-     * @type {boolean}  Should the BBOX commas be encoded? The WMS spec says 'no', 
+     * 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,
     
     /** 
-     * APIProperty: noMagic 
-     * @type {boolean}  If true, the image format will not be automagicaly switched 
+     * If true, the image format will not be automagicaly switched 
      *     from image/jpeg to image/png or image/gif when using 
      *     TRANSPARENT=TRUE. Also isBaseLayer will not changed by the  
-     *     constructor. Default false. 
+     *     constructor. Default false.
+     * @type {boolean}   
+     * @memberOf OpenLayers.Layer.WMS.prototype
      */ 
     noMagic: false,
     
     /**
-     * Property: yx
-     * @type {Object}  Keys in this object are EPSG codes for which the axis order
+     *   Keys in this object are EPSG codes for which the axis order
      *     is to be reversed (yx instead of xy, LatLon instead of LonLat), with
      *     true as value. This is only relevant for WMS versions >= 1.3.0.
+     * @type {Object}
+     * @memberOf OpenLayers.Layer.WMS.prototype
      */
     yx: {'EPSG:4326': true},
     
@@ -133,7 +141,6 @@
     },    
 
     /**
-     * Method: destroy
      * Destroy this layer
      * @memberOf OpenLayers.Layer.WMS.prototype
      */
@@ -144,10 +151,8 @@
 
     
     /**
-     * Method: clone
      * Create a clone of this layer
      *
-     * Returns:
      * @return {OpenLayers.Layer.WMS}  An exact clone of this layer
      * @memberOf OpenLayers.Layer.WMS.prototype
      */
@@ -169,11 +174,9 @@
     },    
     
     /**
-     * APIMethod: reverseAxisOrder
      * Returns true if the axis order is reversed for the WMS version and
      * projection of the layer.
      * 
-     * Returns:
      * @return {boolean}  true if the axis order is reversed, false otherwise.
      * @memberOf OpenLayers.Layer.WMS.prototype
      */
@@ -183,14 +186,11 @@
     },
     
     /**
-     * Method: getURL
      * Return a GetMap query string for this layer
      *
-     * Parameters:
      * @param {OpenLayers.Bounds} bounds  A bounds representing the bbox for the
      *                                request.
      *
-     * 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.
@@ -214,14 +214,12 @@
     },
 
     /**
-     * APIMethod: mergeNewParams
      * Catch changeParams and uppercase the new params to be merged in
      *     before calling changeParams on the super class.
      * 
      *     Once params have been changed, the tiles will be reloaded with
      *     the new parameters.
      * 
-     * Parameters:
      * @param {Object} newParams  Hashtable of new params to use
      * @memberOf OpenLayers.Layer.WMS.prototype
      */
@@ -233,18 +231,15 @@
     },
 
     /** 
-     * APIMethod: getFullRequestString
      * Combine the layer's url with its params and these newParams. 
      *   
      *     Add the SRS parameter from projection -- this is probably
      *     more eloquently done via a setProjection() method, but this 
      *     works for now and always.
      *
-     * Parameters:
      * @param {Object} newParams 
      * @param {string} altUrl  Use this as the url instead of the layer's url
      * 
-     * Returns:
      * @return {string}  
      * @memberOf OpenLayers.Layer.WMS.prototype
      */