diff --git a/lib/OpenLayers/Control/ArgParser.js b/lib/OpenLayers/Control/ArgParser.js index 5d71b36289..bafd822bf1 100644 --- a/lib/OpenLayers/Control/ArgParser.js +++ b/lib/OpenLayers/Control/ArgParser.js @@ -9,7 +9,12 @@ /** * Class: OpenLayers.Control.ArgParser - * + * The ArgParser control adds location bar querystring parsing functionality + * to an OpenLayers Map. + * When added to a Map control, on a page load/refresh, the Map will + * automatically take the href string and parse it for lon, lat, zoom, and + * layers information. + * * Inherits from: * - */ @@ -37,6 +42,7 @@ OpenLayers.Control.ArgParser = OpenLayers.Class(OpenLayers.Control, { * APIProperty: displayProjection * {} Requires proj4js support. * Projection used when reading the coordinates from the URL. This will + * * reproject the map coordinates from the URL into the map's * projection. * diff --git a/lib/OpenLayers/Control/Attribution.js b/lib/OpenLayers/Control/Attribution.js index 3d8a9f2f93..2395e019d9 100644 --- a/lib/OpenLayers/Control/Attribution.js +++ b/lib/OpenLayers/Control/Attribution.js @@ -8,8 +8,8 @@ /** * Class: OpenLayers.Control.Attribution - * Add attribution from layers to the map display. Uses 'attribution' property - * of each layer. + * The attribution control adds attribution from layers to the map display. + * It uses 'attribution' property of each layer. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/Button.js b/lib/OpenLayers/Control/Button.js index a1f3f01848..d99bdbe2b1 100644 --- a/lib/OpenLayers/Control/Button.js +++ b/lib/OpenLayers/Control/Button.js @@ -8,7 +8,8 @@ /** * Class: OpenLayers.Control.Button - * A very simple button controlfor use with . + * The Button control is a very simple push-button, for use with + * . * When clicked, the function trigger() is executed. * * Inherits from: @@ -39,4 +40,4 @@ OpenLayers.Control.Button = OpenLayers.Class(OpenLayers.Control, { trigger: function() {}, CLASS_NAME: "OpenLayers.Control.Button" -}); \ No newline at end of file +}); diff --git a/lib/OpenLayers/Control/DragFeature.js b/lib/OpenLayers/Control/DragFeature.js index 852bdeb4f3..220f6ebe64 100644 --- a/lib/OpenLayers/Control/DragFeature.js +++ b/lib/OpenLayers/Control/DragFeature.js @@ -11,8 +11,8 @@ /** * Class: OpenLayers.Control.DragFeature - * Move a feature with a drag. Create a new control with the - * constructor. + * The DragFeature control moves a feature with a drag of the mouse. Create a + * new control with the constructor. * * Inherits From: * - diff --git a/lib/OpenLayers/Control/DragPan.js b/lib/OpenLayers/Control/DragPan.js index f0034b7a57..8caf6b823a 100644 --- a/lib/OpenLayers/Control/DragPan.js +++ b/lib/OpenLayers/Control/DragPan.js @@ -9,7 +9,7 @@ /** * Class: OpenLayers.Control.DragPan - * DragPan control. + * The DragPan control pans the map with a drag of the mouse. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/DrawFeature.js b/lib/OpenLayers/Control/DrawFeature.js index 20c3b2bae5..adda7d0b73 100644 --- a/lib/OpenLayers/Control/DrawFeature.js +++ b/lib/OpenLayers/Control/DrawFeature.js @@ -10,7 +10,8 @@ /** * Class: OpenLayers.Control.DrawFeature - * Draws features on a vector layer when active. + * The DrawFeature control draws point, line or polygon features on a vector + * layer when active. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/EditingToolbar.js b/lib/OpenLayers/Control/EditingToolbar.js index f6e267242d..6a8173fd71 100644 --- a/lib/OpenLayers/Control/EditingToolbar.js +++ b/lib/OpenLayers/Control/EditingToolbar.js @@ -13,7 +13,10 @@ /** * Class: OpenLayers.Control.EditingToolbar - * + * The EditingToolbar is a panel of 4 controls to draw polygons, lines, + * points, or to navigate the map by panning. By default it appears in the + * upper right corner of the map. + * * Inherits from: * - */ diff --git a/lib/OpenLayers/Control/KeyboardDefaults.js b/lib/OpenLayers/Control/KeyboardDefaults.js index 7a421944c3..2ab4a604e5 100644 --- a/lib/OpenLayers/Control/KeyboardDefaults.js +++ b/lib/OpenLayers/Control/KeyboardDefaults.js @@ -10,7 +10,12 @@ /** * Class: OpenLayers.Control.KeyboardDefaults + * The KeyboardDefaults control adds panning and zooming functions, controlled + * with the keyboard. By default arrow keys pan, +/- keys zoom & Page Up/Page + * Down/Home/End scroll by three quarters of a page. * + * This control has no visible appearance. + * * Inherits from: * - */ diff --git a/lib/OpenLayers/Control/LayerSwitcher.js b/lib/OpenLayers/Control/LayerSwitcher.js index bfacd10c5e..e6913fd31f 100644 --- a/lib/OpenLayers/Control/LayerSwitcher.js +++ b/lib/OpenLayers/Control/LayerSwitcher.js @@ -8,7 +8,14 @@ /** * Class: OpenLayers.Control.LayerSwitcher + * The LayerSwitcher control displays a table of contents for the map. This + * allows the user interface to switch between BaseLasyers and to show or hide + * Overlays. By default the switcher is shown minimized on the right edge of + * the map, the user may expand it by clicking on the handle. * + * To create the LayerSwitcher outside of the map, pass the Id of a html div + * as the first argument to the constructor. + * * Inherits from: * - */ diff --git a/lib/OpenLayers/Control/MouseDefaults.js b/lib/OpenLayers/Control/MouseDefaults.js index bbe045f399..d1296975eb 100644 --- a/lib/OpenLayers/Control/MouseDefaults.js +++ b/lib/OpenLayers/Control/MouseDefaults.js @@ -8,6 +8,9 @@ /** * Class: OpenLayers.Control.MouseDefaults + * This class is DEPRECATED in 2.4 and will be removed by 3.0. + * If you need this functionality, use + * instead!!! * * This class is DEPRECATED in 2.4 and will be removed by 3.0. * If you need this functionality, use Control.Navigation instead!!! diff --git a/lib/OpenLayers/Control/MousePosition.js b/lib/OpenLayers/Control/MousePosition.js index ff71bae5d1..320ea51745 100644 --- a/lib/OpenLayers/Control/MousePosition.js +++ b/lib/OpenLayers/Control/MousePosition.js @@ -9,6 +9,8 @@ /** * Class: OpenLayers.Control.MousePosition + * The MousePosition control displays geographic coordinates of the mouse + * pointer, as it is moved about the map. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/MouseToolbar.js b/lib/OpenLayers/Control/MouseToolbar.js index 648da12dcc..957b6da235 100644 --- a/lib/OpenLayers/Control/MouseToolbar.js +++ b/lib/OpenLayers/Control/MouseToolbar.js @@ -11,7 +11,8 @@ /** * Class: OpenLayers.Control.MouseToolbar * This class is DEPRECATED in 2.4 and will be removed by 3.0. - * If you need this functionality, use Control.NavToolbar instead!!! + * If you need this functionality, use + * instead!!! */ OpenLayers.Control.MouseToolbar = OpenLayers.Class( OpenLayers.Control.MouseDefaults, { diff --git a/lib/OpenLayers/Control/OverviewMap.js b/lib/OpenLayers/Control/OverviewMap.js index cb21733c09..03c92b836a 100644 --- a/lib/OpenLayers/Control/OverviewMap.js +++ b/lib/OpenLayers/Control/OverviewMap.js @@ -10,8 +10,10 @@ /** * Class: OpenLayers.Control.OverviewMap - * Create an overview map to display the extent of your main map and provide - * additional navigation control. Create a new overview map with the + * The OverMap control creates a small overview map, useful to display the + * extent of a zoomed map and your main map and provide additional + * navigation options to the User. By default the overview map is drawn in + * the lower right corner of the main map. Create a new overview map with the * constructor. * * Inerits from: diff --git a/lib/OpenLayers/Control/Pan.js b/lib/OpenLayers/Control/Pan.js index 69c3f47751..db3e217ede 100644 --- a/lib/OpenLayers/Control/Pan.js +++ b/lib/OpenLayers/Control/Pan.js @@ -8,6 +8,8 @@ /** * Class: OpenLayers.Control.Pan + * The Pan control is a single button to pan the map in one direction. For + * a more complete control see . * * Inherits from: * - @@ -80,4 +82,4 @@ OpenLayers.Control.Pan = OpenLayers.Class(OpenLayers.Control, { OpenLayers.Control.Pan.NORTH = "North"; OpenLayers.Control.Pan.SOUTH = "South"; OpenLayers.Control.Pan.EAST = "East"; -OpenLayers.Control.Pan.WEST = "West"; \ No newline at end of file +OpenLayers.Control.Pan.WEST = "West"; diff --git a/lib/OpenLayers/Control/PanPanel.js b/lib/OpenLayers/Control/PanPanel.js index 9ef27f9eaf..afb608174e 100644 --- a/lib/OpenLayers/Control/PanPanel.js +++ b/lib/OpenLayers/Control/PanPanel.js @@ -5,7 +5,10 @@ /** * Class: OpenLayers.Control.PanPanel - * + * The PanPanel is visible control for panning the map North, South, East or + * West in small steps. By default it is drawn in the top left corner of the + * map. + * * Note: If you wish to use this class with the default images and you want * it to look nice in ie6, you should add the following, conditionally * added css stylesheet to your HTML file: diff --git a/lib/OpenLayers/Control/PanZoom.js b/lib/OpenLayers/Control/PanZoom.js index 530b11966f..f2f6cd16b1 100644 --- a/lib/OpenLayers/Control/PanZoom.js +++ b/lib/OpenLayers/Control/PanZoom.js @@ -9,7 +9,10 @@ /** * Class: OpenLayers.Control.PanZoom - * + * The PanZoom is a visible control, composed of a + * and a . By + * default it is drawn in the upper left corner of the map. + * * Inherits from: * - */ diff --git a/lib/OpenLayers/Control/PanZoomBar.js b/lib/OpenLayers/Control/PanZoomBar.js index 8debba2319..797f2c1ac4 100644 --- a/lib/OpenLayers/Control/PanZoomBar.js +++ b/lib/OpenLayers/Control/PanZoomBar.js @@ -9,6 +9,10 @@ /** * Class: OpenLayers.Control.PanZoomBar + * The PanZoomBar is a visible control composed of a + * and a . + * By default it is displayed in the upper left corner of the map as 4 + * directional arrows above a vertical slider. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/Panel.js b/lib/OpenLayers/Control/Panel.js index f147c7d602..fa425e33a6 100644 --- a/lib/OpenLayers/Control/Panel.js +++ b/lib/OpenLayers/Control/Panel.js @@ -8,6 +8,8 @@ /** * Class: OpenLayers.Control.Panel + * The Panel control is a container for other controls. With it toolbars + * may be composed. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/Permalink.js b/lib/OpenLayers/Control/Permalink.js index 34013a7023..b5c77e49bb 100644 --- a/lib/OpenLayers/Control/Permalink.js +++ b/lib/OpenLayers/Control/Permalink.js @@ -10,7 +10,11 @@ /** * Class: OpenLayers.Control.Permalink - * + * The Permalink control is hyperlink that will return the user to the + * current map view. By default it is drawn in the lower right corner of the + * map. The href is updated as the map is zoomed, panned and whilst layers + * are switched. + * ` * Inherits from: * - */ diff --git a/lib/OpenLayers/Control/Scale.js b/lib/OpenLayers/Control/Scale.js index 82afb107c3..3d5141a257 100644 --- a/lib/OpenLayers/Control/Scale.js +++ b/lib/OpenLayers/Control/Scale.js @@ -9,7 +9,8 @@ /** * Class: OpenLayers.Control.Scale - * Display a small scale indicator on the map. + * The Scale control displays the current map scale as a ratio (e.g. Scale = + * 1:1M). By default it is displayed in the lower right corner of the map. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/ScaleLine.js b/lib/OpenLayers/Control/ScaleLine.js index 9ef32069fe..e29256b2b9 100644 --- a/lib/OpenLayers/Control/ScaleLine.js +++ b/lib/OpenLayers/Control/ScaleLine.js @@ -8,7 +8,9 @@ /** * Class: OpenLayers.Control.ScaleLine - * Display a small line indicator representing the current map scale on the map. + * The ScaleLine displays a small line indicator representing the current + * map scale on the map. By default it is drawn in the lower left corner of + * the map. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/SelectFeature.js b/lib/OpenLayers/Control/SelectFeature.js index 6f2ac2faa7..b5cfb52a3f 100644 --- a/lib/OpenLayers/Control/SelectFeature.js +++ b/lib/OpenLayers/Control/SelectFeature.js @@ -11,7 +11,8 @@ /** * Class: OpenLayers.Control.SelectFeature - * Selects vector features from a given layer on click or hover. + * The SelectFeature control selects vector features from a given layer on + * click or hover. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/ZoomBox.js b/lib/OpenLayers/Control/ZoomBox.js index c83ed80b3b..7a45ff6980 100644 --- a/lib/OpenLayers/Control/ZoomBox.js +++ b/lib/OpenLayers/Control/ZoomBox.js @@ -9,6 +9,9 @@ /** * Class: OpenLayers.Control.ZoomBox + * The ZoomBox control enables zooming directly to a given extent, by drawing + * a box on the map. The box is drawn by holding down shift, whilst dragging + * the mouse. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/ZoomIn.js b/lib/OpenLayers/Control/ZoomIn.js index 9acd5222eb..78764e0e71 100644 --- a/lib/OpenLayers/Control/ZoomIn.js +++ b/lib/OpenLayers/Control/ZoomIn.js @@ -8,6 +8,7 @@ /** * Class: OpenLayers.Control.ZoomIn + * The ZoomIn control is a button to increase the zoom level of a map. * * Inherits from: * - @@ -30,4 +31,4 @@ OpenLayers.Control.ZoomIn = OpenLayers.Class(OpenLayers.Control, { }, CLASS_NAME: "OpenLayers.Control.ZoomIn" -}); \ No newline at end of file +}); diff --git a/lib/OpenLayers/Control/ZoomOut.js b/lib/OpenLayers/Control/ZoomOut.js index 7b2c686750..9f17d4b8a6 100644 --- a/lib/OpenLayers/Control/ZoomOut.js +++ b/lib/OpenLayers/Control/ZoomOut.js @@ -8,6 +8,7 @@ /** * Class: OpenLayers.Control.ZoomOut + * The ZoomOut control is a button to decrease the zoom level of a map. * * Inherits from: * - diff --git a/lib/OpenLayers/Control/ZoomPanel.js b/lib/OpenLayers/Control/ZoomPanel.js index 026eb9c21e..12d22dd0db 100644 --- a/lib/OpenLayers/Control/ZoomPanel.js +++ b/lib/OpenLayers/Control/ZoomPanel.js @@ -11,7 +11,11 @@ /** * Class: OpenLayers.Control.ZoomPanel - * + * The ZoomPanel control is a compact collecton of 3 zoom controls - a + * , a , and a + * . By default it is drawn in the upper left + * corner of the map. + * * Note: If you wish to use this class with the default images and you want * it to look nice in ie6, you should add the following, conditionally * added css stylesheet to your HTML file: diff --git a/lib/OpenLayers/Control/ZoomToMaxExtent.js b/lib/OpenLayers/Control/ZoomToMaxExtent.js index 7d5a00683a..74511732a8 100644 --- a/lib/OpenLayers/Control/ZoomToMaxExtent.js +++ b/lib/OpenLayers/Control/ZoomToMaxExtent.js @@ -8,7 +8,8 @@ /** * Class: OpenLayers.Control.ZoomToMaxExtent - * Implements a very simple button control. Designed to be used with a + * The ZoomToMaxExtent control is a button that zooms out to the maximum + * extent of the map. It is designed to be used with a * . * * Inherits from: