From b7dee9ca6d7deada7b5122aede49102450d989c7 Mon Sep 17 00:00:00 2001 From: Xavier Mamano Date: Sat, 7 Jan 2012 19:29:41 +0100 Subject: [PATCH] Some problems in the documentation detected using "closure_verify" --- lib/OpenLayers/Control/KeyboardDefaults.js | 2 +- lib/OpenLayers/Control/LayerSwitcher.js | 15 +++++++++------ lib/OpenLayers/Control/OverviewMap.js | 2 +- lib/OpenLayers/Control/PanZoomBar.js | 2 +- lib/OpenLayers/Control/SLDSelect.js | 3 +++ lib/OpenLayers/Feature/Vector.js | 2 +- lib/OpenLayers/Filter/Comparison.js | 2 +- lib/OpenLayers/Filter/FeatureId.js | 2 +- lib/OpenLayers/Filter/Function.js | 2 +- lib/OpenLayers/Filter/Logical.js | 2 +- lib/OpenLayers/Filter/Spatial.js | 2 +- lib/OpenLayers/Format/ArcXML.js | 2 +- lib/OpenLayers/Format/Atom.js | 5 ++--- lib/OpenLayers/Format/Context.js | 3 +++ lib/OpenLayers/Format/Filter/v1_1_0.js | 3 ++- lib/OpenLayers/Format/GML.js | 2 +- lib/OpenLayers/Format/GPX.js | 2 +- lib/OpenLayers/Format/GeoJSON.js | 2 +- lib/OpenLayers/Format/OSM.js | 8 ++++---- lib/OpenLayers/Format/OWSCommon/v1.js | 3 +++ lib/OpenLayers/Format/OWSCommon/v1_0_0.js | 3 +++ lib/OpenLayers/Format/OWSCommon/v1_1_0.js | 3 +++ lib/OpenLayers/Format/OWSContext.js | 3 +++ lib/OpenLayers/Format/OWSContext/v0_3_1.js | 2 +- lib/OpenLayers/Format/Text.js | 2 +- lib/OpenLayers/Format/WKT.js | 12 ++++++------ lib/OpenLayers/Format/WMC.js | 4 ++-- lib/OpenLayers/Format/WMC/v1.js | 4 ++-- lib/OpenLayers/Geometry.js | 3 ++- lib/OpenLayers/Geometry/Collection.js | 4 ++-- lib/OpenLayers/Geometry/MultiLineString.js | 2 +- lib/OpenLayers/Handler/Feature.js | 3 +++ lib/OpenLayers/Layer/Bing.js | 9 ++++++++- lib/OpenLayers/Layer/GeoRSS.js | 1 - lib/OpenLayers/Layer/Image.js | 5 ++++- lib/OpenLayers/Layer/Text.js | 3 +++ lib/OpenLayers/Renderer/Elements.js | 4 +++- lib/OpenLayers/StyleMap.js | 2 +- lib/OpenLayers/Tile.js | 2 +- lib/OpenLayers/Util.js | 17 ++++++++++------- 40 files changed, 98 insertions(+), 56 deletions(-) diff --git a/lib/OpenLayers/Control/KeyboardDefaults.js b/lib/OpenLayers/Control/KeyboardDefaults.js index 8e8c8b207d..a015a9ae16 100644 --- a/lib/OpenLayers/Control/KeyboardDefaults.js +++ b/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) { diff --git a/lib/OpenLayers/Control/LayerSwitcher.js b/lib/OpenLayers/Control/LayerSwitcher.js index aeb698bef8..3f81b3bfdc 100644 --- a/lib/OpenLayers/Control/LayerSwitcher.js +++ b/lib/OpenLayers/Control/LayerSwitcher.js @@ -68,7 +68,7 @@ OpenLayers.Control.LayerSwitcher = /** * Property: baseLayers - * {Array()} + * {Array(Object)} */ baseLayers: null, @@ -87,7 +87,7 @@ OpenLayers.Control.LayerSwitcher = /** * Property: dataLayers - * {Array()} + * {Array(Object)} */ dataLayers: null, @@ -372,10 +372,13 @@ OpenLayers.Control.LayerSwitcher = * Parameters: * e - {Event} * - * Context: - * - {DOMElement} inputElem - * - {} layerSwitcher - * - {} layer + * Context: + * - {Object} + * + * Object structure: + * inputElem - {DOMElement} + * layerSwitcher - {} + * layer - {} */ onInputClick: function(e) { diff --git a/lib/OpenLayers/Control/OverviewMap.js b/lib/OpenLayers/Control/OverviewMap.js index 34a195faf3..4ee3c11f1a 100644 --- a/lib/OpenLayers/Control/OverviewMap.js +++ b/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 as one of the options properties. */ diff --git a/lib/OpenLayers/Control/PanZoomBar.js b/lib/OpenLayers/Control/PanZoomBar.js index e7ce0c647f..ad3ecf48e0 100644 --- a/lib/OpenLayers/Control/PanZoomBar.js +++ b/lib/OpenLayers/Control/PanZoomBar.js @@ -190,7 +190,7 @@ OpenLayers.Control.PanZoomBar = OpenLayers.Class(OpenLayers.Control.PanZoom, { * Method: _addZoomBar * * Parameters: - * location - {} where zoombar drawing is to start. + * centered - {} where zoombar drawing is to start. */ _addZoomBar:function(centered) { var imgLocation = OpenLayers.Util.getImageLocation("slider.png"); diff --git a/lib/OpenLayers/Control/SLDSelect.js b/lib/OpenLayers/Control/SLDSelect.js index 8a4347775f..c192344a15 100644 --- a/lib/OpenLayers/Control/SLDSelect.js +++ b/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: + * - {} + * * Parameters: * evt - {Object} */ diff --git a/lib/OpenLayers/Feature/Vector.js b/lib/OpenLayers/Feature/Vector.js index 9cd1cd42a9..4e96ea6b53 100644 --- a/lib/OpenLayers/Feature/Vector.js +++ b/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) { diff --git a/lib/OpenLayers/Filter/Comparison.js b/lib/OpenLayers/Filter/Comparison.js index 164bf6d4db..d0c864d4d6 100644 --- a/lib/OpenLayers/Filter/Comparison.js +++ b/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.Comparison = OpenLayers.Class(OpenLayers.Filter, { diff --git a/lib/OpenLayers/Filter/FeatureId.js b/lib/OpenLayers/Filter/FeatureId.js index 63d146958c..eaa297bd4a 100644 --- a/lib/OpenLayers/Filter/FeatureId.js +++ b/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.FeatureId = OpenLayers.Class(OpenLayers.Filter, { diff --git a/lib/OpenLayers/Filter/Function.js b/lib/OpenLayers/Filter/Function.js index 9052253a28..9ee35ff7b3 100644 --- a/lib/OpenLayers/Filter/Function.js +++ b/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.Function = OpenLayers.Class(OpenLayers.Filter, { diff --git a/lib/OpenLayers/Filter/Logical.js b/lib/OpenLayers/Filter/Logical.js index ee4a23abe3..97fc2e2566 100644 --- a/lib/OpenLayers/Filter/Logical.js +++ b/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.Logical = OpenLayers.Class(OpenLayers.Filter, { diff --git a/lib/OpenLayers/Filter/Spatial.js b/lib/OpenLayers/Filter/Spatial.js index 895188fb2f..7753505338 100644 --- a/lib/OpenLayers/Filter/Spatial.js +++ b/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.Spatial = OpenLayers.Class(OpenLayers.Filter, { diff --git a/lib/OpenLayers/Format/ArcXML.js b/lib/OpenLayers/Format/ArcXML.js index 477a947312..a3b9e1dc07 100644 --- a/lib/OpenLayers/Format/ArcXML.js +++ b/lib/OpenLayers/Format/ArcXML.js @@ -17,7 +17,7 @@ * constructor. * * Inherits from: - * - + * - */ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, { diff --git a/lib/OpenLayers/Format/Atom.js b/lib/OpenLayers/Format/Atom.js index 29bdf75a89..c0c2be5763 100644 --- a/lib/OpenLayers/Format/Atom.js +++ b/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 s + * Array() */ 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 {} or an - * Array({}). + * features - {} or Array({}) * * Returns: * {String} an Atom entry document if passed one feature node, or a feed diff --git a/lib/OpenLayers/Format/Context.js b/lib/OpenLayers/Format/Context.js index 534c7f0225..a9fce65d92 100644 --- a/lib/OpenLayers/Format/Context.js +++ b/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.Context = OpenLayers.Class(OpenLayers.Format.XML.VersionedOGC, { diff --git a/lib/OpenLayers/Format/Filter/v1_1_0.js b/lib/OpenLayers/Format/Filter/v1_1_0.js index 600fa0fa45..1527b36a49 100644 --- a/lib/OpenLayers/Format/Filter/v1_1_0.js +++ b/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.Filter.v1_1_0 = OpenLayers.Class( diff --git a/lib/OpenLayers/Format/GML.js b/lib/OpenLayers/Format/GML.js index a26602daa0..ebf4ee1d6e 100644 --- a/lib/OpenLayers/Format/GML.js +++ b/lib/OpenLayers/Format/GML.js @@ -20,7 +20,7 @@ * constructor. Supports the GML simple features profile. * * Inherits from: - * - + * - */ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, { diff --git a/lib/OpenLayers/Format/GPX.js b/lib/OpenLayers/Format/GPX.js index f2de4ab9ff..d75e09ec72 100644 --- a/lib/OpenLayers/Format/GPX.js +++ b/lib/OpenLayers/Format/GPX.js @@ -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 diff --git a/lib/OpenLayers/Format/GeoJSON.js b/lib/OpenLayers/Format/GeoJSON.js index 6ea8a58711..c70779ce72 100644 --- a/lib/OpenLayers/Format/GeoJSON.js +++ b/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 - {} + * multilinestring - {} * * Returns: * {Array} An array of linestring arrays representing diff --git a/lib/OpenLayers/Format/OSM.js b/lib/OpenLayers/Format/OSM.js index f0d70f94ba..48ef45ac91 100644 --- a/lib/OpenLayers/Format/OSM.js +++ b/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 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 diff --git a/lib/OpenLayers/Format/OWSCommon/v1.js b/lib/OpenLayers/Format/OWSCommon/v1.js index e076e35ebe..4abedd860b 100644 --- a/lib/OpenLayers/Format/OWSCommon/v1.js +++ b/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.OWSCommon.v1 = OpenLayers.Class(OpenLayers.Format.XML, { diff --git a/lib/OpenLayers/Format/OWSCommon/v1_0_0.js b/lib/OpenLayers/Format/OWSCommon/v1_0_0.js index 279e3556ab..ca4fe120ae 100644 --- a/lib/OpenLayers/Format/OWSCommon/v1_0_0.js +++ b/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_0_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, { diff --git a/lib/OpenLayers/Format/OWSCommon/v1_1_0.js b/lib/OpenLayers/Format/OWSCommon/v1_1_0.js index 1a40f9f067..acf29bf176 100644 --- a/lib/OpenLayers/Format/OWSCommon/v1_1_0.js +++ b/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_1_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, { diff --git a/lib/OpenLayers/Format/OWSContext.js b/lib/OpenLayers/Format/OWSContext.js index afe88380b1..6f6f5f2208 100644 --- a/lib/OpenLayers/Format/OWSContext.js +++ b/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.OWSContext = OpenLayers.Class(OpenLayers.Format.Context,{ diff --git a/lib/OpenLayers/Format/OWSContext/v0_3_1.js b/lib/OpenLayers/Format/OWSContext/v0_3_1.js index 590161bb02..65024f0340 100644 --- a/lib/OpenLayers/Format/OWSContext/v0_3_1.js +++ b/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) { diff --git a/lib/OpenLayers/Format/Text.js b/lib/OpenLayers/Format/Text.js index 6f17eb962c..c590ebf12d 100644 --- a/lib/OpenLayers/Format/Text.js +++ b/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 s diff --git a/lib/OpenLayers/Format/WKT.js b/lib/OpenLayers/Format/WKT.js index bf88d64a69..7230af2163 100644 --- a/lib/OpenLayers/Format/WKT.js +++ b/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 */ diff --git a/lib/OpenLayers/Format/WMC.js b/lib/OpenLayers/Format/WMC.js index 9bea9290fb..2b56fc3428 100644 --- a/lib/OpenLayers/Format/WMC.js +++ b/lib/OpenLayers/Format/WMC.js @@ -13,7 +13,7 @@ * Read and write Web Map Context documents. * * Inherits from: - * - + * - */ 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 - {} The layer. + * layer - {} The layer. * * Returns: * {Object} A layer context object. diff --git a/lib/OpenLayers/Format/WMC/v1.js b/lib/OpenLayers/Format/WMC/v1.js index e39e67427b..e6eed09b44 100644 --- a/lib/OpenLayers/Format/WMC/v1.js +++ b/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. diff --git a/lib/OpenLayers/Geometry.js b/lib/OpenLayers/Geometry.js index 384a8be445..888f73b83e 100644 --- a/lib/OpenLayers/Geometry.js +++ b/lib/OpenLayers/Geometry.js @@ -67,10 +67,11 @@ OpenLayers.Geometry = OpenLayers.Class({ }, /** + * Method: setBounds * Set the bounds for this Geometry. * * Parameters: - * object - {} + * bounds - {} */ setBounds: function(bounds) { if (bounds) { diff --git a/lib/OpenLayers/Geometry/Collection.js b/lib/OpenLayers/Geometry/Collection.js index 5004210ce9..dc02e162b5 100644 --- a/lib/OpenLayers/Geometry/Collection.js +++ b/lib/OpenLayers/Geometry/Collection.js @@ -22,7 +22,7 @@ * * Create a new instance with the constructor. * - * Inerhits from: + * Inherits from: * - */ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { @@ -468,7 +468,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { * are considered equivalent if all components have the same coordinates. * * Parameters: - * geom - {} The geometry to test. + * geometry - {} The geometry to test. * * Returns: * {Boolean} The supplied geometry is equivalent to this geometry. diff --git a/lib/OpenLayers/Geometry/MultiLineString.js b/lib/OpenLayers/Geometry/MultiLineString.js index 27386516a5..09bba30e57 100644 --- a/lib/OpenLayers/Geometry/MultiLineString.js +++ b/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 - {} The target geometry. + * geometry - {} The target geometry. * options - {Object} Properties of this object will be used to determine * how the split is conducted. * diff --git a/lib/OpenLayers/Handler/Feature.js b/lib/OpenLayers/Handler/Feature.js index ef3597d2b1..402b8d66a8 100644 --- a/lib/OpenLayers/Handler/Feature.js +++ b/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.Feature = OpenLayers.Class(OpenLayers.Handler, { diff --git a/lib/OpenLayers/Layer/Bing.js b/lib/OpenLayers/Layer/Bing.js index 1d9faca2e2..92fe773bb4 100644 --- a/lib/OpenLayers/Layer/Bing.js +++ b/lib/OpenLayers/Layer/Bing.js @@ -21,6 +21,13 @@ */ OpenLayers.Layer.Bing = OpenLayers.Class(OpenLayers.Layer.XYZ, { + /** + * APIProperty: 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 diff --git a/lib/OpenLayers/Layer/GeoRSS.js b/lib/OpenLayers/Layer/GeoRSS.js index 968f61cf2a..f23822f7a7 100644 --- a/lib/OpenLayers/Layer/GeoRSS.js +++ b/lib/OpenLayers/Layer/GeoRSS.js @@ -15,7 +15,6 @@ * * Inherits from: * - - * - */ OpenLayers.Layer.GeoRSS = OpenLayers.Class(OpenLayers.Layer.Markers, { diff --git a/lib/OpenLayers/Layer/Image.js b/lib/OpenLayers/Layer/Image.js index d48567f8e9..23d4e1c7c1 100644 --- a/lib/OpenLayers/Layer/Image.js +++ b/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 - * constructor. Inherits from . + * constructor. + * + * Inherits from: + * - */ OpenLayers.Layer.Image = OpenLayers.Class(OpenLayers.Layer, { diff --git a/lib/OpenLayers/Layer/Text.js b/lib/OpenLayers/Layer/Text.js index 33e413b84a..9f8cb78cf8 100644 --- a/lib/OpenLayers/Layer/Text.js +++ b/lib/OpenLayers/Layer/Text.js @@ -234,6 +234,9 @@ OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, { * * Parameters: * evt - {Event} + * + * Context: + * - {} */ markerClick: function(evt) { var sameMarkerClicked = (this == this.layer.selectedFeature); diff --git a/lib/OpenLayers/Renderer/Elements.js b/lib/OpenLayers/Renderer/Elements.js index 2def983f27..ca58bb8a3a 100644 --- a/lib/OpenLayers/Renderer/Elements.js +++ b/lib/OpenLayers/Renderer/Elements.js @@ -420,7 +420,9 @@ 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. + * + * 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. diff --git a/lib/OpenLayers/StyleMap.js b/lib/OpenLayers/StyleMap.js index b1cc38a333..4b46336bc9 100644 --- a/lib/OpenLayers/StyleMap.js +++ b/lib/OpenLayers/StyleMap.js @@ -16,7 +16,7 @@ OpenLayers.StyleMap = OpenLayers.Class({ /** * Property: styles - * Hash of {}, keyed by names of well known + * {Object} Hash of {}, keyed by names of well known * rendering intents (e.g. "default", "temporary", "select", "delete"). */ styles: null, diff --git a/lib/OpenLayers/Tile.js b/lib/OpenLayers/Tile.js index f5afb7286c..81f6cb4e54 100644 --- a/lib/OpenLayers/Tile.js +++ b/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 diff --git a/lib/OpenLayers/Util.js b/lib/OpenLayers/Util.js index 417edb5867..61ec5bc2c1 100644 --- a/lib/OpenLayers/Util.js +++ b/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: - * ignoreCase: lowercase url, - * ignorePort80: don't include explicit port if port is 80, - * ignoreHash: Don't include part of url after the hash (#). + * options - {Object} A hash of options. + * + * Options can be one of: + * 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