Merge pull request #132 from jorix/Docs-issues

Docs issues

lib/OpenLayers/Control/KeyboardDefaults.js

@@ -59,7 +59,7 @@ OpenLayers.Control.KeyboardDefaults = OpenLayers.Class(OpenLayers.Control, {
      *    http://unixpapa.com/js/key.html
      *
      * Parameters:
-     * code - {Integer} 
+     * evt - {Event} 
      */
     defaultKeyPress: function (evt) {
         switch(evt.keyCode) {

lib/OpenLayers/Control/LayerSwitcher.js

@@ -68,7 +68,7 @@ OpenLayers.Control.LayerSwitcher =
 
     /** 
      * Property: baseLayers
-     * {Array(<OpenLayers.Layer>)}
+     * {Array(Object)}
      */
     baseLayers: null,
     
@@ -87,7 +87,7 @@ OpenLayers.Control.LayerSwitcher =
 
     /** 
      * Property: dataLayers
-     * {Array(<OpenLayers.Layer>)} 
+     * {Array(Object)} 
      */
     dataLayers: null,
 
@@ -372,10 +372,13 @@ OpenLayers.Control.LayerSwitcher =
      * Parameters:
      * e - {Event} 
      *
-     * Context:  
+     * Context: 
-     *  - {DOMElement} inputElem
+     * - {Object}
-     *  - {<OpenLayers.Control.LayerSwitcher>} layerSwitcher
+     *
-     *  - {<OpenLayers.Layer>} layer
+     * Object structure:
+     *  inputElem - {DOMElement} 
+     *  layerSwitcher - {<OpenLayers.Control.LayerSwitcher>} 
+     *  layer - {<OpenLayers.Layer>} 
      */
 
     onInputClick: function(e) {

lib/OpenLayers/Control/OverviewMap.js

@@ -132,7 +132,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
      * Create a new overview map
      *
      * Parameters:
-     * object - {Object} Properties of this object will be set on the overview
+     * options - {Object} Properties of this object will be set on the overview
      * map object.  Note, to set options on the map object contained in this
      * control, set <mapOptions> as one of the options properties.
      */

lib/OpenLayers/Control/PanZoomBar.js

@@ -190,7 +190,7 @@ OpenLayers.Control.PanZoomBar = OpenLayers.Class(OpenLayers.Control.PanZoom, {
     * Method: _addZoomBar
     * 
     * Parameters:
-    * location - {<OpenLayers.Pixel>} where zoombar drawing is to start.
+    * centered - {<OpenLayers.Pixel>} where zoombar drawing is to start.
     */
     _addZoomBar:function(centered) {
         var imgLocation = OpenLayers.Util.getImageLocation("slider.png");

lib/OpenLayers/Control/SLDSelect.js

@@ -183,6 +183,9 @@ OpenLayers.Control.SLDSelect = OpenLayers.Class(OpenLayers.Control, {
      *     layer visibility. So if the source layer is turned off, the
      *     selection layer is also turned off.
      *
+     * Context: 
+     * - {<OpenLayers.Layer>}
+     *
      * Parameters:
      * evt - {Object}
      */

lib/OpenLayers/Feature/Vector.js

@@ -297,7 +297,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
      * Moves the feature and redraws it at its new location
      *
      * Parameters:
-     * state - {OpenLayers.LonLat or OpenLayers.Pixel} the
+     * location - {<OpenLayers.LonLat> or <OpenLayers.Pixel>} the
      *         location to which to move the feature.
      */
     move: function(location) {

lib/OpenLayers/Filter/Comparison.js

@@ -11,7 +11,7 @@
  * Class: OpenLayers.Filter.Comparison
  * This class represents a comparison filter.
  * 
- * Inherits from
+ * Inherits from:
  * - <OpenLayers.Filter>
  */
 OpenLayers.Filter.Comparison = OpenLayers.Class(OpenLayers.Filter, {

lib/OpenLayers/Filter/FeatureId.js

@@ -13,7 +13,7 @@
  * This class represents a ogc:FeatureId Filter, as being used for rule-based SLD
  * styling
  * 
- * Inherits from
+ * Inherits from:
  * - <OpenLayers.Filter>
  */
 OpenLayers.Filter.FeatureId = OpenLayers.Class(OpenLayers.Filter, {

lib/OpenLayers/Filter/Function.js

@@ -14,7 +14,7 @@
  * filters that can contain filter functions as values.
  * Nesting function as other functions parameter is supported.
  * 
- * Inherits from
+ * Inherits from:
  * - <OpenLayers.Filter>
  */
 OpenLayers.Filter.Function = OpenLayers.Class(OpenLayers.Filter, {

lib/OpenLayers/Filter/Logical.js

@@ -12,7 +12,7 @@
  * Class: OpenLayers.Filter.Logical
  * This class represents ogc:And, ogc:Or and ogc:Not rules.
  * 
- * Inherits from
+ * Inherits from:
  * - <OpenLayers.Filter>
  */
 OpenLayers.Filter.Logical = OpenLayers.Class(OpenLayers.Filter, {

lib/OpenLayers/Filter/Spatial.js

@@ -12,7 +12,7 @@
  * This class represents a spatial filter.
  * Currently implemented: BBOX, DWithin and Intersects
  * 
- * Inherits from
+ * Inherits from:
  * - <OpenLayers.Filter>
  */
 OpenLayers.Filter.Spatial = OpenLayers.Class(OpenLayers.Filter, {

lib/OpenLayers/Format/ArcXML.js

@@ -17,7 +17,7 @@
  *     constructor.
  * 
  * Inherits from:
- *  - <OpenLayers.Format>
+ *  - <OpenLayers.Format.XML>
  */
 OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
 
@@ -135,7 +135,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
      *
      * Parameters:
      * imsize - {Object} An ArcXML imagesize object.
-     * olsize - {OpenLayers.Size} The image size to set.
+     * olsize - {<OpenLayers.Size>} The image size to set.
      */
     addImageSize: function(imsize, olsize) {
         if (olsize !== null) {
@@ -152,7 +152,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
      *
      * Parameters:
      * featOrFilt - {Object} A featurecoordsys or filtercoordsys ArcXML structure.
-     * fsys - {String} or {OpenLayers.Projection} or {filtercoordsys} or 
+     * fsys - {String} or {<OpenLayers.Projection>} or {filtercoordsys} or 
      * {featurecoordsys} A projection representation. If it's a {String}, 
      * the value is assumed to be the SRID.  If it's a {OpenLayers.Projection} 
      * AND Proj4js is available, the projection number and name are extracted 
@@ -873,7 +873,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
      * node - {<DOMElement>} An element to parse <COORDS> or <POINT> arcxml data from.
      *
      * Returns:
-     * {OpenLayers.Geometry.LinearRing} A linear ring represented by the node's points.
+     * {<OpenLayers.Geometry.LinearRing>} A linear ring represented by the node's points.
      */
     parsePointGeometry: function(node) {
         var ringPoints = [];

lib/OpenLayers/Format/Atom.js

@@ -76,7 +76,7 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
      * doc - {Element} or {String}
      *
      * Returns:
-     * An Array of <OpenLayers.Feature.Vector>s
+     * Array({<OpenLayers.Feature.Vector>})
      */
     read: function(doc) {
         if (typeof doc == "string") {
@@ -90,8 +90,7 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
      * Serialize or more feature nodes to Atom documents.
      *
      * Parameters:
-     * features - a single {<OpenLayers.Feature.Vector>} or an
+     * features - {<OpenLayers.Feature.Vector>} or Array({<OpenLayers.Feature.Vector>})
-     * Array({<OpenLayers.Feature.Vector>}).
      *
      * Returns:
      * {String} an Atom entry document if passed one feature node, or a feed

lib/OpenLayers/Format/Context.js

@@ -10,6 +10,9 @@
 /**
  * Class: OpenLayers.Format.Context
  * Base class for both Format.WMC and Format.OWSContext
+ *
+ * Inherits from:
+ *  - <OpenLayers.Format.XML.VersionedOGC>
  */
 OpenLayers.Format.Context = OpenLayers.Class(OpenLayers.Format.XML.VersionedOGC, {
 

lib/OpenLayers/Format/Filter/v1_1_0.js

@@ -19,7 +19,8 @@
  *  - writes matchCase attribute from comparison filters of type EQUAL_TO,
  *        NOT_EQUAL_TO and LIKE.
  * 
- * Inherits from:
+ * Inherits from: 
+ *  - <OpenLayers.Format.GML.v3>
  *  - <OpenLayers.Format.Filter.v1>
  */
 OpenLayers.Format.Filter.v1_1_0 = OpenLayers.Class(

lib/OpenLayers/Format/GML.js

@@ -20,11 +20,11 @@
  *     constructor.  Supports the GML simple features profile.
  * 
  * Inherits from:
- *  - <OpenLayers.Format>
+ *  - <OpenLayers.Format.XML>
  */
 OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, {
     
-    /*
+    /**
      * APIProperty: featureNS
      * {String} Namespace used for feature attributes.  Default is
      *     "http://mapserver.gis.umn.edu/mapserver".
@@ -38,13 +38,13 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, {
      */
     featurePrefix: "feature",
     
-    /*
+    /**
      * APIProperty: featureName
      * {String} Element name for features. Default is "featureMember".
      */
     featureName: "featureMember", 
     
-    /*
+    /**
      * APIProperty: layerName
      * {String} Name of data layer. Default is "features".
      */

lib/OpenLayers/Format/GPX.js

@@ -281,7 +281,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
      *
      * Parameters:
      * trknode
-     * geometry - {OpenLayers.Geometry}
+     * geometry - {<OpenLayers.Geometry>}
      */
     buildTrkSegNode: function(geometry) {
         var node,
@@ -311,7 +311,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
      * Builds a trkpt node given a point 
      *
      * Parameters:
-     * line - {OpenLayers.Geometry.Point}
+     * point - {<OpenLayers.Geometry.Point>}
      *
      * Returns:
      * {DOMElement} A trkpt node
@@ -328,7 +328,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
      * Builds a wpt node given a point
      *
      * Parameters:
-     * feature - {OpenLayers.Feature.Vector}
+     * feature - {<OpenLayers.Feature.Vector>}
      *
      * Returns:
      * {DOMElement} A wpt node
@@ -347,7 +347,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
      *
      * Parameters:
      * node - {DOMElement} the node to append the attribute nodes to.
-     * feature - {OpenLayers.Feature.Vector}
+     * feature - {<OpenLayers.Feature.Vector>}
      */
     appendAttributesNode: function(node, feature) {
         var name = this.createElementNS(this.gpxns, 'name');

lib/OpenLayers/Format/GeoJSON.js

@@ -635,7 +635,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
          * Return an array of linestring arrays from a linestring.
          * 
          * Parameters:
-         * linestring - {<OpenLayers.Geometry.MultiLineString>}
+         * multilinestring - {<OpenLayers.Geometry.MultiLineString>}
          * 
          * Returns:
          * {Array} An array of linestring arrays representing

lib/OpenLayers/Format/OSM.js

@@ -87,7 +87,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
      * Return a list of features from a OSM doc
      
      * Parameters:
-     * data - {Element} 
+     * doc - {Element} 
      *
      * Returns:
      * An Array of <OpenLayers.Feature.Vector>s
@@ -176,7 +176,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
      * Return the node items from a doc.  
      *
      * Parameters:
-     * node - {DOMElement} node to parse tags from
+     * doc - {DOMElement} node to parse tags from
      */
     getNodes: function(doc) {
         var node_list = doc.getElementsByTagName("node");
@@ -198,7 +198,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
      * Return the way items from a doc.  
      *
      * Parameters:
-     * node - {DOMElement} node to parse tags from
+     * doc - {DOMElement} node to parse tags from
      */
     getWays: function(doc) {
         var way_list = doc.getElementsByTagName("way");
@@ -229,7 +229,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
      * Return the tags list attached to a specific DOM element.
      *
      * Parameters:
-     * node - {DOMElement} node to parse tags from
+     * dom_node - {DOMElement} node to parse tags from
      * interesting_tags - {Boolean} whether the return from this function should
      *    return a boolean indicating that it has 'interesting tags' -- 
      *    tags like attribution and source are ignored. (To change the list

lib/OpenLayers/Format/OWSCommon/v1.js

@@ -10,6 +10,9 @@
 /**
  * Class: OpenLayers.Format.OWSCommon.v1
  * Common readers and writers for OWSCommon v1.X formats
+ *
+ * Inherits from:
+ *  - <OpenLayers.Format.XML>
  */
 OpenLayers.Format.OWSCommon.v1 = OpenLayers.Class(OpenLayers.Format.XML, {
    

lib/OpenLayers/Format/OWSCommon/v1_0_0.js

@@ -10,6 +10,9 @@
 /**
  * Class: OpenLayers.Format.OWSCommon.v1_0_0
  * Parser for OWS Common version 1.0.0.
+ *
+ * Inherits from:
+ *  - <OpenLayers.Format.OWSCommon.v1>
  */
 OpenLayers.Format.OWSCommon.v1_0_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, {
     

lib/OpenLayers/Format/OWSCommon/v1_1_0.js

@@ -10,6 +10,9 @@
 /**
  * Class: OpenLayers.Format.OWSCommon.v1_1_0
  * Parser for OWS Common version 1.1.0.
+ *
+ * Inherits from:
+ *  - <OpenLayers.Format.OWSCommon.v1>
  */
 OpenLayers.Format.OWSCommon.v1_1_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, {
 

lib/OpenLayers/Format/OWSContext.js

@@ -15,6 +15,9 @@
  * Web Map Context (WMC), since it is more generic and more types of layers
  * can be stored. Also, nesting of layers is supported since version 0.3.1.
  * For more information see: http://www.ogcnetwork.net/context
+ *
+ * Inherits from:
+ *  - <OpenLayers.Format.Context>
  */
 OpenLayers.Format.OWSContext = OpenLayers.Class(OpenLayers.Format.Context,{
     

lib/OpenLayers/Format/OWSContext/v0_3_1.js

@@ -228,7 +228,7 @@ OpenLayers.Format.OWSContext.v0_3_1 = OpenLayers.Class(OpenLayers.Format.XML, {
      *
      * Parameters:
      * layerArray - {Array({Object})} Array of layerContext objects
-     * layerContext - {Object} layerContext object
+     * layer - {Object} layerContext object
      */
     processLayer: function(layerArray, layer) {
         if (layer.layersContext) {

lib/OpenLayers/Format/Text.js

@@ -69,7 +69,7 @@ OpenLayers.Format.Text = OpenLayers.Class(OpenLayers.Format, {
      * Return a list of features from a Tab Seperated Values text string.
      * 
      * Parameters:
-     * data - {String} 
+     * text - {String} 
      *
      * Returns:
      * An Array of <OpenLayers.Feature.Vector>s

lib/OpenLayers/Format/WFS.js

@@ -20,20 +20,23 @@ OpenLayers.Format.WFS = OpenLayers.Class(OpenLayers.Format.GML, {
     
     /** 
      * Property: layer
+     * {<OpenLayers.Layer>}
      */
     layer: null,
     
     /**
      * APIProperty: wfsns
+     * {String}
      */
     wfsns: "http://www.opengis.net/wfs",
     
     /**
      * Property: ogcns
+     * {String}
      */
     ogcns: "http://www.opengis.net/ogc",
     
-    /*
+    /**
      * Constructor: OpenLayers.Format.WFS
      * Create a WFS-T formatter. This requires a layer: that layer should
      * have two properties: geometry_column and typename. The parser
@@ -45,7 +48,6 @@ OpenLayers.Format.WFS = OpenLayers.Class(OpenLayers.Format.GML, {
      * options - {Object} 
      * layer - {<OpenLayers.Layer>} 
      */
-    
     initialize: function(options, layer) {
         OpenLayers.Format.GML.prototype.initialize.apply(this, [options]);
         this.layer = layer;

lib/OpenLayers/Format/WKT.js

@@ -270,7 +270,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
 
         /**
          * Return a multipoint feature given a multipoint WKT fragment.
-         * @param {String} A WKT fragment representing the multipoint
+         * @param {String} str A WKT fragment representing the multipoint
          * @returns {OpenLayers.Feature.Vector} A multipoint feature
          * @private
          */
@@ -289,7 +289,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
         
         /**
          * Return a linestring feature given a linestring WKT fragment.
-         * @param {String} A WKT fragment representing the linestring
+         * @param {String} str A WKT fragment representing the linestring
          * @returns {OpenLayers.Feature.Vector} A linestring feature
          * @private
          */
@@ -306,7 +306,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
 
         /**
          * Return a multilinestring feature given a multilinestring WKT fragment.
-         * @param {String} A WKT fragment representing the multilinestring
+         * @param {String} str A WKT fragment representing the multilinestring
          * @returns {OpenLayers.Feature.Vector} A multilinestring feature
          * @private
          */
@@ -325,7 +325,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
         
         /**
          * Return a polygon feature given a polygon WKT fragment.
-         * @param {String} A WKT fragment representing the polygon
+         * @param {String} str A WKT fragment representing the polygon
          * @returns {OpenLayers.Feature.Vector} A polygon feature
          * @private
          */
@@ -346,7 +346,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
 
         /**
          * Return a multipolygon feature given a multipolygon WKT fragment.
-         * @param {String} A WKT fragment representing the multipolygon
+         * @param {String} str A WKT fragment representing the multipolygon
          * @returns {OpenLayers.Feature.Vector} A multipolygon feature
          * @private
          */
@@ -365,7 +365,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
 
         /**
          * Return an array of features given a geometrycollection WKT fragment.
-         * @param {String} A WKT fragment representing the geometrycollection
+         * @param {String} str A WKT fragment representing the geometrycollection
          * @returns {Array} An array of OpenLayers.Feature.Vector
          * @private
          */

lib/OpenLayers/Format/WMC.js

@@ -13,7 +13,7 @@
  * Read and write Web Map Context documents.
  *
  * Inherits from:
- *  - <OpenLayers.Format.XML>
+ *  - <OpenLayers.Format.Context>
  */
 OpenLayers.Format.WMC = OpenLayers.Class(OpenLayers.Format.Context, {
     
@@ -37,7 +37,7 @@ OpenLayers.Format.WMC = OpenLayers.Class(OpenLayers.Format.Context, {
      * Create a layer context object given a wms layer object.
      *
      * Parameters:
-     * obj - {<OpenLayers.Layer.WMS>} The layer.
+     * layer - {<OpenLayers.Layer.WMS>} The layer.
      *
      * Returns:
      * {Object} A layer context object.

lib/OpenLayers/Format/WMC/v1.js

@@ -1011,7 +1011,7 @@ OpenLayers.Format.WMC.v1 = OpenLayers.Class(OpenLayers.Format.XML, {
      *     null or undefined, null will be returned.
      *
      * Parameters:
-     * object - {Object} An object.
+     * obj - {Object} An object.
      * prop - {String} A property.
      *
      * Returns:
@@ -1143,7 +1143,7 @@ OpenLayers.Format.WMC.v1 = OpenLayers.Class(OpenLayers.Format.XML, {
      * Create a StyleList node given a layer context.
      *
      * Parameters:
-     * context - {Object} Layer context object.
+     * layer - {Object} Layer context object.
      *
      * Returns:
      * {Element} A WMC StyleList element node.

lib/OpenLayers/Geometry.js

@@ -67,10 +67,11 @@ OpenLayers.Geometry = OpenLayers.Class({
     },
     
     /**
+     * Method: setBounds
      * Set the bounds for this Geometry.
      * 
      * Parameters:
-     * object - {<OpenLayers.Bounds>} 
+     * bounds - {<OpenLayers.Bounds>} 
      */
     setBounds: function(bounds) {
         if (bounds) {

lib/OpenLayers/Geometry/Collection.js

@@ -22,7 +22,7 @@
  *
  * Create a new instance with the <OpenLayers.Geometry.Collection> constructor.
  *
- * Inerhits from:
+ * Inherits from:
  *  - <OpenLayers.Geometry> 
  */
 OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
@@ -407,7 +407,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
      * ratio - {Float} Optional x:y ratio for resizing.  Default ratio is 1.
      * 
      * Returns:
-     * {OpenLayers.Geometry} - The current geometry. 
+     * {<OpenLayers.Geometry>} - The current geometry. 
      */
     resize: function(scale, origin, ratio) {
         for(var i=0; i<this.components.length; ++i) {
@@ -468,7 +468,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
      *     are considered equivalent if all components have the same coordinates.
      * 
      * Parameters:
-     * geom - {<OpenLayers.Geometry>} The geometry to test. 
+     * geometry - {<OpenLayers.Geometry>} The geometry to test. 
      *
      * Returns:
      * {Boolean} The supplied geometry is equivalent to this geometry.

lib/OpenLayers/Geometry/MultiLineString.js

@@ -42,7 +42,7 @@ OpenLayers.Geometry.MultiLineString = OpenLayers.Class(
      * Use this geometry (the source) to attempt to split a target geometry.
      * 
      * Parameters:
-     * target - {<OpenLayers.Geometry>} The target geometry.
+     * geometry - {<OpenLayers.Geometry>} The target geometry.
      * options - {Object} Properties of this object will be used to determine
      *     how the split is conducted.
      *

lib/OpenLayers/Handler/Feature.js

@@ -16,6 +16,9 @@
  *
  * This handler stops event propagation for mousedown and mouseup if those
  *     browser events target features that can be selected.
+ *
+ * Inherits from:
+ *  - <OpenLayers.Handler>
  */
 OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {
 

lib/OpenLayers/Layer/Bing.js

@@ -21,6 +21,13 @@
  */
 OpenLayers.Layer.Bing = OpenLayers.Class(OpenLayers.Layer.XYZ, {
 
+    /**
+     * Property: key
+     * {String} API key for Bing maps, get your own key 
+     *     at http://bingmapsportal.com/ .
+     */
+    key: null,
+
     /**
      * Property: serverResolutions
      * {Array} the resolutions provided by the Bing servers.
@@ -82,7 +89,7 @@ OpenLayers.Layer.Bing = OpenLayers.Class(OpenLayers.Layer.XYZ, {
      * (end)
      *
      * Parameters:
-     * config - {Object} Configuration properties for the layer.
+     * options - {Object} Configuration properties for the layer.
      *
      * Required configuration properties:
      * key - {String} Bing Maps API key for your application. Get one at

lib/OpenLayers/Layer/GeoRSS.js

@@ -15,7 +15,6 @@
  * 
  * Inherits from:
  *  - <OpenLayers.Layer.Markers>
- *  - <OpenLayers.Layer>
  */
 OpenLayers.Layer.GeoRSS = OpenLayers.Class(OpenLayers.Layer.Markers, {
 

lib/OpenLayers/Layer/Image.js

@@ -12,7 +12,10 @@
  * Class: OpenLayers.Layer.Image
  * Instances of OpenLayers.Layer.Image are used to display data from a web
  * accessible image as a map layer.  Create a new image layer with the
- * <OpenLayers.Layer.Image> constructor.  Inherits from <OpenLayers.Layer>.
+ * <OpenLayers.Layer.Image> constructor.
+ *
+ * Inherits from:
+ *  - <OpenLayers.Layer>
  */
 OpenLayers.Layer.Image = OpenLayers.Class(OpenLayers.Layer, {
 

lib/OpenLayers/Layer/Text.js

@@ -234,6 +234,9 @@ OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, {
      * 
      * Parameters:
      * evt - {Event} 
+     *
+     * Context:
+     * - {<OpenLayers.Feature>}
      */
     markerClick: function(evt) {
         var sameMarkerClicked = (this == this.layer.selectedFeature);

lib/OpenLayers/Renderer/Elements.js

@@ -420,9 +420,11 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, {
      * 
      * Parameters:
      * containerID - {String}
-     * options - {Object} options for this renderer. Supported options are:
+     * options - {Object} options for this renderer. 
-     *     * yOrdering - {Boolean} Whether to use y-ordering
+     *
-     *     * zIndexing - {Boolean} Whether to use z-indexing. Will be ignored
+     * Supported options are:
+     *     yOrdering - {Boolean} Whether to use y-ordering
+     *     zIndexing - {Boolean} Whether to use z-indexing. Will be ignored
      *         if yOrdering is set to true.
      */
     initialize: function(containerID, options) {

lib/OpenLayers/StyleMap.js

@@ -16,7 +16,7 @@ OpenLayers.StyleMap = OpenLayers.Class({
     
     /**
      * Property: styles
-     * Hash of {<OpenLayers.Style>}, keyed by names of well known
+     * {Object} Hash of {<OpenLayers.Style>}, keyed by names of well known
      * rendering intents (e.g. "default", "temporary", "select", "delete").
      */
     styles: null,

lib/OpenLayers/Tile.js

@@ -9,7 +9,7 @@
  * @requires OpenLayers/Util.js
  */
 
-/*
+/**
  * Class: OpenLayers.Tile 
  * This is a class designed to designate a single tile, however
  *     it is explicitly designed to do relatively little. Tiles store 

lib/OpenLayers/Util.js

@@ -24,8 +24,9 @@ OpenLayers.Util = OpenLayers.Util || {};
  *
  * Parameters:
  * e - {String or DOMElement or Window}
+ *
  * Return:
- * {Array(DOMElement)}
+ * {Array(DOMElement) or DOMElement}
  */
 OpenLayers.Util.getElement = function() {
     var elements = [];
@@ -66,7 +67,7 @@ OpenLayers.Util.isElement = function(o) {
  * Parameters:
  * a - {Object} the object test.
  * 
- * Returns
+ * Returns:
  * {Boolean} true if the object is an array.
  */
 OpenLayers.Util.isArray = function(a) {
@@ -89,7 +90,7 @@ if(typeof window.$  === "undefined") {
  * array - {Array}
  * item - {Object}
  * 
- * Return
+ * Returns:
  * {Array} A reference to the array
  */
 OpenLayers.Util.removeItem = function(array, item) {
@@ -1310,10 +1311,12 @@ OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) {
  * 
  * Parameters:
  * url - {String}
- * options - {Object} A hash of options.  Can be one of:
+ * options - {Object} A hash of options.
- *            ignoreCase: lowercase url,
+ *
- *            ignorePort80: don't include explicit port if port is 80,
+ * Valid options:
- *            ignoreHash: Don't include part of url after the hash (#).
+ *   ignoreCase - {Boolean} lowercase url,
+ *   ignorePort80 - {Boolean} don't include explicit port if port is 80,
+ *   ignoreHash - {Boolean} Don't include part of url after the hash (#).
  * 
  * Returns:
  * {Object} An object with separate url, a, port, host, and args parsed out 
@@ -1488,7 +1491,7 @@ OpenLayers.Util.getBrowserName = function() {
  *         this node instead of the body root when calculating dimensions. 
  * 
  * Returns:
- * {OpenLayers.Size}
+ * {<OpenLayers.Size>}
  */
 OpenLayers.Util.getRenderedDimensions = function(contentHTML, size, options) {