Separating jsdoc style docs into their own block. The new NaturalDocs doesn't parse these mixed blocks, giving us no class descriptions with the two together. (closes #1229)

git-svn-id: http://svn.openlayers.org/trunk/openlayers@5553 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2007-12-21 08:28:09 +00:00
parent 2447848e7f
commit 33e313b059
108 changed files with 381 additions and 160 deletions
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Control.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.ArgParser
 * 
 * Inherits from:
@@ -4,7 +4,9 @@

 /**
 * @requires OpenLayers/Control.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.Attribution
 * Add attribution from layers to the map display. Uses 'attribution' property
 * of each layer.
@@ -7,7 +7,9 @@
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/Handler/Drag.js
 * @requires OpenLayers/Handler/Feature.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.DragFeature
 * Move a feature with a drag.  Create a new control with the
 *     <OpenLayers.Control.DragFeature> constructor.
@@ -5,7 +5,9 @@
 /**
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/Handler/Drag.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.DragPan
 * DragPan control.
 *
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/Feature/Vector.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.DrawFeature
 * Draws features on a vector layer when active.
 *
@@ -9,9 +9,10 @@
 * @requires OpenLayers/Handler/Point.js
 * @requires OpenLayers/Handler/Path.js
 * @requires OpenLayers/Handler/Polygon.js
- *
- * Class: OpenLayers.Control.EditingToolbar
- 
+ */
+
+/**
+ * Class: OpenLayers.Control.EditingToolbar 
 */
 OpenLayers.Control.EditingToolbar = OpenLayers.Class(
  OpenLayers.Control.Panel, {
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/Handler/Keyboard.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.KeyboardDefaults
 * 
 * Inherits from:
@@ -4,7 +4,9 @@

 /** 
 * @requires OpenLayers/Control.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.LayerSwitcher
 *
 * Inherits from:
@@ -7,7 +7,9 @@
 * @requires OpenLayers/Control/DragFeature.js
 * @requires OpenLayers/Control/SelectFeature.js
 * @requires OpenLayers/Handler/Keyboard.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.ModifyFeature
 * Control to modify features.  When activated, a click renders the vertices
 *     of a feature - these vertices can then be dragged.  By default, the
@@ -4,7 +4,9 @@

 /**
 * @requires OpenLayers/Control.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.MouseDefaults
 *
 * Inherits from:
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Control.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.MousePosition
 */
 OpenLayers.Control.MousePosition = OpenLayers.Class(OpenLayers.Control, {
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/Control/MouseDefaults.js
- *
+ */
+
+/**
 * 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!!! 
@@ -6,7 +6,9 @@
 * @requires OpenLayers/Control/Panel.js
 * @requires OpenLayers/Control/Navigation.js
 * @requires OpenLayers/Control/ZoomBox.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.NavToolbar
 */
 OpenLayers.Control.NavToolbar = OpenLayers.Class(OpenLayers.Control.Panel, {
@@ -6,7 +6,9 @@
 * @requires OpenLayers/Control/ZoomBox.js
 * @requires OpenLayers/Control/DragPan.js
 * @requires OpenLayers/Handler/MouseWheel.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.Navigation
 * The navigation control handles map browsing with mouse events (dragging,
 *     double-clicking, and scrolling the wheel).  Create a new navigation 
@@ -6,7 +6,9 @@
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/BaseTypes.js
 * @requires OpenLayers/Events.js
- *
+ */
+
+/**
 * 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
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Control.js
- *
+ */
+
+/**
 * Class: OpenLayers.PanZoom
 * 
 * Inherits from:
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Control/PanZoom.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.PanZoomBar
 *
 * Inherits from:
@@ -4,7 +4,9 @@

 /**
 * @requires OpenLayers/Control.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Control.Panel
 *
 * Inherits from:
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Control.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.Permalink
 * 
 * Inherits from:
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Control.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.Scale
 * Display a small scale indicator on the map.
 * Inherits from:
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/Feature/Vector.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.SelectFeature
 * Selects vector features from a given layer on click or hover. 
 *
@@ -5,7 +5,9 @@
 /**
 * @requires OpenLayers/Control.js
 * @requires OpenLayers/Handler/Box.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.ZoomBox
 *
 * Inherits from:
@@ -4,7 +4,9 @@

 /**
 * @requires OpenLayers/Control.js
- *
+ */
+
+/**
 * Class: OpenLayers.Control.ZoomToMaxExtent 
 * Imlements a very simple button control. Designed to be used with a 
 * <OpenLayers.Control.Panel>.