ND Update: make array's say what they're made of, and a few other small bits, like mistyped and a couple missing <>s

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

lib/OpenLayers/BaseTypes/Bounds.js

@@ -480,7 +480,7 @@ OpenLayers.Bounds.fromString = function(str) {
  *     from an array
  * 
  * Parameters:
- * bbox - {Array} Array of bounds values (ex. <i>[5,42,10,45]</i>)
+ * bbox - {Array(Float)} Array of bounds values (ex. <i>[5,42,10,45]</i>)
  *
  * Return:
  * {<OpenLayers.Bounds>} New <OpenLayers.Bounds> object built from the 

lib/OpenLayers/Control/ArgParser.js

@@ -27,7 +27,7 @@ OpenLayers.Control.ArgParser = OpenLayers.Class(OpenLayers.Control, {
 
     /**
      * Parameter: layers 
-     * {Array}
+     * {Array(<OpenLayers.Layer>)}
      */
     layers: null,
 

lib/OpenLayers/Control/LayerSwitcher.js

@@ -34,7 +34,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
 
     /** 
      * Property: baseLayers
-     * {Array}
+     * {Array(<OpenLayers.Layer>)}
      */
     baseLayers: null,
     
@@ -53,7 +53,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
 
     /** 
      * Property: dataLayers
-     * {Array} 
+     * {Array(<OpenLayers.Layer>)} 
      */
     dataLayers: null,
 

lib/OpenLayers/Events.js

@@ -337,7 +337,7 @@ OpenLayers.Events = OpenLayers.Class({
 
     /** 
      * Constant: BROWSER_EVENTS
-     * {Array} supported events 
+     * {Array(String)} supported events 
      */
     BROWSER_EVENTS: [
         "mouseover", "mouseout",
@@ -366,7 +366,7 @@ OpenLayers.Events = OpenLayers.Class({
 
     /** 
      * Property: eventTypes 
-     * {Array}  list of support application events 
+     * {Array(String)}  list of support application events 
      */
     eventTypes: null,
 
@@ -389,7 +389,7 @@ OpenLayers.Events = OpenLayers.Class({
      * Parameters:
      * object - {Object} The js object to which this Events object  is being
      * added element - {DOMElement} A dom element to respond to browser events
-     * eventTypes - {Array} Array of custom application events 
+     * eventTypes - {Array(String)} Array of custom application events 
      * fallThrough - {Boolean} Allow events to fall through after these have
      *                         been handled?
      */

lib/OpenLayers/Format/WFS.js

@@ -52,7 +52,7 @@ OpenLayers.Format.WFS = OpenLayers.Class(OpenLayers.Format.GML, {
      * Takes a feature list, and generates a WFS-T Transaction 
      *
      * Parameters:
-     * features - {Array} 
+     * features - {Array(<OpenLayers.Feature.Vector>)} 
      */
     write: function(features) {
         

lib/OpenLayers/Geometry/Collection.js

@@ -250,7 +250,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
      * Parameters:
      * angle - {Float} Rotation angle in radians (measured counterclockwise
      *                 from the positive x-axis)
-     * origin - {OpenLayers.Geometry.Point} Center point for the rotation
+     * origin - {<OpenLayers.Geometry.Point>} Center point for the rotation
      */
     rotate: function(angle, origin) {
         for(var i=0; i<this.components.length; ++i) {
@@ -268,7 +268,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
      *                 doubles the size of the geometry in each dimension
      *                 (lines, for example, will be twice as long, and polygons
      *                 will have four times the area).
-     * origin - {OpenLayers.Geometry.Point} Point of origin for resizing
+     * origin - {<OpenLayers.Geometry.Point>} Point of origin for resizing
      */
     resize: function(scale, origin) {
         for(var i=0; i<this.components.length; ++i) {

lib/OpenLayers/Geometry/MultiLineString.js

@@ -29,7 +29,7 @@ OpenLayers.Geometry.MultiLineString = OpenLayers.Class(
      * Constructor for a MultiLineString Geometry.
      *
      * Parameters: 
-     * components - {Array(OpenLayers.Geometry.LineString)} 
+     * components - {Array(<OpenLayers.Geometry.LineString>)} 
      *
      */
     initialize: function(components) {

lib/OpenLayers/Geometry/Point.js

@@ -137,7 +137,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
      * Parameters:
      * angle - {Float} Rotation angle in radians (measured counterclockwise
      *                 from the positive x-axis)
-     * origin - {OpenLayers.Geometry.Point} Center point for the rotation
+     * origin - {<OpenLayers.Geometry.Point>} Center point for the rotation
      */
     rotate: function(angle, origin) {
         var radius = this.distanceTo(origin);
@@ -156,7 +156,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
      * scale - {Float} Ratio of the new distance from the origin to the old
      *                 distance from the origin.  A scale of 2 doubles the
      *                 distance between the point and origin.
-     * origin - {OpenLayers.Geometry.Point} Point of origin for resizing
+     * origin - {<OpenLayers.Geometry.Point>} Point of origin for resizing
      */
     resize: function(scale, origin) {
         this.x = origin.x + (scale * (this.x - origin.x));

lib/OpenLayers/Handler.js

@@ -183,8 +183,8 @@ OpenLayers.Handler = OpenLayers.Class({
     * Parameters:
     * name - {String} The key for the callback that is one of the properties
     *     of the handler's callbacks object.
-    * args - {Array} An array of arguments with which to call the callback
+    * args - {Array(*)} An array of arguments (any type) with which to call 
-    *     (defined by the control).
+    *     the callback (defined by the control).
     */
     callback: function (name, args) {
         if (this.callbacks[name]) {

lib/OpenLayers/Handler/Feature.js

@@ -30,11 +30,10 @@ OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
      *
      * Parameters:
      * control - {<OpenLayers.Control>} 
-     * layers - {Array} List of OpenLayers.Layer.Vector
+     * layers - {Array(<OpenLayers.Layer.Vector>)}
-     * callbacks - {Array} An object with a 'over' property whos value is
+     * callbacks - {Object} An object with a 'over' property whos value is
-     *                          a function to be called when the mouse is over
+     *     a function to be called when the mouse is over a feature. The 
-     *                          a feature. The callback should expect to recieve
+     *     callback should expect to recieve a single argument, the feature.
-     *                          a single argument, the feature.
      * options - {Object} 
      */
     initialize: function(control, layer, callbacks, options) {

lib/OpenLayers/Handler/Path.js

@@ -47,14 +47,14 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
      *
      * Parameters:
      * control - {<OpenLayers.Control>} 
-     * callbacks - {Array} An object with a 'done' property whos value is a
+     * callbacks - {Object} An object with a 'done' property whos value is a
-     *   function to be called when the path drawing is finished. The callback
+     *     function to be called when the path drawing is finished. The 
-     *   should expect to recieve a single argument, the line string geometry.
+     *     callback should expect to recieve a single argument, the line 
-     *   If the callbacks object contains a 'point' property, this function will
+     *     string geometry. If the callbacks object contains a 'point' 
-     *   be sent each point as they are added.  If the callbacks object contains
+     *     property, this function will be sent each point as they are added.  
-     *   a 'cancel' property, this function will be called when the handler is
+     *     If the callbacks object contains a 'cancel' property, this function 
-     *   deactivated while drawing.  The cancel should expect to receive a
+     *     will be called when the handler is deactivated while drawing. The 
-     *   geometry.
+     *     cancel should expect to receive a geometry.
      * options - {Object} An optional object with properties to be set on the
      *           handler
      */

lib/OpenLayers/Handler/Point.js

@@ -60,7 +60,7 @@ OpenLayers.Handler.Point = OpenLayers.Class(OpenLayers.Handler, {
      *
      * Parameters:
      * control - {<OpenLayers.Control>} The control that owns this handler
-     * callbacks - {Array} An object with a 'done' property whos value is a
+     * callbacks - {Object} An object with a 'done' property whos value is a
      *             function to be called when the point drawing is finished.
      *             The callback should expect to recieve a single argument,
      *             the point geometry.  If the callbacks object contains a

lib/OpenLayers/Handler/Polygon.js

@@ -29,7 +29,7 @@ OpenLayers.Handler.Polygon = OpenLayers.Class(OpenLayers.Handler.Path, {
      *
      * Parameters:
      * control - {<OpenLayers.Control>} 
-     * callbacks - {Array} An object with a 'done' property whos value is
+     * callbacks - {Object} An object with a 'done' property whos value is
      *                          a function to be called when the path drawing is
      *                          finished. The callback should expect to recieve a
      *                          single argument, the polygon geometry.

lib/OpenLayers/Layer/Grid.js

@@ -23,7 +23,8 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
     
     /**
      * Property: grid
-     * {Array} This is an array of rows, each row is an array of tiles
+     * {Array(Array(<OpenLayers.Tile>))} This is an array of rows, each row is 
+     *     an array of tiles.
      */
     grid: null,
 

lib/OpenLayers/Layer/TileCache.js

@@ -88,7 +88,7 @@ OpenLayers.Layer.TileCache = OpenLayers.Class(OpenLayers.Layer.Grid, {
      * Method: getURL
      *
      * Parameters:
-     * bounds - {OpenLayers.Bounds} 
+     * bounds - {<OpenLayers.Bounds>} 
      * 
      * Returns:
      * A string with the layer's url and parameters and also the 

lib/OpenLayers/Layer/Vector.js

@@ -343,7 +343,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
      * Erase features from the layer.
      *
      * Parameters:
-     * features - {Array(OpenLayers.Feature.Vector)} 
+     * features - {Array(<OpenLayers.Feature.Vector>)} 
      */
     eraseFeatures: function(features) {
         this.renderer.eraseFeatures(features);

lib/OpenLayers/Map.js

@@ -25,7 +25,7 @@ OpenLayers.Map = OpenLayers.Class({
 
     /**
      * Constant: EVENT_TYPES
-     * {Array} supported application event types
+     * {Array(String)} supported application event types
      */
     EVENT_TYPES: [ 
         "addlayer", "removelayer", "changelayer", "movestart", "move", 
@@ -155,10 +155,10 @@ OpenLayers.Map = OpenLayers.Class({
 
     /**
      * APIProperty: resolutions
-     * {Array} A list of map resolutions (map units per pixel) in descending
+     * {Array(Float)} A list of map resolutions (map units per pixel) in 
-     * order.  If this is not set in the layer constructor, it will be set
+     *     descending order.  If this is not set in the layer constructor, it 
-     * based on other resolution related properties (maxExtent, maxResolution,
+     *     will be set based on other resolution related properties 
-     * maxScale, etc.).
+     *     (maxExtent, maxResolution, maxScale, etc.).
      */
     resolutions: null,
 

lib/OpenLayers/Renderer/SVG.js

@@ -510,7 +510,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
      * Method: getComponentString
      * 
      * Parameters:
-     * components - {Array} Array of points
+     * components - {Array(<OpenLayers.Geometry.Point)} Array of points
      */
     getComponentsString: function(components) {
         var strings = [];

lib/Rico/Corner.js

@@ -92,7 +92,7 @@ OpenLayers.Rico.Corner = {
     * @param {DOM} theDiv - A child of the outer <div> that was
     *                        supplied to the `round` method.
     *
-    * @param {Array} options - list of options
+    * @param {Object} options - list of options
     */
     reRound: function(theDiv, options) {