JSDOC coding standards

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

lib/OpenLayers/Layer/WFS.js

@@ -1,43 +1,55 @@
+/**
+* @class
+*/
 OpenLayers.Layer.WFS = Class.create();
 OpenLayers.Layer.WFS.prototype = 
   Object.extend( new OpenLayers.Layer.Grid(), {
 
-    // hash
-    DEFAULT_PARAMS: {
-        service: "WFS",
-        version: "1.0.0",
-        request: "GetFeature",
-    },
+    /** @final @type hash */
+    DEFAULT_PARAMS: { service: "WFS",
+                      version: "1.0.0",
+                      request: "GetFeature",
+                     },
 
     /**
+    * @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 = {}
         Object.extend(mergedParams, this.params);
         Object.extend(mergedParams, params);
         var obj = new OpenLayers.Layer.WFS(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) {
+    addTile:function(bounds, position) {
         url = this.getFullRequestString(
                      {bbox:bounds.toBBOX(),
                       width:this.tileSize.w,
@@ -49,7 +61,9 @@ OpenLayers.Layer.WFS.prototype =
         return tile;
     },
 
-    _initTiles: function () {
+    /** clear out the layer's main div
+    */
+    _initTiles: function() {
         this.div.innerHTML="";
         OpenLayers.Layer.Grid.prototype._initTiles.apply(this, arguments);
     },