Merge pull request #2178 from probins/classdesc

Use @classdesc notation.

src/ol/source/bingmapssource.js

@@ -17,6 +17,9 @@ goog.require('ol.tilegrid.XYZ');
 
 
 /**
+ * @classdesc
+ * Layer source for Bing Maps tile data.
+ *
  * @constructor
  * @extends {ol.source.TileImage}
  * @param {olx.source.BingMapsOptions} options Bing Maps options.

src/ol/source/geojsonsource.js

@@ -6,6 +6,9 @@ goog.require('ol.source.StaticVector');
 
 
 /**
+ * @classdesc
+ * Static vector source in GeoJSON format
+ *
  * @constructor
  * @extends {ol.source.StaticVector}
  * @fires ol.source.VectorEvent

src/ol/source/gpxsource.js

@@ -6,6 +6,9 @@ goog.require('ol.source.StaticVector');
 
 
 /**
+ * @classdesc
+ * Static vector source in GPX format
+ *
  * @constructor
  * @extends {ol.source.StaticVector}
  * @fires ol.source.VectorEvent

src/ol/source/igcsource.js

@@ -6,6 +6,9 @@ goog.require('ol.source.StaticVector');
 
 
 /**
+ * @classdesc
+ * Static vector source in IGC format
+ *
  * @constructor
  * @extends {ol.source.StaticVector}
  * @fires ol.source.VectorEvent

src/ol/source/imagecanvassource.js

@@ -8,6 +8,9 @@ goog.require('ol.source.Image');
 
 
 /**
+ * @classdesc
+ * Base class for image sources where a canvas element is the image.
+ *
  * @constructor
  * @extends {ol.source.Image}
  * @param {olx.source.ImageCanvasOptions} options

src/ol/source/imagesource.js

@@ -22,6 +22,9 @@ ol.source.ImageOptions;
 
 
 /**
+ * @classdesc
+ * Abstract base class for sources providing a single image.
+ *
  * @constructor
  * @extends {ol.source.Source}
  * @param {ol.source.ImageOptions} options Single image source options.

src/ol/source/imagestaticsource.js

@@ -8,6 +8,10 @@ goog.require('ol.source.Image');
 
 
 /**
+ * @classdesc
+ * An image source for 'static', that is, non-georeferenced, images.
+ * See examples/static-image for example.
+ *
  * @constructor
  * @extends {ol.source.Image}
  * @param {olx.source.ImageStaticOptions} options Options.

src/ol/source/imagevectorsource.js

@@ -16,6 +16,7 @@ goog.require('ol.vec.Mat4');
 
 
 /**
+ * @classdesc
  * An image source whose images are canvas elements into which vector features
  * read from a vector source (`ol.source.Vector`) are drawn. An
  * `ol.source.ImageVector` object is to be used as the `source` of an image

src/ol/source/imagewmssource.js

@@ -17,6 +17,9 @@ goog.require('ol.source.wms.ServerType');
 
 
 /**
+ * @classdesc
+ * Source for WMS servers providing single, untiled images.
+ *
  * @constructor
  * @extends {ol.source.Image}
  * @param {olx.source.ImageWMSOptions=} opt_options Options.

src/ol/source/kmlsource.js

@@ -6,6 +6,9 @@ goog.require('ol.source.StaticVector');
 
 
 /**
+ * @classdesc
+ * Static vector source in KML format
+ *
  * @constructor
  * @extends {ol.source.StaticVector}
  * @fires ol.source.VectorEvent

src/ol/source/mapguidesource.js

@@ -10,6 +10,9 @@ goog.require('ol.source.Image');
 
 
 /**
+ * @classdesc
+ * Source for images from Mapguide servers
+ *
  * @constructor
  * @extends {ol.source.Image}
  * @param {olx.source.MapGuideOptions} options Options.

src/ol/source/mapquestsource.js

@@ -9,6 +9,9 @@ goog.require('ol.source.XYZ');
 
 
 /**
+ * @classdesc
+ * Layer source for the MapQuest tile server.
+ *
  * @constructor
  * @extends {ol.source.XYZ}
  * @param {olx.source.MapQuestOptions=} opt_options MapQuest options.

src/ol/source/osmsource.js

@@ -7,6 +7,9 @@ goog.require('ol.source.XYZ');
 
 
 /**
+ * @classdesc
+ * Layer source for the OpenStreetMap tile server.
+ *
  * @constructor
  * @extends {ol.source.XYZ}
  * @param {olx.source.OSMOptions=} opt_options Open Street Map options.

src/ol/source/osmxmlsource.js

@@ -6,6 +6,9 @@ goog.require('ol.source.StaticVector');
 
 
 /**
+ * @classdesc
+ * Static vector source in OSMXML format
+ *
  * @constructor
  * @extends {ol.source.StaticVector}
  * @fires ol.source.VectorEvent

src/ol/source/source.js

@@ -33,6 +33,9 @@ ol.source.SourceOptions;
 
 
 /**
+ * @classdesc
+ * Abstract base class for {@link ol.layer.Layer} sources.
+ *
  * @constructor
  * @extends {ol.Observable}
  * @fires change Triggered when the state of the source changes.

src/ol/source/stamensource.js

@@ -79,6 +79,9 @@ ol.source.StamenProviderConfig = {
 
 
 /**
+ * @classdesc
+ * Layer source for the Stamen tile server.
+ *
  * @constructor
  * @extends {ol.source.XYZ}
  * @param {olx.source.StamenOptions} options Stamen options.

src/ol/source/tileimagesource.js

@@ -14,6 +14,9 @@ goog.require('ol.source.Tile');
 
 
 /**
+ * @classdesc
+ * Base class for sources providing images divided into a tile grid.
+ *
  * @constructor
  * @extends {ol.source.Tile}
  * @param {olx.source.TileImageOptions} options Image tile options.

src/ol/source/tilejsonsource.js

@@ -22,6 +22,9 @@ goog.require('ol.tilegrid.XYZ');
 
 
 /**
+ * @classdesc
+ * Layer source for tile data in TileJSON format.
+ *
  * @constructor
  * @extends {ol.source.TileImage}
  * @param {olx.source.TileJSONOptions} options TileJSON options.

src/ol/source/tilesource.js

@@ -24,6 +24,9 @@ ol.source.TileOptions;
 
 
 /**
+ * @classdesc
+ * Abstract base class for sources providing images divided into a tile grid.
+ *
  * @constructor
  * @extends {ol.source.Source}
  * @param {ol.source.TileOptions} options Tile source options.

src/ol/source/tilewmssource.js

@@ -21,6 +21,9 @@ goog.require('ol.source.wms.ServerType');
 
 
 /**
+ * @classdesc
+ * Layer source for tile data from WMS servers.
+ *
  * @constructor
  * @extends {ol.source.TileImage}
  * @param {olx.source.TileWMSOptions=} opt_options Tile WMS options.

src/ol/source/topojsonsource.js

@@ -6,6 +6,9 @@ goog.require('ol.source.StaticVector');
 
 
 /**
+ * @classdesc
+ * Static vector source in TopoJSON format
+ *
  * @constructor
  * @extends {ol.source.StaticVector}
  * @fires ol.source.VectorEvent

src/ol/source/vectorsource.js

@@ -39,6 +39,9 @@ ol.source.VectorEventType = {
 
 
 /**
+ * @classdesc
+ * Base class for vector sources.
+ *
  * @constructor
  * @extends {ol.source.Source}
  * @fires ol.source.VectorEvent

src/ol/source/wmtssource.js

@@ -26,6 +26,9 @@ ol.source.WMTSRequestEncoding = {
 
 
 /**
+ * @classdesc
+ * Layer source for tile data from WMTS servers.
+ *
  * @constructor
  * @extends {ol.source.TileImage}
  * @param {olx.source.WMTSOptions} options WMTS options.

src/ol/source/xyzsource.js

@@ -9,6 +9,9 @@ goog.require('ol.tilegrid.XYZ');
 
 
 /**
+ * @classdesc
+ * Layer source for tile data with URLs in a set XYZ format.
+ *
  * @constructor
  * @extends {ol.source.TileImage}
  * @param {olx.source.XYZOptions} options XYZ options.

src/ol/source/zoomifysource.js

@@ -23,6 +23,9 @@ ol.source.ZoomifyTierSizeCalculation = {
 
 
 /**
+ * @classdesc
+ * Layer source for tile data in Zoomify format.
+ *
  * @constructor
  * @extends {ol.source.TileImage}
  * @param {olx.source.ZoomifyOptions=} opt_options Options.