Some problems in the documentation detected using "closure_verify"

This commit is contained in:
Xavier Mamano
2012-01-07 19:29:41 +01:00
parent fc43ea715a
commit b7dee9ca6d
40 changed files with 98 additions and 56 deletions

View File

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

View File

@@ -68,7 +68,7 @@ OpenLayers.Control.LayerSwitcher =
/** /**
* Property: baseLayers * Property: baseLayers
* {Array(<OpenLayers.Layer>)} * {Array(Object)}
*/ */
baseLayers: null, baseLayers: null,
@@ -87,7 +87,7 @@ OpenLayers.Control.LayerSwitcher =
/** /**
* Property: dataLayers * Property: dataLayers
* {Array(<OpenLayers.Layer>)} * {Array(Object)}
*/ */
dataLayers: null, dataLayers: null,
@@ -372,10 +372,13 @@ OpenLayers.Control.LayerSwitcher =
* Parameters: * Parameters:
* e - {Event} * 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) { onInputClick: function(e) {

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -17,7 +17,7 @@
* constructor. * constructor.
* *
* Inherits from: * Inherits from:
* - <OpenLayers.Format> * - <OpenLayers.Format.XML>
*/ */
OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, { OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {

View File

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

View File

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

View File

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

View File

@@ -20,7 +20,7 @@
* constructor. Supports the GML simple features profile. * constructor. Supports the GML simple features profile.
* *
* Inherits from: * Inherits from:
* - <OpenLayers.Format> * - <OpenLayers.Format.XML>
*/ */
OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, { OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, {

View File

@@ -311,7 +311,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
* Builds a trkpt node given a point * Builds a trkpt node given a point
* *
* Parameters: * Parameters:
* line - {OpenLayers.Geometry.Point} * point - {OpenLayers.Geometry.Point}
* *
* Returns: * Returns:
* {DOMElement} A trkpt node * {DOMElement} A trkpt node

View File

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

View File

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

View File

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

View File

@@ -10,6 +10,9 @@
/** /**
* Class: OpenLayers.Format.OWSCommon.v1_0_0 * Class: OpenLayers.Format.OWSCommon.v1_0_0
* Parser for OWS Common version 1.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, { OpenLayers.Format.OWSCommon.v1_0_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, {

View File

@@ -10,6 +10,9 @@
/** /**
* Class: OpenLayers.Format.OWSCommon.v1_1_0 * Class: OpenLayers.Format.OWSCommon.v1_1_0
* Parser for OWS Common version 1.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, { OpenLayers.Format.OWSCommon.v1_1_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, {

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -22,7 +22,7 @@
* *
* Create a new instance with the <OpenLayers.Geometry.Collection> constructor. * Create a new instance with the <OpenLayers.Geometry.Collection> constructor.
* *
* Inerhits from: * Inherits from:
* - <OpenLayers.Geometry> * - <OpenLayers.Geometry>
*/ */
OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, { 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. * are considered equivalent if all components have the same coordinates.
* *
* Parameters: * Parameters:
* geom - {<OpenLayers.Geometry>} The geometry to test. * geometry - {<OpenLayers.Geometry>} The geometry to test.
* *
* Returns: * Returns:
* {Boolean} The supplied geometry is equivalent to this geometry. * {Boolean} The supplied geometry is equivalent to this geometry.

View File

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

View File

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

View File

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

View File

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

View File

@@ -12,7 +12,10 @@
* Class: OpenLayers.Layer.Image * Class: OpenLayers.Layer.Image
* Instances of OpenLayers.Layer.Image are used to display data from a web * 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 * 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, { OpenLayers.Layer.Image = OpenLayers.Class(OpenLayers.Layer, {

View File

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

View File

@@ -420,7 +420,9 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, {
* *
* Parameters: * Parameters:
* containerID - {String} * 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 * * yOrdering - {Boolean} Whether to use y-ordering
* * zIndexing - {Boolean} Whether to use z-indexing. Will be ignored * * zIndexing - {Boolean} Whether to use z-indexing. Will be ignored
* if yOrdering is set to true. * if yOrdering is set to true.

View File

@@ -16,7 +16,7 @@ OpenLayers.StyleMap = OpenLayers.Class({
/** /**
* Property: styles * 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"). * rendering intents (e.g. "default", "temporary", "select", "delete").
*/ */
styles: null, styles: null,

View File

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

View File

@@ -24,8 +24,9 @@ OpenLayers.Util = OpenLayers.Util || {};
* *
* Parameters: * Parameters:
* e - {String or DOMElement or Window} * e - {String or DOMElement or Window}
*
* Return: * Return:
* {Array(DOMElement)} * {Array(DOMElement) or DOMElement}
*/ */
OpenLayers.Util.getElement = function() { OpenLayers.Util.getElement = function() {
var elements = []; var elements = [];
@@ -66,7 +67,7 @@ OpenLayers.Util.isElement = function(o) {
* Parameters: * Parameters:
* a - {Object} the object test. * a - {Object} the object test.
* *
* Returns * Returns:
* {Boolean} true if the object is an array. * {Boolean} true if the object is an array.
*/ */
OpenLayers.Util.isArray = function(a) { OpenLayers.Util.isArray = function(a) {
@@ -89,7 +90,7 @@ if(typeof window.$ === "undefined") {
* array - {Array} * array - {Array}
* item - {Object} * item - {Object}
* *
* Return * Returns:
* {Array} A reference to the array * {Array} A reference to the array
*/ */
OpenLayers.Util.removeItem = function(array, item) { OpenLayers.Util.removeItem = function(array, item) {
@@ -1310,10 +1311,12 @@ OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) {
* *
* Parameters: * Parameters:
* url - {String} * 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, * Options can be one of:
* 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: * Returns:
* {Object} An object with separate url, a, port, host, and args parsed out * {Object} An object with separate url, a, port, host, and args parsed out