diff --git a/apidoc_config/Menu.txt b/apidoc_config/Menu.txt index 16dd487956..003c4e43fd 100644 --- a/apidoc_config/Menu.txt +++ b/apidoc_config/Menu.txt @@ -48,7 +48,6 @@ SubTitle: JavaScript Mapping Library Group: OpenLayers { File: OpenLayers (no auto-title, OpenLayers.js) - File: Ajax (no auto-title, OpenLayers/Ajax.js) Group: BaseTypes { @@ -81,9 +80,7 @@ Group: OpenLayers { File: LayerSwitcher (no auto-title, OpenLayers/Control/LayerSwitcher.js) File: Measure (no auto-title, OpenLayers/Control/Measure.js) File: ModifyFeature (no auto-title, OpenLayers/Control/ModifyFeature.js) - File: MouseDefaults (no auto-title, OpenLayers/Control/MouseDefaults.js) File: MousePosition (no auto-title, OpenLayers/Control/MousePosition.js) - File: MouseToolbar (no auto-title, OpenLayers/Control/MouseToolbar.js) File: Navigation (no auto-title, OpenLayers/Control/Navigation.js) File: NavigationHistory (no auto-title, OpenLayers/Control/NavigationHistory.js) File: NavToolbar (no auto-title, OpenLayers/Control/NavToolbar.js) @@ -118,7 +115,6 @@ Group: OpenLayers { File: Feature (no auto-title, OpenLayers/Feature.js) File: Vector (no auto-title, OpenLayers/Feature/Vector.js) - File: WFS (no auto-title, OpenLayers/Feature/WFS.js) } # Group: Feature Group: Filter { @@ -152,9 +148,6 @@ Group: OpenLayers { File: v1_1_0 (no auto-title, OpenLayers/Format/Filter/v1_1_0.js) } # Group: Filter - File: GeoJSON (no auto-title, OpenLayers/Format/GeoJSON.js) - File: GeoRSS (no auto-title, OpenLayers/Format/GeoRSS.js) - Group: GML { File: GML (no auto-title, OpenLayers/Format/GML.js) @@ -163,15 +156,24 @@ Group: OpenLayers { File: v3 (no auto-title, OpenLayers/Format/GML/v3.js) } # Group: GML + Group: SLD { + + File: SLD (no auto-title, OpenLayers/Format/SLD.js) + File: v1 (no auto-title, OpenLayers/Format/SLD/v1.js) + File: v1_0_0 (no auto-title, OpenLayers/Format/SLD/v1_0_0.js) + } # Group: SLD + + File: GeoJSON (no auto-title, OpenLayers/Format/GeoJSON.js) + File: GeoRSS (no auto-title, OpenLayers/Format/GeoRSS.js) File: GPX (no auto-title, OpenLayers/Format/GPX.js) File: JSON (no auto-title, OpenLayers/Format/JSON.js) File: KML (no auto-title, OpenLayers/Format/KML.js) File: OGCExceptionReport (no auto-title, OpenLayers/Format/OGCExceptionReport.js) File: OSM (no auto-title, OpenLayers/Format/OSM.js) - File: OWSCommon (no auto-title, OpenLayers/Format/OWSCommon.js) Group: OWSCommon { + File: OWSCommon (no auto-title, OpenLayers/Format/OWSCommon.js) File: v1 (no auto-title, OpenLayers/Format/OWSCommon/v1.js) File: v1_0_0 (no auto-title, OpenLayers/Format/OWSCommon/v1_0_0.js) File: v1_1_0 (no auto-title, OpenLayers/Format/OWSCommon/v1_1_0.js) @@ -180,19 +182,12 @@ Group: OpenLayers { File: OWSContext (no auto-title, OpenLayers/Format/OWSContext.js) File: OWSContext.v0_3_1 (no auto-title, OpenLayers/Format/OWSContext/v0_3_1.js) File: QueryStringFilter (no auto-title, OpenLayers/Format/QueryStringFilter.js) - - Group: SLD { - - File: SLD (no auto-title, OpenLayers/Format/SLD.js) - File: v1 (no auto-title, OpenLayers/Format/SLD/v1.js) - File: v1_0_0 (no auto-title, OpenLayers/Format/SLD/v1_0_0.js) - } # Group: SLD - File: SOSCapabilities (no auto-title, OpenLayers/Format/SOSCapabilities.js) File: SOSCapabilities.v1_0_0 (no auto-title, OpenLayers/Format/SOSCapabilities/v1_0_0.js) File: SOSGetFeatureOfInterest (no auto-title, OpenLayers/Format/SOSGetFeatureOfInterest.js) File: SOSGetObservation (no auto-title, OpenLayers/Format/SOSGetObservation.js) File: Text (no auto-title, OpenLayers/Format/Text.js) + File: VersionedOGC (OpenLayers/Format/XML/VersionedOGC.js) File: WCSGetCoverage version 1.1.0 (no auto-title, OpenLayers/Format/WCSGetCoverage.js) File: WFS (no auto-title, OpenLayers/Format/WFS.js) @@ -204,8 +199,6 @@ Group: OpenLayers { File: v1_1_0 (no auto-title, OpenLayers/Format/WFSCapabilities/v1_1_0.js) } # Group: WFSCapabilities - File: WFSDescribeFeatureType (no auto-title, OpenLayers/Format/WFSDescribeFeatureType.js) - Group: WFST { File: WFST (no auto-title, OpenLayers/Format/WFST.js) @@ -214,8 +207,6 @@ Group: OpenLayers { File: v1_1_0 (no auto-title, OpenLayers/Format/WFST/v1_1_0.js) } # Group: WFST - File: WKT (no auto-title, OpenLayers/Format/WKT.js) - Group: WMC { File: WMC (no auto-title, OpenLayers/Format/WMC.js) @@ -242,6 +233,8 @@ Group: OpenLayers { File: v1_1 (no auto-title, OpenLayers/Format/WMSDescribeLayer/v1_1.js) } # Group: WMSDescribeLayer + File: WFSDescribeFeatureType (no auto-title, OpenLayers/Format/WFSDescribeFeatureType.js) + File: WKT (no auto-title, OpenLayers/Format/WKT.js) File: WMSGetFeatureInfo (no auto-title, OpenLayers/Format/WMSGetFeatureInfo.js) File: WMTSCapabilities (no auto-title, OpenLayers/Format/WMTSCapabilities.js) File: WMTSCapabilities.v1_0_0 (no auto-title, OpenLayers/Format/WMTSCapabilities/v1_0_0.js) @@ -267,7 +260,6 @@ Group: OpenLayers { File: MultiPolygon (no auto-title, OpenLayers/Geometry/MultiPolygon.js) File: Point (no auto-title, OpenLayers/Geometry/Point.js) File: Polygon (no auto-title, OpenLayers/Geometry/Polygon.js) - File: Rectangle (no auto-title, OpenLayers/Geometry/Rectangle.js) } # Group: Geometry Group: Handler { @@ -349,7 +341,6 @@ Group: OpenLayers { File: EventPane (no auto-title, OpenLayers/Layer/EventPane.js) File: FixedZoomLevels (no auto-title, OpenLayers/Layer/FixedZoomLevels.js) File: GeoRSS (no auto-title, OpenLayers/Layer/GeoRSS.js) - File: GML (no auto-title, OpenLayers/Layer/GML.js) File: Google (no auto-title, OpenLayers/Layer/Google.js) File: Google.v3 (no auto-title, OpenLayers/Layer/Google/v3.js) File: Grid (no auto-title, OpenLayers/Layer/Grid.js) @@ -359,9 +350,7 @@ Group: OpenLayers { File: KaMapCache (no auto-title, OpenLayers/Layer/KaMapCache.js) File: MapGuide (no auto-title, OpenLayers/Layer/MapGuide.js) File: MapServer (no auto-title, OpenLayers/Layer/MapServer.js) - File: MapServer.Untiled (no auto-title, OpenLayers/Layer/MapServer/Untiled.js) File: Markers (no auto-title, OpenLayers/Layer/Markers.js) - File: MultiMap (no auto-title, OpenLayers/Layer/MultiMap.js) File: OSM (no auto-title, OpenLayers/Layer/OSM.js) File: PointGrid (no auto-title, OpenLayers/Layer/PointGrid.js) File: PointTrack (no auto-title, OpenLayers/Layer/PointTrack.js) @@ -371,15 +360,10 @@ Group: OpenLayers { File: TMS (no auto-title, OpenLayers/Layer/TMS.js) File: Vector (no auto-title, OpenLayers/Layer/Vector.js) File: Vector.RootContainer (no auto-title, OpenLayers/Layer/Vector/RootContainer.js) - File: VirtualEarth (no auto-title, OpenLayers/Layer/VirtualEarth.js) - File: WFS (no auto-title, OpenLayers/Layer/WFS.js) File: WMS (no auto-title, OpenLayers/Layer/WMS.js) - File: WMS.Untiled (no auto-title, OpenLayers/Layer/WMS/Untiled.js) - File: WMS.Post (no auto-title, OpenLayers/Layer/WMS/Post.js) File: WMTS (no auto-title, OpenLayers/Layer/WMTS.js) File: WorldWind (no auto-title, OpenLayers/Layer/WorldWind.js) File: XYZ (no auto-title, OpenLayers/Layer/XYZ.js) - File: Yahoo (no auto-title, OpenLayers/Layer/Yahoo.js) File: Zoomify (no auto-title, OpenLayers/Layer/Zoomify.js) } # Group: Layer @@ -407,12 +391,6 @@ Group: OpenLayers { File: Protocol (no auto-title, OpenLayers/Protocol.js) File: HTTP (no auto-title, OpenLayers/Protocol/HTTP.js) - Group: SQL { - - File: SQL (no auto-title, OpenLayers/Protocol/SQL.js) - File: Gears (no auto-title, OpenLayers/Protocol/SQL/Gears.js) - } # Group: SQL - Group: WFS { File: WFS (no auto-title, OpenLayers/Protocol/WFS.js) @@ -443,8 +421,8 @@ Group: OpenLayers { File: XMLHttpRequest (no auto-title, OpenLayers/Request/XMLHttpRequest.js) } # Group: Request - File: SingleFile.js (no auto-title, OpenLayers/SingleFile.js) File: Rule (no auto-title, OpenLayers/Rule.js) + File: SingleFile.js (no auto-title, OpenLayers/SingleFile.js) Group: Strategy { @@ -477,11 +455,11 @@ Group: OpenLayers { File: Tile (no auto-title, OpenLayers/Tile.js) File: Image (no auto-title, OpenLayers/Tile/Image.js) File: Image.IFrame (no auto-title, OpenLayers/Tile/Image/IFrame.js) - File: WFS (no auto-title, OpenLayers/Tile/WFS.js) } # Group: Tile File: Tween (no auto-title, OpenLayers/Tween.js) File: Util (no auto-title, OpenLayers/Util.js) + File: Deprecated (no auto-title, deprecated.js) } # Group: OpenLayers Group: Index { diff --git a/doc_config/Menu.txt b/doc_config/Menu.txt index 9d23a1a7aa..7d685cb73c 100644 --- a/doc_config/Menu.txt +++ b/doc_config/Menu.txt @@ -48,7 +48,6 @@ SubTitle: JavaScript Mapping Library Group: OpenLayers { File: OpenLayers (no auto-title, OpenLayers.js) - File: Ajax (no auto-title, OpenLayers/Ajax.js) Group: BaseTypes { @@ -81,9 +80,7 @@ Group: OpenLayers { File: LayerSwitcher (no auto-title, OpenLayers/Control/LayerSwitcher.js) File: Measure (no auto-title, OpenLayers/Control/Measure.js) File: ModifyFeature (no auto-title, OpenLayers/Control/ModifyFeature.js) - File: MouseDefaults (no auto-title, OpenLayers/Control/MouseDefaults.js) File: MousePosition (no auto-title, OpenLayers/Control/MousePosition.js) - File: MouseToolbar (no auto-title, OpenLayers/Control/MouseToolbar.js) File: Navigation (no auto-title, OpenLayers/Control/Navigation.js) File: NavigationHistory (no auto-title, OpenLayers/Control/NavigationHistory.js) File: NavToolbar (no auto-title, OpenLayers/Control/NavToolbar.js) @@ -118,7 +115,6 @@ Group: OpenLayers { File: Feature (no auto-title, OpenLayers/Feature.js) File: Vector (no auto-title, OpenLayers/Feature/Vector.js) - File: WFS (no auto-title, OpenLayers/Feature/WFS.js) } # Group: Feature Group: Filter { @@ -152,9 +148,6 @@ Group: OpenLayers { File: v1_1_0 (no auto-title, OpenLayers/Format/Filter/v1_1_0.js) } # Group: Filter - File: GeoJSON (no auto-title, OpenLayers/Format/GeoJSON.js) - File: GeoRSS (no auto-title, OpenLayers/Format/GeoRSS.js) - Group: GML { File: GML (no auto-title, OpenLayers/Format/GML.js) @@ -163,15 +156,24 @@ Group: OpenLayers { File: v3 (no auto-title, OpenLayers/Format/GML/v3.js) } # Group: GML + Group: SLD { + + File: SLD (no auto-title, OpenLayers/Format/SLD.js) + File: v1 (no auto-title, OpenLayers/Format/SLD/v1.js) + File: v1_0_0 (no auto-title, OpenLayers/Format/SLD/v1_0_0.js) + } # Group: SLD + + File: GeoJSON (no auto-title, OpenLayers/Format/GeoJSON.js) + File: GeoRSS (no auto-title, OpenLayers/Format/GeoRSS.js) File: GPX (no auto-title, OpenLayers/Format/GPX.js) File: JSON (no auto-title, OpenLayers/Format/JSON.js) File: KML (no auto-title, OpenLayers/Format/KML.js) File: OGCExceptionReport (no auto-title, OpenLayers/Format/OGCExceptionReport.js) File: OSM (no auto-title, OpenLayers/Format/OSM.js) - File: OWSCommon (no auto-title, OpenLayers/Format/OWSCommon.js) Group: OWSCommon { + File: OWSCommon (no auto-title, OpenLayers/Format/OWSCommon.js) File: v1 (no auto-title, OpenLayers/Format/OWSCommon/v1.js) File: v1_0_0 (no auto-title, OpenLayers/Format/OWSCommon/v1_0_0.js) File: v1_1_0 (no auto-title, OpenLayers/Format/OWSCommon/v1_1_0.js) @@ -180,19 +182,12 @@ Group: OpenLayers { File: OWSContext (no auto-title, OpenLayers/Format/OWSContext.js) File: OWSContext.v0_3_1 (no auto-title, OpenLayers/Format/OWSContext/v0_3_1.js) File: QueryStringFilter (no auto-title, OpenLayers/Format/QueryStringFilter.js) - - Group: SLD { - - File: SLD (no auto-title, OpenLayers/Format/SLD.js) - File: v1 (no auto-title, OpenLayers/Format/SLD/v1.js) - File: v1_0_0 (no auto-title, OpenLayers/Format/SLD/v1_0_0.js) - } # Group: SLD - File: SOSCapabilities (no auto-title, OpenLayers/Format/SOSCapabilities.js) File: SOSCapabilities.v1_0_0 (no auto-title, OpenLayers/Format/SOSCapabilities/v1_0_0.js) File: SOSGetFeatureOfInterest (no auto-title, OpenLayers/Format/SOSGetFeatureOfInterest.js) File: SOSGetObservation (no auto-title, OpenLayers/Format/SOSGetObservation.js) File: Text (no auto-title, OpenLayers/Format/Text.js) + File: VersionedOGC (OpenLayers/Format/XML/VersionedOGC.js) File: WCSGetCoverage version 1.1.0 (no auto-title, OpenLayers/Format/WCSGetCoverage.js) File: WFS (no auto-title, OpenLayers/Format/WFS.js) @@ -204,8 +199,6 @@ Group: OpenLayers { File: v1_1_0 (no auto-title, OpenLayers/Format/WFSCapabilities/v1_1_0.js) } # Group: WFSCapabilities - File: WFSDescribeFeatureType (no auto-title, OpenLayers/Format/WFSDescribeFeatureType.js) - Group: WFST { File: WFST (no auto-title, OpenLayers/Format/WFST.js) @@ -214,8 +207,6 @@ Group: OpenLayers { File: v1_1_0 (no auto-title, OpenLayers/Format/WFST/v1_1_0.js) } # Group: WFST - File: WKT (no auto-title, OpenLayers/Format/WKT.js) - Group: WMC { File: WMC (no auto-title, OpenLayers/Format/WMC.js) @@ -242,6 +233,8 @@ Group: OpenLayers { File: v1_1 (no auto-title, OpenLayers/Format/WMSDescribeLayer/v1_1.js) } # Group: WMSDescribeLayer + File: WFSDescribeFeatureType (no auto-title, OpenLayers/Format/WFSDescribeFeatureType.js) + File: WKT (no auto-title, OpenLayers/Format/WKT.js) File: WMSGetFeatureInfo (no auto-title, OpenLayers/Format/WMSGetFeatureInfo.js) File: WMTSCapabilities (no auto-title, OpenLayers/Format/WMTSCapabilities.js) File: WMTSCapabilities.v1_0_0 (no auto-title, OpenLayers/Format/WMTSCapabilities/v1_0_0.js) @@ -267,7 +260,6 @@ Group: OpenLayers { File: MultiPolygon (no auto-title, OpenLayers/Geometry/MultiPolygon.js) File: Point (no auto-title, OpenLayers/Geometry/Point.js) File: Polygon (no auto-title, OpenLayers/Geometry/Polygon.js) - File: Rectangle (no auto-title, OpenLayers/Geometry/Rectangle.js) } # Group: Geometry Group: Handler { @@ -349,7 +341,6 @@ Group: OpenLayers { File: EventPane (no auto-title, OpenLayers/Layer/EventPane.js) File: FixedZoomLevels (no auto-title, OpenLayers/Layer/FixedZoomLevels.js) File: GeoRSS (no auto-title, OpenLayers/Layer/GeoRSS.js) - File: GML (no auto-title, OpenLayers/Layer/GML.js) File: Google (no auto-title, OpenLayers/Layer/Google.js) File: Google.v3 (no auto-title, OpenLayers/Layer/Google/v3.js) File: Grid (no auto-title, OpenLayers/Layer/Grid.js) @@ -359,9 +350,7 @@ Group: OpenLayers { File: KaMapCache (no auto-title, OpenLayers/Layer/KaMapCache.js) File: MapGuide (no auto-title, OpenLayers/Layer/MapGuide.js) File: MapServer (no auto-title, OpenLayers/Layer/MapServer.js) - File: MapServer.Untiled (no auto-title, OpenLayers/Layer/MapServer/Untiled.js) File: Markers (no auto-title, OpenLayers/Layer/Markers.js) - File: MultiMap (no auto-title, OpenLayers/Layer/MultiMap.js) File: PointGrid (no auto-title, OpenLayers/Layer/PointGrid.js) File: PointTrack (no auto-title, OpenLayers/Layer/PointTrack.js) File: SphericalMercator (no auto-title, OpenLayers/Layer/SphericalMercator.js) @@ -370,15 +359,10 @@ Group: OpenLayers { File: TMS (no auto-title, OpenLayers/Layer/TMS.js) File: Vector (no auto-title, OpenLayers/Layer/Vector.js) File: Vector.RootContainer (no auto-title, OpenLayers/Layer/Vector/RootContainer.js) - File: VirtualEarth (no auto-title, OpenLayers/Layer/VirtualEarth.js) - File: WFS (no auto-title, OpenLayers/Layer/WFS.js) File: WMS (no auto-title, OpenLayers/Layer/WMS.js) - File: WMS.Untiled (no auto-title, OpenLayers/Layer/WMS/Untiled.js) - File: WMS.Post (no auto-title, OpenLayers/Layer/WMS/Post.js) File: WMTS (no auto-title, OpenLayers/Layer/WMTS.js) File: WorldWind (no auto-title, OpenLayers/Layer/WorldWind.js) File: XYZ (no auto-title, OpenLayers/Layer/XYZ.js) - File: Yahoo (no auto-title, OpenLayers/Layer/Yahoo.js) File: Zoomify (no auto-title, OpenLayers/Layer/Zoomify.js) } # Group: Layer @@ -406,12 +390,6 @@ Group: OpenLayers { File: Protocol (no auto-title, OpenLayers/Protocol.js) File: HTTP (no auto-title, OpenLayers/Protocol/HTTP.js) - Group: SQL { - - File: SQL (no auto-title, OpenLayers/Protocol/SQL.js) - File: Gears (no auto-title, OpenLayers/Protocol/SQL/Gears.js) - } # Group: SQL - Group: WFS { File: WFS (no auto-title, OpenLayers/Protocol/WFS.js) @@ -442,8 +420,8 @@ Group: OpenLayers { File: XMLHttpRequest (no auto-title, OpenLayers/Request/XMLHttpRequest.js) } # Group: Request - File: SingleFile.js (no auto-title, OpenLayers/SingleFile.js) File: Rule (no auto-title, OpenLayers/Rule.js) + File: SingleFile.js (no auto-title, OpenLayers/SingleFile.js) Group: Strategy { @@ -476,11 +454,11 @@ Group: OpenLayers { File: Tile (no auto-title, OpenLayers/Tile.js) File: Image (no auto-title, OpenLayers/Tile/Image.js) File: Image.IFrame (no auto-title, OpenLayers/Tile/Image/IFrame.js) - File: WFS (no auto-title, OpenLayers/Tile/WFS.js) } # Group: Tile File: Tween (no auto-title, OpenLayers/Tween.js) File: Util (no auto-title, OpenLayers/Util.js) + File: Deprecated (no auto-title, deprecated.js) } # Group: OpenLayers Group: Index { diff --git a/lib/OpenLayers.js b/lib/OpenLayers.js index 040570e13c..5302ba8bcf 100644 --- a/lib/OpenLayers.js +++ b/lib/OpenLayers.js @@ -242,6 +242,8 @@ "OpenLayers/Protocol/WFS/v1.js", "OpenLayers/Protocol/WFS/v1_0_0.js", "OpenLayers/Protocol/WFS/v1_1_0.js", + "OpenLayers/Protocol/CSW.js", + "OpenLayers/Protocol/CSW/v2_0_2.js", "OpenLayers/Protocol/Script.js", "OpenLayers/Protocol/SOS.js", "OpenLayers/Protocol/SOS/v1_0_0.js", diff --git a/lib/OpenLayers/Control/ArgParser.js b/lib/OpenLayers/Control/ArgParser.js index 2f50e84fad..56dc1ecee8 100644 --- a/lib/OpenLayers/Control/ArgParser.js +++ b/lib/OpenLayers/Control/ArgParser.js @@ -22,19 +22,19 @@ OpenLayers.Control.ArgParser = OpenLayers.Class(OpenLayers.Control, { /** - * Parameter: center + * Property: center * {} */ center: null, /** - * Parameter: zoom + * Property: zoom * {int} */ zoom: null, /** - * Parameter: layers + * Property: layers * {Array()} */ layers: null, diff --git a/lib/OpenLayers/Control/DragPan.js b/lib/OpenLayers/Control/DragPan.js index 4891046773..34e31be905 100644 --- a/lib/OpenLayers/Control/DragPan.js +++ b/lib/OpenLayers/Control/DragPan.js @@ -47,7 +47,7 @@ OpenLayers.Control.DragPan = OpenLayers.Class(OpenLayers.Control, { /** * Property: kinetic - * {OpenLayers.Kinetic} The OpenLayers.Kinetic object. + * {} The OpenLayers.Kinetic object. */ kinetic: null, diff --git a/lib/OpenLayers/Control/Graticule.js b/lib/OpenLayers/Control/Graticule.js index bda9637b3c..72162d46d5 100644 --- a/lib/OpenLayers/Control/Graticule.js +++ b/lib/OpenLayers/Control/Graticule.js @@ -98,7 +98,7 @@ OpenLayers.Control.Graticule = OpenLayers.Class(OpenLayers.Control, { /** * Property: gratLayer - * {OpenLayers.Layer.Vector} vector layer used to draw the graticule on + * {} vector layer used to draw the graticule on */ gratLayer: null, 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..01fe86ee3a 100644 --- a/lib/OpenLayers/Control/OverviewMap.js +++ b/lib/OpenLayers/Control/OverviewMap.js @@ -17,7 +17,7 @@ * the lower right corner of the main map. Create a new overview map with the * constructor. * - * Inerits from: + * Inherits from: * - */ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, { @@ -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/Panel.js b/lib/OpenLayers/Control/Panel.js index 93640b20e7..4c6e7e6183 100644 --- a/lib/OpenLayers/Control/Panel.js +++ b/lib/OpenLayers/Control/Panel.js @@ -330,7 +330,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, { * APIMethod: getControlsBy * Get a list of controls with properties matching the given criteria. * - * Parameter: + * Parameters: * property - {String} A control property to be matched. * match - {String | Object} A string to match. Can also be a regular * expression literal or object. In addition, it can be any object @@ -355,7 +355,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, { * APIMethod: getControlsByName * Get a list of contorls with names matching the given name. * - * Parameter: + * Parameters: * match - {String | Object} A control name. The name can also be a regular * expression literal or object. In addition, it can be any object * with a method named test. For reqular expressions or other, if @@ -375,7 +375,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, { * APIMethod: getControlsByClass * Get a list of controls of a given type (CLASS_NAME). * - * Parameter: + * Parameters: * match - {String | Object} A control class name. The type can also be a * regular expression literal or object. In addition, it can be any * object with a method named test. For reqular expressions or other, 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/Control/Scale.js b/lib/OpenLayers/Control/Scale.js index 460a2d0aea..60601ae7be 100644 --- a/lib/OpenLayers/Control/Scale.js +++ b/lib/OpenLayers/Control/Scale.js @@ -20,7 +20,7 @@ OpenLayers.Control.Scale = OpenLayers.Class(OpenLayers.Control, { /** - * Parameter: element + * Property: element * {DOMElement} */ element: null, diff --git a/lib/OpenLayers/Control/Snapping.js b/lib/OpenLayers/Control/Snapping.js index f35cea28e9..792f0183a4 100644 --- a/lib/OpenLayers/Control/Snapping.js +++ b/lib/OpenLayers/Control/Snapping.js @@ -115,7 +115,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, { * the control. * * Valid options: - * layer - {OpenLayers.Layer.Vector} The editable layer. Features from this + * layer - {} The editable layer. Features from this * layer that are digitized or modified may have vertices snapped to * features from any of the target layers. * targets - {Array(Object | OpenLayers.Layer.Vector)} A list of objects for @@ -141,7 +141,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, { * continues after an eligible feature is found in a target layer. * * Valid target properties: - * layer - {OpenLayers.Layer.Vector} A target layer. Features from this + * layer - {} A target layer. Features from this * layer will be eligible to act as snapping target for the editable * layer. * tolerance - {Float} The distance (in pixels) at which snapping may occur. @@ -159,7 +159,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, { * edgeTolerance - {Float} Optional distance at which snapping may occur * for edges specifically. If none is provided, will be * used. - * filter - {OpenLayers.Filter} Optional filter to evaluate to determine if + * filter - {} Optional filter to evaluate to determine if * feature is eligible for snapping. If filter evaluates to true for a * target feature a vertex may be snapped to the feature. * minResolution - {Number} If a minResolution is provided, snapping to this @@ -198,7 +198,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, { * layer is set. * * Parameters: - * layer - {OpenLayers.Layer.Vector} The new editable layer. + * layer - {} The new editable layer. */ setLayer: function(layer) { if(this.active) { diff --git a/lib/OpenLayers/Control/Split.js b/lib/OpenLayers/Control/Split.js index eec6dcc965..413b8c9f4e 100644 --- a/lib/OpenLayers/Control/Split.js +++ b/lib/OpenLayers/Control/Split.js @@ -106,7 +106,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { /** * APIProperty: targetFilter - * {OpenLayers.Filter} Optional filter that will be evaluated + * {} Optional filter that will be evaluated * to determine if a feature from the target layer is eligible for * splitting. */ @@ -114,7 +114,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { /** * APIProperty: sourceFilter - * {OpenLayers.Filter} Optional filter that will be evaluated + * {} Optional filter that will be evaluated * to determine if a feature from the target layer is eligible for * splitting. */ @@ -141,10 +141,10 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { * the control. * * Valid options: - * layer - {OpenLayers.Layer.Vector} The target layer. Features from this + * layer - {} The target layer. Features from this * layer will be split by new or modified features on the source layer * or temporary sketch layer. - * source - {OpenLayers.Layer.Vector} Optional source layer. If provided + * source - {} Optional source layer. If provided * newly created features or modified features will be used to split * features on the target layer. If not provided, a temporary sketch * layer will be created for drawing lines. @@ -158,10 +158,10 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { * mutual - {Boolean} If source and target are the same, split source * features and target features where they intersect. Default is * true. If false, only target features will be split. - * targetFilter - {OpenLayers.Filter} Optional filter that will be evaluated + * targetFilter - {} Optional filter that will be evaluated * to determine if a feature from the target layer is eligible for * splitting. - * sourceFilter - {OpenLayers.Filter} Optional filter that will be evaluated + * sourceFilter - {} Optional filter that will be evaluated * to determine if a feature from the target layer is eligible for * splitting. */ @@ -180,7 +180,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { * Set the source layer for edits layer. * * Parameters: - * layer - {OpenLayers.Layer.Vector} The new source layer layer. If + * layer - {} The new source layer layer. If * null, a temporary sketch layer will be created. */ setSource: function(layer) { @@ -277,8 +277,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { afterFeatureModified: function(event) { if(event.modified) { var feature = event.feature; - if(feature.geometry instanceof OpenLayers.Geometry.LineString || - feature.geometry instanceof OpenLayers.Geometry.MultiLineString) { + if (typeof feature.geometry.split === "function") { this.feature = event.feature; this.considerSplit(event.feature); } @@ -313,17 +312,20 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, { * {Boolean} The target is eligible for splitting. */ isEligible: function(target) { - return ( - target.state !== OpenLayers.State.DELETE - ) && ( - target.geometry instanceof OpenLayers.Geometry.LineString || - target.geometry instanceof OpenLayers.Geometry.MultiLineString - ) && ( - this.feature !== target - ) && ( - !this.targetFilter || - this.targetFilter.evaluate(target.attributes) - ); + if (!target.geometry) { + return false; + } else { + return ( + target.state !== OpenLayers.State.DELETE + ) && ( + typeof target.geometry.split === "function" + ) && ( + this.feature !== target + ) && ( + !this.targetFilter || + this.targetFilter.evaluate(target.attributes) + ); + } }, /** diff --git a/lib/OpenLayers/Feature/Vector.js b/lib/OpenLayers/Feature/Vector.js index 9cd1cd42a9..b0e91009c4 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 - { or } 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..b87364c4e5 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, { @@ -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 - {} 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 {} 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 @@ -205,7 +205,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, { * data - {String} or {DOMElement} data to read/parse. * * Returns: - * {OpenLayers.Format.ArcXML.Response} An ArcXML response. Note that this response + * {} An ArcXML response. Note that this response * data may change in the future. */ read: function(data) { @@ -873,7 +873,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, { * node - {} An element to parse or arcxml data from. * * Returns: - * {OpenLayers.Geometry.LinearRing} A linear ring represented by the node's points. + * {} A linear ring represented by the node's points. */ parsePointGeometry: function(node) { var ringPoints = []; diff --git a/lib/OpenLayers/Format/Atom.js b/lib/OpenLayers/Format/Atom.js index 29bdf75a89..e984be1eab 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..c55e6a7bb5 100644 --- a/lib/OpenLayers/Format/GML.js +++ b/lib/OpenLayers/Format/GML.js @@ -20,11 +20,11 @@ * constructor. Supports the GML simple features profile. * * Inherits from: - * - + * - */ 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". */ diff --git a/lib/OpenLayers/Format/GPX.js b/lib/OpenLayers/Format/GPX.js index f2de4ab9ff..c6a67f9953 100644 --- a/lib/OpenLayers/Format/GPX.js +++ b/lib/OpenLayers/Format/GPX.js @@ -281,7 +281,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, { * * Parameters: * trknode - * geometry - {OpenLayers.Geometry} + * 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 - {} * * 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 - {} * * 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 - {} */ appendAttributesNode: function(node, feature) { var name = this.createElementNS(this.gpxns, 'name'); 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/KML.js b/lib/OpenLayers/Format/KML.js index c0d3ba688e..1754fd8eb5 100644 --- a/lib/OpenLayers/Format/KML.js +++ b/lib/OpenLayers/Format/KML.js @@ -1393,7 +1393,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format.XML, { * Parameters: * geometry - {} * - * Return: + * Returns: * {DOMElement} */ buildCoordinatesNode: function(geometry) { 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/WFS.js b/lib/OpenLayers/Format/WFS.js index 50c604012b..860df0aa5f 100644 --- a/lib/OpenLayers/Format/WFS.js +++ b/lib/OpenLayers/Format/WFS.js @@ -20,20 +20,23 @@ OpenLayers.Format.WFS = OpenLayers.Class(OpenLayers.Format.GML, { /** * Property: 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 - {} */ - initialize: function(options, layer) { OpenLayers.Format.GML.prototype.initialize.apply(this, [options]); this.layer = layer; 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..965c69e208 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, { @@ -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. + * {} - The current geometry. */ resize: function(scale, origin, ratio) { for(var i=0; i} 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/LinearRing.js b/lib/OpenLayers/Geometry/LinearRing.js index fa41f10391..c8b960915c 100644 --- a/lib/OpenLayers/Geometry/LinearRing.js +++ b/lib/OpenLayers/Geometry/LinearRing.js @@ -53,7 +53,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class( * be overridden by calling the method with a non-null index as the * second argument. * - * Parameter: + * Parameters: * point - {} * index - {Integer} Index into the array to insert the component * @@ -153,7 +153,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class( * ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1. * * Returns: - * {OpenLayers.Geometry} - The current geometry. + * {} - The current geometry. */ resize: function(scale, origin, ratio) { for(var i=0, len=this.components.length; i} 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/Geometry/Point.js b/lib/OpenLayers/Geometry/Point.js index 06cf770e99..a6000bc4c6 100644 --- a/lib/OpenLayers/Geometry/Point.js +++ b/lib/OpenLayers/Geometry/Point.js @@ -212,7 +212,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, { * ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1. * * Returns: - * {OpenLayers.Geometry} - The current geometry. + * {} - The current geometry. */ resize: function(scale, origin, ratio) { ratio = (ratio == undefined) ? 1 : ratio; 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/Handler/Path.js b/lib/OpenLayers/Handler/Path.js index 9557a7f4c7..57d112b2a0 100644 --- a/lib/OpenLayers/Handler/Path.js +++ b/lib/OpenLayers/Handler/Path.js @@ -30,8 +30,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { * APIProperty: maxVertices * {Number} The maximum number of vertices which can be drawn by this * handler. When the number of vertices reaches maxVertices, the - * geometry is automatically finalized. This property doesn't - * apply if freehand is set. Default is null. + * geometry is automatically finalized. Default is null. */ maxVertices: null, @@ -446,7 +445,13 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, { if(this.persist) { this.destroyPersistedFeature(); } - this.addPoint(evt.xy); + if(this.maxVertices && this.line && + this.line.geometry.components.length === this.maxVertices) { + this.removePoint() + this.finalize(); + } else { + this.addPoint(evt.xy); + } return false; } if (!this.touch && (!this.mouseDown || this.stoppedDown)) { diff --git a/lib/OpenLayers/Handler/Polygon.js b/lib/OpenLayers/Handler/Polygon.js index 8bc03d6843..8031fa991e 100644 --- a/lib/OpenLayers/Handler/Polygon.js +++ b/lib/OpenLayers/Handler/Polygon.js @@ -35,7 +35,7 @@ OpenLayers.Handler.Polygon = OpenLayers.Class(OpenLayers.Handler.Path, { drawingHole: false, /** - * Parameter: polygon + * Property: polygon * {} */ polygon: null, diff --git a/lib/OpenLayers/Handler/RegularPolygon.js b/lib/OpenLayers/Handler/RegularPolygon.js index 0e569d0843..3a853641c2 100644 --- a/lib/OpenLayers/Handler/RegularPolygon.js +++ b/lib/OpenLayers/Handler/RegularPolygon.js @@ -168,7 +168,7 @@ OpenLayers.Handler.RegularPolygon = OpenLayers.Class(OpenLayers.Handler.Drag, { * APIMethod: activate * Turn on the handler. * - * Return: + * Returns: * {Boolean} The handler was successfully activated */ activate: function() { @@ -195,7 +195,7 @@ OpenLayers.Handler.RegularPolygon = OpenLayers.Class(OpenLayers.Handler.Drag, { * APIMethod: deactivate * Turn off the handler. * - * Return: + * Returns: * {Boolean} The handler was successfully deactivated */ deactivate: function() { diff --git a/lib/OpenLayers/Icon.js b/lib/OpenLayers/Icon.js index 840001f62b..4d6cbd0240 100644 --- a/lib/OpenLayers/Icon.js +++ b/lib/OpenLayers/Icon.js @@ -41,7 +41,7 @@ OpenLayers.Icon = OpenLayers.Class({ /** * Property: calculateOffset - * {} Function to calculate the offset (based on the size) + * {Function} Function to calculate the offset (based on the size) */ calculateOffset: null, diff --git a/lib/OpenLayers/Layer.js b/lib/OpenLayers/Layer.js index 51405ad634..db817af4c7 100644 --- a/lib/OpenLayers/Layer.js +++ b/lib/OpenLayers/Layer.js @@ -975,7 +975,7 @@ OpenLayers.Layer = OpenLayers.Class({ * Parameters: * props - {Object} Properties * - * Return: + * Returns: * {Array({Number})} Array of resolutions. */ calculateResolutions: function(props) { @@ -1124,7 +1124,7 @@ OpenLayers.Layer = OpenLayers.Class({ /** * APIMethod: getResolutionForZoom * - * Parameter: + * Parameters: * zoom - {Float} * * Returns: @@ -1265,7 +1265,7 @@ OpenLayers.Layer = OpenLayers.Class({ * APIMethod: setOpacity * Sets the opacity for the entire layer (all images) * - * Parameter: + * Parameters: * opacity - {Float} */ setOpacity: function(opacity) { diff --git a/lib/OpenLayers/Layer/ArcGISCache.js b/lib/OpenLayers/Layer/ArcGISCache.js index 30a5fd3366..9c500e4533 100644 --- a/lib/OpenLayers/Layer/ArcGISCache.js +++ b/lib/OpenLayers/Layer/ArcGISCache.js @@ -363,7 +363,7 @@ OpenLayers.Layer.ArcGISCache = OpenLayers.Class(OpenLayers.Layer.XYZ, { * Get this layer's maximum extent. * * Returns: - * {OpenLayers.Bounds} + * {} */ getMaxExtent: function() { var resolution = this.map.getResolution(); diff --git a/lib/OpenLayers/Layer/Bing.js b/lib/OpenLayers/Layer/Bing.js index 1d9faca2e2..85c27acdeb 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, { + /** + * 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 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/Google.js b/lib/OpenLayers/Layer/Google.js index 7d153532c2..1e62ad655c 100644 --- a/lib/OpenLayers/Layer/Google.js +++ b/lib/OpenLayers/Layer/Google.js @@ -205,7 +205,7 @@ OpenLayers.Layer.Google = OpenLayers.Class( * APIMethod: setOpacity * Sets the opacity for the entire layer (all images) * - * Parameter: + * Parameters: * opacity - {Float} */ setOpacity: function(opacity) { diff --git a/lib/OpenLayers/Layer/Grid.js b/lib/OpenLayers/Layer/Grid.js index d893c438cf..fca45f3eba 100644 --- a/lib/OpenLayers/Layer/Grid.js +++ b/lib/OpenLayers/Layer/Grid.js @@ -817,7 +817,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, { * potential specific implementations in sub-classes.) * * Returns: - * {OpenLayers.Bounds} + * {} */ getMaxExtent: function() { return this.maxExtent; 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/MapServer.js b/lib/OpenLayers/Layer/MapServer.js index 3b3fd19949..544c716a8a 100644 --- a/lib/OpenLayers/Layer/MapServer.js +++ b/lib/OpenLayers/Layer/MapServer.js @@ -114,7 +114,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, { * Method: getFullRequestString * combine the layer's url with its params and these newParams. * - * Parameter: + * Parameters: * newParams - {Object} New parameters that should be added to the * request string. * altUrl - {String} (optional) Replace the URL in the full request diff --git a/lib/OpenLayers/Layer/Markers.js b/lib/OpenLayers/Layer/Markers.js index 1a17c4c311..8dabd2b8c5 100644 --- a/lib/OpenLayers/Layer/Markers.js +++ b/lib/OpenLayers/Layer/Markers.js @@ -64,7 +64,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, { * APIMethod: setOpacity * Sets the opacity for all the markers. * - * Parameter: + * Parameters: * opacity - {Float} */ setOpacity: function(opacity) { diff --git a/lib/OpenLayers/Layer/PointGrid.js b/lib/OpenLayers/Layer/PointGrid.js index c0508cb667..37f338f70f 100644 --- a/lib/OpenLayers/Layer/PointGrid.js +++ b/lib/OpenLayers/Layer/PointGrid.js @@ -69,7 +69,7 @@ OpenLayers.Layer.PointGrid = OpenLayers.Class(OpenLayers.Layer.Vector, { /** * APIProperty: origin - * {OpenLayers.LonLat} Grid origin. The grid lattice will be aligned with + * {} Grid origin. The grid lattice will be aligned with * the origin. If not set at construction, the center of the map's maximum * extent is used. Read-only. Use the method to modify this * value. 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/Map.js b/lib/OpenLayers/Map.js index 9bf971aa78..3514e857c7 100644 --- a/lib/OpenLayers/Map.js +++ b/lib/OpenLayers/Map.js @@ -359,7 +359,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * Property: panTween - * {OpenLayers.Tween} Animated panning tween object, see panTo() + * {} Animated panning tween object, see panTo() */ panTween: null, @@ -776,7 +776,7 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getLayersBy * Get a list of layers with properties matching the given criteria. * - * Parameter: + * Parameters: * property - {String} A layer property to be matched. * match - {String | Object} A string to match. Can also be a regular * expression literal or object. In addition, it can be any object @@ -797,7 +797,7 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getLayersByName * Get a list of layers with names matching the given name. * - * Parameter: + * Parameters: * match - {String | Object} A layer name. The name can also be a regular * expression literal or object. In addition, it can be any object * with a method named test. For reqular expressions or other, if @@ -817,7 +817,7 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getLayersByClass * Get a list of layers of a given class (CLASS_NAME). * - * Parameter: + * Parameters: * match - {String | Object} A layer class name. The match can also be a * regular expression literal or object. In addition, it can be any * object with a method named test. For reqular expressions or other, @@ -837,7 +837,7 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getControlsBy * Get a list of controls with properties matching the given criteria. * - * Parameter: + * Parameters: * property - {String} A control property to be matched. * match - {String | Object} A string to match. Can also be a regular * expression literal or object. In addition, it can be any object @@ -858,7 +858,7 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getControlsByClass * Get a list of controls of a given class (CLASS_NAME). * - * Parameter: + * Parameters: * match - {String | Object} A control class name. The match can also be a * regular expression literal or object. In addition, it can be any * object with a method named test. For reqular expressions or other, @@ -887,7 +887,7 @@ OpenLayers.Map = OpenLayers.Class({ * APIMethod: getLayer * Get a layer based on its id * - * Parameter: + * Parameters: * id - {String} A layer id * * Returns: @@ -2159,7 +2159,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getResolutionForZoom * - * Parameter: + * Parameters: * zoom - {Float} * * Returns: @@ -2177,7 +2177,7 @@ OpenLayers.Map = OpenLayers.Class({ /** * APIMethod: getZoomForResolution * - * Parameter: + * Parameters: * resolution - {Float} * closest - {Boolean} Find the zoom level that corresponds to the absolute * closest resolution, which may result in a zoom whose corresponding diff --git a/lib/OpenLayers/Popup/Anchored.js b/lib/OpenLayers/Popup/Anchored.js index a9f16e9cf3..4dd041795d 100644 --- a/lib/OpenLayers/Popup/Anchored.js +++ b/lib/OpenLayers/Popup/Anchored.js @@ -18,7 +18,7 @@ OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, { /** - * Parameter: relativePosition + * Property: relativePosition * {String} Relative position of the popup ("br", "tr", "tl" or "bl"). */ relativePosition: null, @@ -38,7 +38,7 @@ OpenLayers.Popup.Anchored = keepInMap: true, /** - * Parameter: anchor + * Property: anchor * {Object} Object to which we'll anchor the popup. Must expose a * 'size' () and 'offset' (). */ diff --git a/lib/OpenLayers/Protocol.js b/lib/OpenLayers/Protocol.js index e6a4ae6f4f..beae1cf694 100644 --- a/lib/OpenLayers/Protocol.js +++ b/lib/OpenLayers/Protocol.js @@ -36,7 +36,7 @@ OpenLayers.Protocol = OpenLayers.Class({ /** * Property: defaultFilter - * {OpenLayers.Filter} Optional default filter to read requests + * {} Optional default filter to read requests */ defaultFilter: null, @@ -59,7 +59,7 @@ OpenLayers.Protocol = OpenLayers.Class({ * Merge filter passed to the read method with the default one * * Parameters: - * filter - {OpenLayers.Filter} + * filter - {} */ mergeWithDefaultFilter: function(filter) { var merged; @@ -231,10 +231,19 @@ OpenLayers.Protocol.Response = OpenLayers.Class({ /** * Property: features * {Array({})} or {} - * The features returned in the response by the server. + * The features returned in the response by the server. Depending on the + * protocol's read payload, either features or data will be populated. */ features: null, + /** + * Property: data + * {Object} + * The data returned in the response by the server. Depending on the + * protocol's read payload, either features or data will be populated. + */ + data: null, + /** * Property: reqFeatures * {Array({})} or {} diff --git a/lib/OpenLayers/Protocol/CSW.js b/lib/OpenLayers/Protocol/CSW.js new file mode 100644 index 0000000000..11703d9ffb --- /dev/null +++ b/lib/OpenLayers/Protocol/CSW.js @@ -0,0 +1,30 @@ +/* Copyright (c) 2006-2012 by OpenLayers Contributors (see authors.txt for + * full list of contributors). Published under the Clear BSD license. + * See http://svn.openlayers.org/trunk/openlayers/license.txt for the + * full text of the license. */ + +/** + * @requires OpenLayers/Protocol.js + */ + +/** + * Class: OpenLayers.Protocol.CSW + * Used to create a versioned CSW protocol. Default version is 2.0.2. + */ +OpenLayers.Protocol.CSW = function(options) { + options = OpenLayers.Util.applyDefaults( + options, OpenLayers.Protocol.CSW.DEFAULTS + ); + var cls = OpenLayers.Protocol.CSW["v"+options.version.replace(/\./g, "_")]; + if(!cls) { + throw "Unsupported CSW version: " + options.version; + } + return new cls(options); +}; + +/** + * Constant: OpenLayers.Protocol.CSW.DEFAULTS + */ +OpenLayers.Protocol.CSW.DEFAULTS = { + "version": "2.0.2" +}; diff --git a/lib/OpenLayers/Protocol/CSW/v2_0_2.js b/lib/OpenLayers/Protocol/CSW/v2_0_2.js new file mode 100644 index 0000000000..74418f3acd --- /dev/null +++ b/lib/OpenLayers/Protocol/CSW/v2_0_2.js @@ -0,0 +1,144 @@ +/* Copyright (c) 2006-2012 by OpenLayers Contributors (see authors.txt for + * full list of contributors). Published under the Clear BSD license. + * See http://svn.openlayers.org/trunk/openlayers/license.txt for the + * full text of the license. */ + +/** + * @requires OpenLayers/Protocol/CSW.js + * @requires OpenLayers/Format/CSWGetRecords/v2_0_2.js + */ + +/** + * Class: OpenLayers.Protocol.CSW.v2_0_2 + * CS-W (Catalogue services for the Web) version 2.0.2 protocol. + * + * Inherits from: + * - + */ +OpenLayers.Protocol.CSW.v2_0_2 = OpenLayers.Class(OpenLayers.Protocol, { + + /** + * Property: formatOptions + * {Object} Optional options for the format. If a format is not provided, + * this property can be used to extend the default format options. + */ + formatOptions: null, + + /** + * Constructor: OpenLayers.Protocol.CSW.v2_0_2 + * A class for CSW version 2.0.2 protocol management. + * + * Parameters: + * options - {Object} Optional object whose properties will be set on the + * instance. + */ + initialize: function(options) { + OpenLayers.Protocol.prototype.initialize.apply(this, [options]); + if(!options.format) { + this.format = new OpenLayers.Format.CSWGetRecords.v2_0_2(OpenLayers.Util.extend({ + }, this.formatOptions)); + } + }, + + /** + * APIMethod: destroy + * Clean up the protocol. + */ + destroy: function() { + if(this.options && !this.options.format) { + this.format.destroy(); + } + this.format = null; + OpenLayers.Protocol.prototype.destroy.apply(this); + }, + + /** + * Method: createCallback + * Returns a function that applies the given public method with resp and + * options arguments. + * + * Parameters: + * method - {Function} The method to be applied by the callback. + * response - {} The protocol response object. + * options - {Object} Options sent to the protocol method (read, create, + * update, or delete). + */ + createCallback: function(method, response, options) { + return OpenLayers.Function.bind(function() { + method.apply(this, [response, options]); + }, this); + }, + + /** + * Method: read + * Construct a request for reading new records from the Catalogue. + */ + read: function(options) { + options = OpenLayers.Util.extend({}, options); + OpenLayers.Util.applyDefaults(options, this.options || {}); + var response = new OpenLayers.Protocol.Response({requestType: "read"}); + + var data = this.format.write(options.params); + + response.priv = OpenLayers.Request.POST({ + url: options.url, + callback: this.createCallback(this.handleRead, response, options), + params: options.params, + headers: options.headers, + data: data + }); + + return response; + }, + + /** + * Method: handleRead + * Deal with response from the read request. + * + * Parameters: + * response - {} The response object to pass + * to the user callback. + * This response is given a code property, and optionally a data property. + * The latter represents the CSW records as returned by the call to + * the CSW format read method. + * options - {Object} The user options passed to the read call. + */ + handleRead: function(response, options) { + if(options.callback) { + var request = response.priv; + if(request.status >= 200 && request.status < 300) { + // success + response.data = this.parseData(request); + response.code = OpenLayers.Protocol.Response.SUCCESS; + } else { + // failure + response.code = OpenLayers.Protocol.Response.FAILURE; + } + options.callback.call(options.scope, response); + } + }, + + /** + * Method: parseData + * Read HTTP response body and return records + * + * Parameters: + * request - {XMLHttpRequest} The request object + * + * Returns: + * {Object} The CSW records as returned by the call to the format read method. + */ + parseData: function(request) { + var doc = request.responseXML; + if(!doc || !doc.documentElement) { + doc = request.responseText; + } + if(!doc || doc.length <= 0) { + return null; + } + return this.format.read(doc); + }, + + CLASS_NAME: "OpenLayers.Protocol.CSW.v2_0_2" + +}); diff --git a/lib/OpenLayers/Protocol/WFS/v1.js b/lib/OpenLayers/Protocol/WFS/v1.js index e531085842..53cd0a70ea 100644 --- a/lib/OpenLayers/Protocol/WFS/v1.js +++ b/lib/OpenLayers/Protocol/WFS/v1.js @@ -384,7 +384,7 @@ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, { * Send a request that deletes all features by their filter. * * Parameters: - * filter - {OpenLayers.Filter} filter + * filter - {} filter */ filterDelete: function(filter, options) { options = OpenLayers.Util.extend({}, options); diff --git a/lib/OpenLayers/Renderer/Elements.js b/lib/OpenLayers/Renderer/Elements.js index 2def983f27..49b4ab6f26 100644 --- a/lib/OpenLayers/Renderer/Elements.js +++ b/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: - * * yOrdering - {Boolean} Whether to use y-ordering - * * zIndexing - {Boolean} Whether to use z-indexing. Will be ignored + * 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. */ initialize: function(containerID, options) { diff --git a/lib/OpenLayers/Renderer/SVG.js b/lib/OpenLayers/Renderer/SVG.js index 5436af9246..e526e818a4 100644 --- a/lib/OpenLayers/Renderer/SVG.js +++ b/lib/OpenLayers/Renderer/SVG.js @@ -452,7 +452,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, { /** * Method: createRoot * - * Parameter: + * Parameters: * suffix - {String} suffix to append to the id * * Returns: diff --git a/lib/OpenLayers/Renderer/SVG2.js b/lib/OpenLayers/Renderer/SVG2.js index 4bb4c187ad..50e21919e6 100644 --- a/lib/OpenLayers/Renderer/SVG2.js +++ b/lib/OpenLayers/Renderer/SVG2.js @@ -387,7 +387,7 @@ OpenLayers.Renderer.SVG2 = OpenLayers.Class(OpenLayers.Renderer.NG, { /** * Method: createRoot * - * Parameter: + * Parameters: * suffix - {String} suffix to append to the id * * Returns: diff --git a/lib/OpenLayers/Strategy/Fixed.js b/lib/OpenLayers/Strategy/Fixed.js index aba9b848f1..e559f8c59e 100644 --- a/lib/OpenLayers/Strategy/Fixed.js +++ b/lib/OpenLayers/Strategy/Fixed.js @@ -105,7 +105,7 @@ OpenLayers.Strategy.Fixed = OpenLayers.Class(OpenLayers.Strategy, { * Add all features to the layer. * * Parameters: - * mapProjection - {OpenLayers.Projection} the map projection + * mapProjection - {} the map projection * resp - {Object} options to pass to protocol read. */ merge: function(mapProjection, resp) { diff --git a/lib/OpenLayers/Style.js b/lib/OpenLayers/Style.js index 4180089b84..1af88dfba2 100644 --- a/lib/OpenLayers/Style.js +++ b/lib/OpenLayers/Style.js @@ -111,7 +111,7 @@ OpenLayers.Style = OpenLayers.Class({ * rules - {Array()} List of rules to be added to the * style. * - * Return: + * Returns: * {} */ initialize: function(style, options) { @@ -202,7 +202,7 @@ OpenLayers.Style = OpenLayers.Class({ * Method: applySymbolizer * * Parameters: - * rule - {OpenLayers.Rule} + * rule - {} * style - {Object} * feature - {} * diff --git a/lib/OpenLayers/Style2.js b/lib/OpenLayers/Style2.js index ae32595036..8994baeb94 100644 --- a/lib/OpenLayers/Style2.js +++ b/lib/OpenLayers/Style2.js @@ -70,7 +70,7 @@ OpenLayers.Style2 = OpenLayers.Class({ * config - {Object} An object containing properties to be set on the * style. Any documented properties may be set at construction. * - * Return: + * Returns: * {} A new style object. */ initialize: function(config) { 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..0705020330 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)} + * + * Returns: + * {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. + * + * Valid options: + * 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.Util.getRenderedDimensions = function(contentHTML, size, options) { diff --git a/lib/deprecated.js b/lib/deprecated.js index abdc642867..dd6c0bcf57 100644 --- a/lib/deprecated.js +++ b/lib/deprecated.js @@ -23,6 +23,20 @@ * @requires OpenLayers/Geometry.js */ +/** + * About: Deprecated + * The deprecated.js script includes all methods, properties, and constructors + * that are not supported as part of the long-term API. If you use any of + * these, you have to explicitly include this script in your application. + * + * For example: + * (code) + * + * (end) + * + * You are strongly encouraged to avoid using deprecated functionality. The + * documentation here should point you to the supported alternatives. + */ /** * Namespace: OpenLayers.Class @@ -121,7 +135,7 @@ OpenLayers.Util.setOpacity = function(element, opacity) { * Safely stop the propagation of an event *without* preventing * the default browser action from occurring. * - * Parameter: + * Parameters: * evt - {Event} */ OpenLayers.Util.safeStopPropagation = function(evt) { @@ -2901,7 +2915,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class( * Call the setOpacity method of the appropriate parent class to set the * opacity. * - * Parameter: + * Parameters: * opacity - {Float} */ setOpacity: function (opacity) { diff --git a/tests/Control/Split.html b/tests/Control/Split.html index a307bdd2c2..86af76c56d 100644 --- a/tests/Control/Split.html +++ b/tests/Control/Split.html @@ -141,7 +141,7 @@ function test_isEligible(t) { - t.plan(9); + t.plan(10); var control = new OpenLayers.Control.Split(); var geometry = OpenLayers.Geometry.fromWKT("LINESTRING(0 1, 1 2)"); @@ -176,6 +176,9 @@ control.targetFilter.value = "baz"; t.eq(control.isEligible(feature), true, "feature is eligible if it matches filter"); + delete feature.geometry; + t.eq(control.isEligible(feature), false, "feature with no geometry is not eligible"); + control.destroy(); } diff --git a/tests/Handler/Path.html b/tests/Handler/Path.html index 24ab4c38fb..66548d624a 100644 --- a/tests/Handler/Path.html +++ b/tests/Handler/Path.html @@ -534,6 +534,43 @@ map.destroy(); } + function test_freehand_maxVertices(t) { + t.plan(1); + var map = new OpenLayers.Map("map", { + resolutions: [1] + }); + var layer = new OpenLayers.Layer.Vector("foo", { + maxExtent: new OpenLayers.Bounds(-10, -10, 10, 10), + isBaseLayer: true + }); + map.addLayer(layer); + var control = new OpenLayers.Control({}); + var log = {}; + var MAX_VERTICES = 2; + var doneCallback = function(geo) { + t.eq(geo.components.length, MAX_VERTICES, + 'When maxVertices is reached, the geometry is finalized automatically'); + }; + var handler = new OpenLayers.Handler.Path(control, + {'done': doneCallback}, + {freehand: true, + maxVertices: MAX_VERTICES}); + control.handler = handler; + map.addControl(control); + map.setCenter(new OpenLayers.LonLat(0, 0), 0); + + // mock up feature freehand drawing + handler.activate(); + var evt = {xy: new OpenLayers.Pixel(0, 0)}; + handler.mousemove(evt); + handler.mousedown(evt); + evt = {xy: new OpenLayers.Pixel(20, 20)}; + handler.mousemove(evt); + evt = {xy: new OpenLayers.Pixel(40, 40)}; + handler.mousemove(evt); + map.destroy(); + } + /** * Helper functions for editing method tests */ diff --git a/tests/Protocol/CSW.html b/tests/Protocol/CSW.html new file mode 100644 index 0000000000..11b4b5e997 --- /dev/null +++ b/tests/Protocol/CSW.html @@ -0,0 +1,90 @@ + + + + + + +
+
+ + diff --git a/tests/list-tests.html b/tests/list-tests.html index 7daa933355..ff53d566bd 100644 --- a/tests/list-tests.html +++ b/tests/list-tests.html @@ -185,6 +185,7 @@
  • Protocol/HTTP.html
  • Protocol/Script.html
  • Protocol/WFS.html
    • +
  • Protocol/CSW.html
  • Protocol/SOS.html
  • Renderer.html
  • Renderer/Canvas.html