fix up comments

git-svn-id: http://svn.openlayers.org/trunk/openlayers@3591 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf

lib/OpenLayers/Layer/MapServer.js

@@ -1,7 +1,7 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under a modified BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/repository-license.txt 
  * for the full text of the license. */
-// @requires OpenLayers/Layer/Grid.js
+
 /**
  * @requires OpenLayers/Layer/Grid.js
  *
@@ -16,37 +16,27 @@ OpenLayers.Layer.MapServer = OpenLayers.Class.create();
 OpenLayers.Layer.MapServer.prototype =
   OpenLayers.Class.inherit( OpenLayers.Layer.Grid, {
 
-      /**
+    /**
-       * Constant: DEFAULT_PARAMS
+     * Constant: DEFAULT_PARAMS
-       * {Object} Hashtable of default parameter key/value pairs 
+     * {Object} Hashtable of default parameter key/value pairs 
-       */
+     */
     DEFAULT_PARAMS: {
-                      mode: "map",
+        mode: "map",
-                      map_imagetype: "png"
+        map_imagetype: "png"
-                     },
+    },
 
-     /**
+    /**
-      * Constructor: OpenLayers.Layer.MapServer
+     * Constructor: OpenLayers.Layer.MapServer
-      * Create a new MapServer layer object
+     * Create a new MapServer layer object
-      *
+     *
-      * Example:
+     * Parameters:
-      * (code)
+     * name - {String} A name for the layer
-      * layer = new OpenLayers.Layer.MapServer( "OpenLayers WMS", 
+     * url - {String} Base url for the MapServer CGI
-      *         "http://labs.metacarta.com/wms/vmap0", {layers: 'basic'},
+     *       (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv)
-      *         {gutter: 15});
+     * params - {Object} An object with key/value pairs representing the
-      * (end)
+     *          GetMap query string parameters and parameter values.
-      *
+     * options - {Ojbect} Hashtable of extra options to tag onto the layer
-      * Parameters:
+     */
-      * name - {String} A name for the layer
-      * url - {String} Base url for the MapServer CGI
-      *       (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv)
-      * params - {Object} An object with key/value pairs representing the
-      *          GetMap query string parameters and parameter values.
-      * options - {Ojbect} Hashtable of extra options to tag onto the layer
-      *
-      * Return:
-      * A new OpenLayers.Layer.MapServer instance
-      */
     initialize: function(name, url, params, options) {
         var newArguments = new Array();
         newArguments.push(name, url, params, options);
@@ -90,14 +80,15 @@ OpenLayers.Layer.MapServer.prototype =
     },
 
     /**
-    * addTile creates a tile, initializes it, and 
+     * Method: addTile
-    * adds it to the layer div. 
+     * Creates a tile, initializes it, and adds it to the layer div. 
-    *
+     *
-    * @param {<OpenLayers.Bounds>} bounds
+     * Parameters:
-    *
+     * bounds - {<OpenLayers.Bounds>}
-    * @returns The added OpenLayers.Tile.Image
+     * 
-    * @type OpenLayers.Tile.Image
+     * 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, url, this.tileSize);
@@ -108,12 +99,13 @@ OpenLayers.Layer.MapServer.prototype =
      * Return a query string for this layer
      *
      * Parameters:
-     * bounds - {<OpenLayers.Bounds>} A bounds representing the bbox for the
+     * bounds - {<OpenLayers.Bounds>} A bounds representing the bbox 
-     *          request
+     *                                for the request
      *
      * Return:
-     * {String} A string with the layer's url and parameters and also the
+     * {String} A string with the layer's url and parameters and also 
-     * passed-in bounds and appropriate tile size specified as parameters
+     *          the passed-in bounds and appropriate tile size specified 
+     *          as parameters.
      */
     getURL: function (bounds) {
         bounds = this.adjustBounds(bounds);
@@ -136,19 +128,18 @@ OpenLayers.Layer.MapServer.prototype =
     },
     
     /** 
-    * Method: getFullRequestString
+     * Method: getFullRequestString
-    * combine the layer's url with its params and these newParams. 
+     * combine the layer's url with its params and these newParams. 
-    *   
+     *   
-    * Parameter: {Object} newParams
+     * Parameter:
-    * new parameters that should be added to the request string.
+     * newParams - {Object} New parameters that should be added to the 
-    * 
+     *                      request string.
-    * Parameter: {String} altUrl
+     * altUrl - {String} (optional) Replace the URL in the full request  
-    * optional, replace the URL in the full request string with the
+     *                              string with the provided URL.
-    * provided URL.
+     * 
-    * 
+     * Return: 
-    * Return: {String}
+     * {String} A string with the layer's url and parameters embedded in it.
-    * A string with the layer's url and parameters embedded in it.
+     */
-    */
     getFullRequestString:function(newParams, altUrl) {
         // use layer's url unless altUrl passed in
         var url = (altUrl == null) ? this.url : altUrl;
@@ -176,12 +167,13 @@ OpenLayers.Layer.MapServer.prototype =
         }
         var paramsString = OpenLayers.Util.getParameterString(allParams);
         
-        /* MapServer needs '+' seperating things like bounds/height/width.
+        // MapServer needs '+' seperating things like bounds/height/width.
-           Since typically this is URL encoded, we use a slight hack: we
+        //   Since typically this is URL encoded, we use a slight hack: we
-           depend on the list-like functionality of getParameterString to
+        //  depend on the list-like functionality of getParameterString to
-           leave ',' only in the case of list items (since otherwise it is
+        //  leave ',' only in the case of list items (since otherwise it is
-           encoded) then do a regular expression replace on the , characters
+        //  encoded) then do a regular expression replace on the , characters
-           to '+' */
+        //  to '+'
+        //
         paramsString = paramsString.replace(/,/g, "+");
         
         if (paramsString != "") {
@@ -200,7 +192,7 @@ OpenLayers.Layer.MapServer.prototype =
         }
         return requestString;
     },
-
+    
     /** @final @type String */
     CLASS_NAME: "OpenLayers.Layer.MapServer"
 });