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/Layer/GeoRSS.js

@@ -4,33 +4,52 @@
 
 
 /**
- * @class
- * 
  * @requires OpenLayers/Layer/Markers.js
  * @requires OpenLayers/Ajax.js
+ * 
+ * Class: OpenLayers.Layer.GeoRSS
+ * Add GeoRSS Point features to your map. 
+ * 
+ * Inherits from:
+ *  - <OpenLayers.Layer.Markers>
+ *  - <OpenLayers.Layer>
  */
 OpenLayers.Layer.GeoRSS = OpenLayers.Class.create();
 OpenLayers.Layer.GeoRSS.prototype = 
   OpenLayers.Class.inherit( OpenLayers.Layer.Markers, {
 
-    /** store url of text file
-    * @type str */
-    location:null,
+    /** 
+	 * Property: location 
+	 * {String} store url of text file 
+	 */
+	location: null,
 
-    /** @type Array(OpenLayers.Feature) */
-    features: null,
+    /** 
+	 * Property: features 
+	 * Array({<OpenLayers.Feature>}) 
+	 */
+	features: null,
 
-    /** @type OpenLayers.Feature */
-    selectedFeature: null,
+    /** 
+	 * Property: selectedFeature 
+	 * {<OpenLayers.Feature>} 
+	 */
+	selectedFeature: null,
 
-	/**@type OpenLayers.Icon */
+	/** 
+	 * Property: icon 
+	 * {<OpenLayers.Icon>} 
+	 */
 	icon: null,
 	
     /**
-    * @constructor
+    * Constructor: OpenLayers.Layer.GeoRSS
+    * Create a GeoRSS Layer.
     *
-    * @param {String} name
-    * @param {String} location
+    * Parameters:
+    * name - {String} 
+    * location - {String} 
+    * options - {Object}
     */
     initialize: function(name, location, options) {
         OpenLayers.Layer.Markers.prototype.initialize.apply(this, [name, options]);
@@ -40,7 +59,7 @@ OpenLayers.Layer.GeoRSS.prototype =
     },
 
     /**
-     * 
+     * Method: destroy 
      */
     destroy: function() {
         this.clearFeatures();
@@ -49,7 +68,11 @@ OpenLayers.Layer.GeoRSS.prototype =
     },
         
     /**
-     * @param {XMLHttpRequest} ajaxRequest
+     * Method: parseData
+     * Parse the data returned from the Events call.
+     *
+     * Parameters:
+     * ajaxRequest - {XMLHttpRequest} 
      */
     parseData: function(ajaxRequest) {
         var doc = ajaxRequest.responseXML;
@@ -171,7 +194,10 @@ OpenLayers.Layer.GeoRSS.prototype =
     },
     
     /**
-     * @param {Event} evt
+     * Method: markerClick
+     *
+     * Parameters:
+     * evt - {Event} 
      */
     markerClick: function(evt) {
         sameMarkerClicked = (this == this.layer.selectedFeature);
@@ -193,7 +219,8 @@ OpenLayers.Layer.GeoRSS.prototype =
     },
 
     /**
-     * 
+     * Method: clearFeatures
+     * Destroy all features in this layer.
      */
     clearFeatures: function() {
         if (this.features != null) {
@@ -208,5 +235,3 @@ OpenLayers.Layer.GeoRSS.prototype =
     /** @final @type String */
     CLASS_NAME: "OpenLayers.Layer.GeoRSS"
 });
-     
-