Merge pull request #2178 from probins/classdesc

Use @classdesc notation.

src/ol/format/featureformat.js

@@ -5,7 +5,9 @@ goog.require('goog.functions');
 
 
 /**
- * ol.format.Feature subclasses provide the ability to decode and encode
+ * @classdesc
+ * Abstract base class for feature formats.
+ * {ol.format.Feature} subclasses provide the ability to decode and encode
  * {@link ol.Feature} objects from a variety of commonly used geospatial
  * file formats.  See the documentation for each format for more details.
  *

src/ol/format/geojsonformat.js

@@ -21,7 +21,8 @@ goog.require('ol.proj');
 
 
 /**
- * Provide access to features stored in the GeoJSON format.
+ * @classdesc
+ * Feature format for reading and writing data in the GeoJSON format.
  *
  * @constructor
  * @extends {ol.format.JSONFeature}

src/ol/format/gmlformat.js

@@ -24,6 +24,9 @@ goog.require('ol.xml');
 
 
 /**
+ * @classdesc
+ * Feature format for reading and writing data in the GML format.
+ *
  * @constructor
  * @param {olx.format.GMLOptions=} opt_options
  *     Optional configuration object.

src/ol/format/gpxformat.js

@@ -17,6 +17,9 @@ goog.require('ol.xml');
 
 
 /**
+ * @classdesc
+ * Feature format for reading and writing data in the GPX format.
+ *
  * @constructor
  * @extends {ol.format.XMLFeature}
  * @todo api

src/ol/format/igcformat.js

@@ -22,6 +22,9 @@ ol.format.IGCZ = {
 
 
 /**
+ * @classdesc
+ * Feature format for `*.igc` flight recording files.
+ *
  * @constructor
  * @extends {ol.format.TextFeature}
  * @param {olx.format.IGCOptions=} opt_options Options.

src/ol/format/jsonfeatureformat.js

@@ -9,6 +9,9 @@ goog.require('ol.format.FormatType');
 
 
 /**
+ * @classdesc
+ * Abstract base class for JSON feature formats.
+ *
  * @constructor
  * @extends {ol.format.Feature}
  */

src/ol/format/kmlformat.js

@@ -51,6 +51,9 @@ ol.format.KMLGxTrackObject_;
 
 
 /**
+ * @classdesc
+ * Feature format for reading and writing data in the KML format.
+ *
  * @constructor
  * @extends {ol.format.XMLFeature}
  * @param {olx.format.KMLOptions=} opt_options Options.

src/ol/format/osmxmlformat.js

@@ -16,6 +16,9 @@ goog.require('ol.xml');
 
 
 /**
+ * @classdesc
+ * Feature format for reading and writing data in the OSMXML format.
+ *
  * @constructor
  * @extends {ol.format.XMLFeature}
  * @todo api

src/ol/format/textfeatureformat.js

@@ -7,6 +7,9 @@ goog.require('ol.format.FormatType');
 
 
 /**
+ * @classdesc
+ * Abstract base class for text feature formats.
+ *
  * @constructor
  * @extends {ol.format.Feature}
  */

src/ol/format/topojsonformat.js

@@ -15,6 +15,9 @@ goog.require('ol.proj');
 
 
 /**
+ * @classdesc
+ * Feature format for reading and writing data in the TopoJSON format.
+ *
  * @constructor
  * @extends {ol.format.JSONFeature}
  * @param {olx.format.TopoJSONOptions=} opt_options Options.

src/ol/format/wfsformat.js

@@ -13,6 +13,9 @@ goog.require('ol.xml');
 
 
 /**
+ * @classdesc
+ * Feature format for reading and writing data in the WFS format.
+ *
  * @constructor
  * @param {olx.format.WFSOptions=} opt_options
  *     Optional configuration object.

src/ol/format/wmscapabilitiesformat.js

@@ -13,6 +13,9 @@ goog.require('ol.xml');
 
 
 /**
+ * @classdesc
+ * Format for reading WMS capabilities data
+ *
  * @constructor
  * @extends {ol.format.XML}
  * @todo api

src/ol/format/xmlfeatureformat.js

@@ -10,6 +10,9 @@ goog.require('ol.xml');
 
 
 /**
+ * @classdesc
+ * Abstract base class for XML feature formats.
+ *
  * @constructor
  * @extends {ol.format.Feature}
  */

src/ol/format/xmlformat.js

@@ -6,6 +6,9 @@ goog.require('ol.xml');
 
 
 /**
+ * @classdesc
+ * Generic format for reading non-feature XML data
+ *
  * @constructor
  */
 ol.format.XML = function() {