Fix typos in documentation strings.

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

lib/OpenLayers/Ajax.js

@@ -7,27 +7,27 @@ OpenLayers.ProxyHost = "";
 //OpenLayers.ProxyHost = "examples/proxy.cgi?url=";
 
 /**
-* Ajax reader for OpenLayers
+ * Ajax reader for OpenLayers
-*
+ *
-*@uri url to do remote XML http get
+ *  @uri url to do remote XML http get
-*@param 'get' format params (x=y&a=b...)
+ *  @param {String} 'get' format params (x=y&a=b...)
-*@who object to handle callbacks for this request
+ *  @who object to handle callbacks for this request
-*@complete  the function to be called on success 
+ *  @complete  the function to be called on success 
-*@failure  the function to be called on failure
+ *  @failure  the function to be called on failure
-*
+ *  
-* example usage from a caller:
+ *   example usage from a caller:
-*
+ *  
-*   caps: function(request) {
+ *     caps: function(request) {
-*    -blah-  
+ *      -blah-  
-*   },
+ *     },
-*
+ *  
-*   OpenLayers.loadURL(url,params,this,caps);
+ *     OpenLayers.loadURL(url,params,this,caps);
-*
+ *
-* Notice the above example does not provide an error handler; a default empty
+ * Notice the above example does not provide an error handler; a default empty
-* handler is provided which merely logs the error if a failure handler is not 
+ * handler is provided which merely logs the error if a failure handler is not 
-* supplied
+ * supplied
-*
+ *
-*/
+ */
 
 
 /** 

lib/OpenLayers/Control/EditingToolbar.js

@@ -15,8 +15,8 @@ OpenLayers.Control.EditingToolbar.prototype =
 
     /**
      * Create an editing toolbar for a given layer. 
-     * @param OpenLayers.Layer.Vector layer
+     * @param {OpenLayers.Layer.Vector} layer
-     * @param Object options
+     * @param {Object} options
      */
     initialize: function(layer, options) {
         OpenLayers.Control.Panel.prototype.initialize.apply(this, [options]);

lib/OpenLayers/Control/PanZoomBar.js

@@ -163,9 +163,9 @@ OpenLayers.Control.PanZoomBar.prototype =
         return centered; 
     },
     /* 
-     * @param evt
      * This function is used to pass events that happen on the div, or the map,
      * through to the slider, which then does its moving thing.
+     * @param {OpenLayers.Event} evt
      */
     passEventToSlider:function(evt) {
         this.sliderEvents.handleBrowserEvent(evt);
@@ -185,8 +185,8 @@ OpenLayers.Control.PanZoomBar.prototype =
     },
     
     /* 
-     * @param evt
      * event listener for clicks on the slider
+     * @param {OpenLayers.Event} evt
      */
     zoomBarDown:function(evt) {
         if (!OpenLayers.Event.isLeftClick(evt)) return;
@@ -201,10 +201,10 @@ OpenLayers.Control.PanZoomBar.prototype =
     },
     
     /*
-     * @param evt
      * This is what happens when a click has occurred, and the client is dragging.
      * Here we must ensure that the slider doesn't go beyond the bottom/top of the 
      * zoombar div, as well as moving the slider to its new visual location
+     * @param {OpenLayers.Event} evt
      */
     zoomBarDrag:function(evt) {
         if (this.mouseDragStart != null) {
@@ -221,9 +221,9 @@ OpenLayers.Control.PanZoomBar.prototype =
     },
     
     /* 
-     * @param evt
+     * Perform cleanup when a mouseup event is received -- discover new zoom
-     * Perform cleanup when a mouseup event is received -- discover new zoom level
+     * level and switch to it.
-     * and switch to it.
+     * @param {OpenLayers.Event} evt
      */
     zoomBarUp:function(evt) {
         if (!OpenLayers.Event.isLeftClick(evt)) return;

lib/OpenLayers/Control/Panel.js

@@ -126,7 +126,7 @@ OpenLayers.Control.Panel.prototype =
      * To build a toolbar, you add a set of controls to it. addControls
      * lets you add a single control or a list of controls to the 
      * Control Panel.
-     * @param OpenLayers.Control
+     * @param {OpenLayers.Control} controls
      */    
     addControls: function(controls) {
         if (!(controls instanceof Array)) {

lib/OpenLayers/Format/GML.js

@@ -76,7 +76,7 @@ OpenLayers.Format.GML.prototype =
       * This function is the core of the GML parsing code in OpenLayers.
       * It creates the geometries that are then attached to the returned
       * feature, and calls parseAttributes() to get attribute data out.
-      * @param DOMElement xmlNode
+      * @param {DOMElement} xmlNode
       */
      parseFeature: function(xmlNode) {
         var geom;
@@ -181,7 +181,7 @@ OpenLayers.Format.GML.prototype =
      * recursive function parse the attributes of a GML node.
      * Searches for any child nodes which aren't geometries,
      * and gets their value.
-     * @param DOMElement xmlNode
+     * @param {DOMElement} xmlNode
      */
     parseAttributes: function(xmlNode) {
         var nodes = xmlNode.childNodes;
@@ -302,8 +302,8 @@ OpenLayers.Format.GML.prototype =
     /** 
      * Accept an OpenLayers.Feature.Vector, and build a geometry for it.
      * 
-     * @param OpenLayers.Feature.Vector feature
+     * @param {OpenLayers.Feature.Vector} feature
-     * @returns DOMElement
+     * @returns {DOMElement}
      */
     createFeatureXML: function(feature) {
         var geometryNode = this.buildGeometryNode(feature.geometry);

lib/OpenLayers/Format/GeoRSS.js

@@ -32,7 +32,7 @@ OpenLayers.Format.GeoRSS.prototype =
     /** 
      * Accept an OpenLayers.Feature.Vector, and build a geometry for it.
      * 
-     * @param OpenLayers.Feature.Vector feature
+     * @param {OpenLayers.Feature.Vector} feature
      * @returns DOMElement
      */
     createFeatureXML: function(feature) {

lib/OpenLayers/Format/KML.js

@@ -46,7 +46,7 @@ OpenLayers.Format.KML.prototype =
       * This function is the core of the KML parsing code in OpenLayers.
       * It creates the geometries that are then attached to the returned
       * feature, and calls parseAttributes() to get attribute data out.
-      * @param DOMElement xmlNode
+      * @param {DOMElement} xmlNode
       */
      parseFeature: function(xmlNode) {
         var geom;
@@ -90,7 +90,7 @@ OpenLayers.Format.KML.prototype =
      * recursive function parse the attributes of a KML node.
      * Searches for any child nodes which aren't geometries,
      * and gets their value.
-     * @param DOMElement xmlNode
+     * @param {DOMElement} xmlNode
      */
     parseAttributes: function(xmlNode) {
         var nodes = xmlNode.childNodes;

lib/OpenLayers/Format/WFS.js

@@ -21,7 +21,7 @@ OpenLayers.Format.WFS.prototype =
      * only, which uses most of the code from the GML layer, and wraps
      * it in transactional elements.
      * @param {Object} options 
-     * @param OpenLayers.Layer layer
+     * @param {OpenLayers.Layer} layer
      */
     
     initialize: function(options, layer) {
@@ -42,7 +42,7 @@ OpenLayers.Format.WFS.prototype =
      * write 
      * Takes a feature list, and generates a WFS-T Transaction 
      *
-     * @param Array 
+     * @param {Array} 
      */
     write: function(features) {
         
@@ -88,7 +88,7 @@ OpenLayers.Format.WFS.prototype =
      * insert 
      * Takes a feature, and generates a WFS-T Transaction "Insert" 
      *
-     * @param OpenLayers.Feature.Vector
+     * @param {OpenLayers.Feature.Vector} feature
      */
     insert: function(feature) {
         var insertNode = document.createElementNS(this.wfsns, 'wfs:Insert');
@@ -100,7 +100,7 @@ OpenLayers.Format.WFS.prototype =
      * update
      * Takes a feature, and generates a WFS-T Transaction "Update" 
      *
-     * @param OpenLayers.Feature.Vector
+     * @param {OpenLayers.Feature.Vector} feature
      */
     update: function(feature) {
         if (!feature.fid) { alert("Can't update a feature for which there is no FID."); }
@@ -133,7 +133,7 @@ OpenLayers.Format.WFS.prototype =
      * delete
      * Takes a feature, and generates a WFS-T Transaction "Delete" 
      *
-     * @param OpenLayers.Feature.Vector
+     * @param {OpenLayers.Feature.Vector} feature
      */
     remove: function(feature) {
         if (!feature.attributes.fid) { 

lib/OpenLayers/Layer.js

@@ -140,9 +140,10 @@ OpenLayers.Layer.prototype = {
     /** @type Boolean */
     displayOutsideMaxExtent: false,
 
-    /** wrapDateLine -- #487 for more info.   
+    /** 
+     * wrapDateLine -- #487 for more info.   
      * 
-     * @type @Boolean 
+     * @type Boolean 
      */
     wrapDateLine: false,
     
@@ -309,7 +310,7 @@ OpenLayers.Layer.prototype = {
      * Set the tile size based on the map size.  This also sets layer.imageSize
      * and layer.imageOffset for use by Tile.Image.
      *
-     * @param OpenLayers.Size
+     * @param {OpenLayers.Size}
      */
     setTileSize: function(size) {
         var tileSize = (size) ? size :

lib/OpenLayers/Layer/Vector.js

@@ -313,7 +313,7 @@ OpenLayers.Layer.Vector.prototype =
     /**
      * Given a feature id, return the feature if it exists in the features array
      * 
-     * @param String featureId
+     * @param {String} featureId
      * @type OpenLayers.Feature.Vector
      * @return A feature corresponding to the given featureId
      */