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
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer.js
 * @requires OpenLayers/Layer/Markers.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.Boxes
 * Draw divs as 'boxes' on the layer. 
 *
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer.js
 * @requires OpenLayers/Util.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.EventPane
 * Base class for 3rd party layers.  Create a new event pane layer with the
 * <OpenLayers.Layer.EventPane> constructor.
@@ -4,7 +4,9 @@

 /**
 * @requires OpenLayers/Layer.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.FixedZoomLevels
 *   Some Layers will already have established zoom levels (like google 
 *    or ve). Instead of trying to determine them and populate a resolutions[]
@@ -5,7 +5,9 @@
 /**
 * @requires OpenLayers/Layer/Vector.js
 * @requires OpenLayers/Ajax.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.GML
 * Create a vector layer by parsing a GML file. The GML file is
 *     passed in as a parameter.
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer/Markers.js
 * @requires OpenLayers/Ajax.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.GeoRSS
 * Add GeoRSS Point features to your map. 
 * 
@@ -7,7 +7,9 @@
 * @requires OpenLayers/Layer/SphericalMercator.js
 * @requires OpenLayers/Layer/EventPane.js
 * @requires OpenLayers/Layer/FixedZoomLevels.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.Google
 * 
 * Inherits from:
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Layer/HTTPRequest.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.Grid
 * Base class for layers that use a lattice of tiles.  Create a new grid
 * layer with the <OpenLayers.Layer.Grid> constructor.
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Layer.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.HTTPRequest
 * 
 * Inherits from: 
@@ -5,7 +5,9 @@
 /**
 * @requires OpenLayers/Layer.js
 * @requires OpenLayers/Tile/Image.js
- * 
+ */
+
+/**
 * 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
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Layer/Grid.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.KaMap
 * 
 * Inherits from:
@@ -4,7 +4,9 @@

 /**
 * @requires OpenLayers/Layer/Grid.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.MapServer
 * Instances of OpenLayers.Layer.MapServer are used to display
 * data from a MapServer CGI instance.
@@ -5,7 +5,9 @@
 
 /**
 * @requires OpenLayers/Layer/MapServer.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.MapServer.Untiled
 * Deprecated, to be removed in 3.0 - instead use OpenLayers.Layer.MapServer and 
 *     pass the option 'singleTile' as true.
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Layer.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.Markers
 * 
 * Inherits from:
@@ -5,7 +5,9 @@
 /**
 * @requires OpenLayers/Layer/EventPane.js
 * @requires OpenLayers/Layer/FixedZoomLevels.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.MultiMap
 * Note that MultiMap does not fully support the sphericalMercator
 * option. See Ticket #953 for more details.
@@ -1,6 +1,9 @@
-/** @requires OpenLayers/Layer.js
+/**
+ * @requires OpenLayers/Layer.js
 * @requires OpenLayers/Projection.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.SphericalMercator
 * A mixin for layers that wraps up the pieces neccesary to have a coordinate
 *     conversion for working with commercial APIs which use a spherical
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Layer/Grid.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.TMS
 * 
 * Inherits from:
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer/Markers.js
 * @requires OpenLayers/Ajax.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.Text
 * This layer creates markers given data in a text file.  The <location>
 *     property of the layer (specified as a property of the options argument
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Layer/Grid.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.TileCache
 * A read only TileCache layer.  Used to requests tiles cached by TileCache in
 *     a web accessible cache.  This means that you have to pre-populate your
@@ -6,7 +6,9 @@
 * @requires OpenLayers/Layer.js
 * @requires OpenLayers/Renderer.js
 * @requires OpenLayers/Feature/Vector.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.Vector
 * Instances of OpenLayers.Layer.Vector are used to render vector data from
 * a variety of sources. Create a new image layer with the
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer/EventPane.js
 * @requires OpenLayers/Layer/FixedZoomLevels.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.VirtualEarth
 * 
 * Inherits from:
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer/Vector.js
 * @requires OpenLayers/Layer/Markers.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.WFS
 * 
 * Inherits from:
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer/Grid.js
 * @requires OpenLayers/Tile/Image.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.WMS
 * Instances of OpenLayers.Layer.WMS are used to display data from OGC Web
 *     Mapping Services. Create a new WMS layer with the <OpenLayers.Layer.WMS>
@@ -5,7 +5,9 @@
 
 /**
 * @requires OpenLayers/Layer/WMS.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.WMS.Untiled
 * Deprecated, to be removed in 3.0 - instead use OpenLayers.Layer.WMS and 
 *     pass the option 'singleTile' as true.
@@ -5,7 +5,9 @@

 /**
 * @requires OpenLayers/Layer/Grid.js
- *
+ */
+
+/**
 * Class: OpenLayers.Layer.WorldWind
 * 
 * Inherits from:
@@ -6,7 +6,9 @@
 /**
 * @requires OpenLayers/Layer/EventPane.js
 * @requires OpenLayers/Layer/FixedZoomLevels.js
- * 
+ */
+
+/**
 * Class: OpenLayers.Layer.Yahoo
 * 
 * Inherits from: