[OpenLayers-Commits] r3595 - in trunk/openlayers/lib/OpenLayers: Control Format

[commits at openlayers.org]

Author: tschaub
Date: 2007-07-05 14:54:38 -0400 (Thu, 05 Jul 2007)
New Revision: 3595

Modified:
   trunk/openlayers/lib/OpenLayers/Control/Navigation.js
   trunk/openlayers/lib/OpenLayers/Format/GML.js
   trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js
   trunk/openlayers/lib/OpenLayers/Format/KML.js
Log:
#802 - giving all classes a constructor that don't currently have one - this for Natural Docs

Modified: trunk/openlayers/lib/OpenLayers/Control/Navigation.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Control/Navigation.js	2007-07-05 18:37:23 UTC (rev 3594)
+++ trunk/openlayers/lib/OpenLayers/Control/Navigation.js	2007-07-05 18:54:38 UTC (rev 3595)
@@ -8,7 +8,14 @@
  * @requires OpenLayers/Handler/MouseWheel.js
  * 
  * Class: OpenLayers.Control.Navigation
+ * The navigation control handles map browsing with mouse events (dragging,
+ *     double-clicking, and scrolling the wheel).  Create a new navigation 
+ *     control with the <OpenLayers.Control.Navigation> control.  
  * 
+ *     Note that this control is added to the map by default (if no controls 
+ *     array is sent in the options object to the <OpenLayers.Map> 
+ *     constructor).
+ * 
  * Inherits:
  *  - <OpenLayers.Control>
  */
@@ -35,6 +42,18 @@
     wheelHandler: null,
 
     /**
+     * Constructor: OpenLayers.Control.Navigation
+     * Create a new navigation control
+     * 
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *                    the control
+     */
+    initialize: function(options) {
+        OpenLayers.Control.prototype.initialize.apply(this, arguments);
+    },
+
+    /**
      * Method: activate
      */
     activate: function() {

Modified: trunk/openlayers/lib/OpenLayers/Format/GML.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Format/GML.js	2007-07-05 18:37:23 UTC (rev 3594)
+++ trunk/openlayers/lib/OpenLayers/Format/GML.js	2007-07-05 18:54:38 UTC (rev 3595)
@@ -9,7 +9,8 @@
  * @requires OpenLayers/Geometry.js
  *
  * Class: OpenLayers.Format.GML
- * Read/Wite GML. 
+ * Read/Wite GML. Create a new instance with the <OpenLayers.Format.GML>
+ *     constructor.
  * 
  * Inherits from:
  *  - <OpenLayers.Format>
@@ -65,7 +66,20 @@
      */
     extractAttributes: true,
     
+    
     /**
+     * Constructor: OpenLayers.Format.GML
+     * Create a new parser for GML
+     *
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *                    this instance.
+     */
+    initialize: function(options) {
+        OpenLayers.Format.prototype.initialize.apply(this, [options]);
+    },
+
+    /**
      * APIMethod: read
      * Read data from a string, and return a list of features. 
      * 

Modified: trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js	2007-07-05 18:37:23 UTC (rev 3594)
+++ trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js	2007-07-05 18:54:38 UTC (rev 3595)
@@ -6,7 +6,8 @@
  * @requires OpenLayers/Format.js
  *
  * Class: OpenLayers.Format.GeoRSS
- * Write-only GeoRSS. 
+ * Write-only GeoRSS. Create a new instance with the 
+ *     <OpenLayers.Format.GeoRSS> constructor.
  *
  * Inherits from:
  *  - <OpenLayers.Format>
@@ -33,7 +34,20 @@
      */
     georssns: "http://www.georss.org/georss",
     
+    
     /**
+     * Constructor: OpenLayers.Format.GeoRSS
+     * Create a new parser for GeoRSS
+     *
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *                    this instance.
+     */
+    initialize: function(options) {
+        OpenLayers.Format.prototype.initialize.apply(this, [options]);
+    },
+
+    /**
      * APIMethod: write
      * Accept Feature Collection, and return a string. 
      * 

Modified: trunk/openlayers/lib/OpenLayers/Format/KML.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Format/KML.js	2007-07-05 18:37:23 UTC (rev 3594)
+++ trunk/openlayers/lib/OpenLayers/Format/KML.js	2007-07-05 18:54:38 UTC (rev 3595)
@@ -9,7 +9,8 @@
  * 
  * Class: OpenLayers.Format.KML
  * Read only KML. Largely Proof of Concept: does not support advanced Features,
- * including Polygons.
+ *     including Polygons.  Create a new instance with the 
+ *     <OpenLayers.Format.KML> constructor.
  *
  * Inherits from:
  *  - <OpenLayers.Format>
@@ -25,6 +26,18 @@
     kmlns: "http://earth.google.com/kml/2.0",
     
     /**
+     * Constructor: OpenLayers.Format.KML
+     * Create a new parser for KML
+     *
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *                    this instance.
+     */
+    initialize: function(options) {
+        OpenLayers.Format.prototype.initialize.apply(this, [options]);
+    },
+
+    /**
      * APIMethod: read
      * Read data from a string, and return a list of features. 
      *