Merge all changes from the naturaldocs sandbox. This brings all the work that

has been done in the NaturalDocs branch back to trunk. Thanks to everyone who
helped out in making this happen. (I could list people, but the list would
be long, and I'm already mentally on vacation.)


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

lib/OpenLayers/Feature/WFS.js

@@ -4,19 +4,27 @@
 
 
 /**
- * @class
- * 
  * @requires OpenLayers/Feature.js
+ * 
+ * Class: OpenLayers.Feature.WFS
+ * WFS handling class, for use as a featureClass on the WFS layer for handling
+ * 'point' WFS types. Good for subclassing when creating a custom WFS like
+ * XML application.
+ * 
+ * Inherits from:
+ *  - <OpenLayers.Feature>
  */
 OpenLayers.Feature.WFS = OpenLayers.Class.create();
 OpenLayers.Feature.WFS.prototype = 
   OpenLayers.Class.inherit( OpenLayers.Feature, {
       
     /** 
-     * @constructor
-     * 
-     * @param {OpenLayers.Layer} layer
-     * @param {XMLNode} xmlNode
+     * Constructor: OpenLayers.Feature.WFS
+     * Create a WFS feature.
+     *
+     * Parameters:
+     * layer - {<OpenLayers.Layer>} 
+     * xmlNode - {XMLNode} 
      */
     initialize: function(layer, xmlNode) {
         var newArguments = arguments;
@@ -27,6 +35,10 @@ OpenLayers.Feature.WFS.prototype =
         this.layer.addMarker(this.marker);
     },
     
+    /** 
+     * Method: destroy
+     * nullify references to prevent circular references and memory leaks
+     */
     destroy: function() {
         if (this.marker != null) {
             this.layer.removeMarker(this.marker);  
@@ -35,10 +47,17 @@ OpenLayers.Feature.WFS.prototype =
     },
 
     /**
-     * @param {XMLNode} xmlNode
+     * Method: processXMLNode
+     * When passed an xmlNode, parses it for a GML point, and passes
+     * back an object describing that point.
+     *
+     * For subclasses of Feature.WFS, this is the feature to change.
+     *
+     * Parameters:
+     * xmlNode - {XMLNode} 
      * 
-     * @returns Data Object with 'id', 'lonlat', and private properties set
-     * @type Object
+     * Return:
+     * {Object} Data Object with 'id', 'lonlat', and private properties set
      */
     processXMLNode: function(xmlNode) {
         //this should be overridden by subclasses