Add @classdesc to classes

src/ol/attribution.js

@@ -5,7 +5,8 @@ goog.require('ol.TileRange');
 
 
 /**
- * Create a new attribution to be associated with a layer source.
+ * @classdesc
+ * An attribution for a layer source.
  *
  * Example:
  *

src/ol/collection.js

@@ -65,7 +65,12 @@ ol.CollectionProperty = {
 
 
 /**
- * A mutable MVC Array.
+ * @classdesc
+ * Adds methods to standard Array; changes (add/remove) to the Collection
+ * trigger events. Because a Collection is itself an {@link ol.Object}, it
+ * can be bound to any other Object or Collection such that a change in one
+ * will automatically be reflected in the other.
+ *
  * @constructor
  * @extends {ol.Object}
  * @fires ol.CollectionEvent

src/ol/control/attributioncontrol.js

@@ -13,10 +13,12 @@ goog.require('ol.css');
 
 
 /**
- * Create a new attribution control to show all the attributions associated
- * with the layer sources in the map. A default map has this control included.
- * By default it will show in the bottom right portion of the map, but it can
+ * @classdesc
+ * Control to show all the attributions associated with the layer sources
+ * in the map. This control is one of the default controls included in maps.
+ * By default it will show in the bottom right portion of the map, but this can
  * be changed by using a css selector for `.ol-attribution`.
+ *
  * @constructor
  * @extends {ol.control.Control}
  * @param {olx.control.AttributionOptions=} opt_options Attribution options.

src/ol/control/control.js

@@ -9,8 +9,12 @@ goog.require('ol.Object');
 
 
 /**
- * Something to be painted over the map to provide a means for interaction
- * (buttons) or to show annotations (status bars).
+ * @classdesc
+ * Abstract parent class for controls.
+ * A control is a visible widget with a DOM element in a fixed position on the
+ * screen. They can involve user input (buttons), or be informational only;
+ * the position is determined using CSS. By default these are part of the map
+ * container, but can use any outside DOM element.
  *
  * @constructor
  * @extends {ol.Object}

src/ol/control/controldefaults.js

@@ -8,12 +8,15 @@ goog.require('ol.control.Zoom');
 
 
 /**
- * Set of default controls. Unless configured otherwise, this returns a
- * collection containing an instance of each of the following controls:
+ * @classdesc
+ * Set of controls included in maps by default. Unless configured otherwise,
+ * this returns a collection containing an instance of each of the following
+ * controls:
  * * {@link ol.control.Zoom}
  * * {@link ol.control.Rotate}
  * * {@link ol.control.Attribution}
  * * {@link ol.control.Logo}
+ *
  * @param {olx.control.DefaultsOptions=} opt_options Defaults options.
  * @return {ol.Collection} Controls.
  * @todo api

src/ol/control/fullscreencontrol.js

@@ -15,6 +15,7 @@ goog.require('ol.pointer.PointerEventHandler');
 
 
 /**
+ * @classdesc
  * Provides a button that when clicked fills up the full screen with the map.
  * When in full screen mode, a close button is shown to exit full screen mode.
  * The [Fullscreen API](http://www.w3.org/TR/fullscreen/) is used to

src/ol/control/logocontrol.js

@@ -10,10 +10,12 @@ goog.require('ol.css');
 
 
 /**
+ * @classdesc
  * Shows a logo for all the layer sources in the map that have a logo
  * associated with them, such as Bing. This control is part of a default map.
  * By default it will show in the bottom-left portion of the map, but it can
  * be styled by using a css selector for `.ol-logo`.
+ *
  * @constructor
  * @extends {ol.control.Control}
  * @param {olx.control.LogoOptions=} opt_options Logo options.

src/ol/control/mousepositioncontrol.js

@@ -28,10 +28,11 @@ ol.control.MousePositionProperty = {
 
 
 /**
- * Create a new control to show the position of the mouse in the map's
- * projection (or any other supplied projection). By default the control is
- * shown in the top right corner of the map but this can be changed by using
- * a css selector `.ol-mouse-position`.
+ * @classdesc
+ * A control to show the 2D coordinates of the mouse cursor. By default, these
+ * are in the view projection, but can be in any supported projection.
+ * By default the control is shown in the top right corner of the map, but this
+ * can be changed by using the css selector `.ol-mouse-position`.
  *
  * @constructor
  * @extends {ol.control.Control}

src/ol/control/rotatecontrol.js

@@ -17,8 +17,10 @@ goog.require('ol.pointer.PointerEventHandler');
 
 
 /**
- * Create a new control with a button, to reset rotation to 0.
+ * @classdesc
+ * A button control to reset rotation to 0.
  * To style this control use css selector `.ol-rotate`.
+ *
  * @constructor
  * @extends {ol.control.Control}
  * @param {olx.control.RotateOptions=} opt_options Rotate options.

src/ol/control/scalelinecontrol.js

@@ -42,9 +42,10 @@ ol.control.ScaleLineUnits = {
 
 
 /**
- * Create a control to help users estimate distances on a map.
- * By default it will show in the bottom left portion of the map, but it can
- * be changed by using a css selector for `.ol-scale-line`.
+ * @classdesc
+ * A control displaying rough x-axis distances.
+ * By default it will show in the bottom left portion of the map, but this can
+ * be changed by using the css selector `.ol-scale-line`.
  *
  * @constructor
  * @extends {ol.control.Control}

src/ol/control/zoomcontrol.js

@@ -17,9 +17,11 @@ goog.require('ol.pointer.PointerEventHandler');
 
 
 /**
- * Create a new control with 2 buttons, one for zoom in and one for zoom out.
- * This control is part of the default controls of a map. To style this control
+ * @classdesc
+ * A control with 2 buttons, one for zoom in and one for zoom out.
+ * This control is one of the default controls of a map. To style this control
  * use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
+ *
  * @constructor
  * @extends {ol.control.Control}
  * @param {olx.control.ZoomOptions=} opt_options Zoom options.

src/ol/control/zoomslidercontrol.js

@@ -23,6 +23,7 @@ goog.require('ol.easing');
 
 
 /**
+ * @classdesc
  * A slider type of control for zooming.
  *
  * Example:

src/ol/control/zoomtoextentcontrol.js

@@ -14,9 +14,10 @@ goog.require('ol.pointer.PointerEventHandler');
 
 
 /**
- * Create a control that adds a button, which, when pressed, changes
- * the map view to a specific extent. To style this control use the
- * css selector `.ol-zoom-extent`.
+ * @classdesc
+ * A button control which, when pressed, changes the map view to a specific
+ * extent. To style this control use the css selector `.ol-zoom-extent`.
+ *
  * @constructor
  * @extends {ol.control.Control}
  * @param {olx.control.ZoomToExtentOptions=} opt_options Options.

src/ol/deviceorientation.js

@@ -21,6 +21,7 @@ ol.DeviceOrientationProperty = {
 
 
 /**
+ * @classdesc
  * The ol.DeviceOrientation class provides access to DeviceOrientation
  * information and events, see the [HTML 5 DeviceOrientation Specification](
  * http://www.w3.org/TR/orientation-event/) for more details.

src/ol/dom/input.js

@@ -18,6 +18,7 @@ ol.dom.InputProperty = {
 
 
 /**
+ * @classdesc
  * Helper class for binding HTML input to an {@link ol.Object}.
  *
  * Example:

src/ol/feature.js

@@ -16,6 +16,12 @@ goog.require('ol.style.Style');
 
 
 /**
+ * @classdesc
+ * A vector object for geographical features with a geometry and other
+ * attribute properties, similar to the features in vector file formats like
+ * GeoJSON.
+ * Features can be styled individually or use the style of their vector layer.
+ *
  * @constructor
  * @extends {ol.Object}
  * @fires change Triggered when the geometry or style of the feature changes.

src/ol/featureoverlay.js

@@ -15,6 +15,14 @@ goog.require('ol.style.ImageState');
 
 
 /**
+ * @classdesc
+ * A mechanism for changing the style of a small number of features on a
+ * temporary basis, for example highlighting. This is necessary with the Canvas
+ * renderer, where, unlike in SVG, features cannot be individually referenced.
+ * See examples/vector-layers for an example: create a FeatureOverlay with a
+ * different style, copy the feature(s) you want rendered in this different
+ * style into it, and then remove them again when you're finished.
+ *
  * @constructor
  * @param {olx.FeatureOverlayOptions=} opt_options Options.
  * @todo api

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() {

src/ol/geolocation.js

@@ -35,6 +35,7 @@ ol.GeolocationProperty = {
 
 
 /**
+ * @classdesc
  * Helper class for providing HTML5 Geolocation capabilities.
  * The [Geolocation API](http://www.w3.org/TR/geolocation-API/)
  * is used to locate a user's position.

src/ol/geom/circle.js

@@ -9,6 +9,9 @@ goog.require('ol.geom.flat.deflate');
 
 
 /**
+ * @classdesc
+ * Circle geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawPoint} center Center.

src/ol/geom/geometry.js

@@ -44,6 +44,9 @@ ol.geom.GeometryLayout = {
 
 
 /**
+ * @classdesc
+ * Abstract base class for vector geometries.
+ *
  * @constructor
  * @extends {ol.Observable}
  * @fires change Triggered when the geometry changes.

src/ol/geom/geometrycollection.js

@@ -12,6 +12,9 @@ goog.require('ol.geom.GeometryType');
 
 
 /**
+ * @classdesc
+ * An array of {@link ol.geom.Geometry} objects.
+ *
  * @constructor
  * @extends {ol.geom.Geometry}
  * @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.

src/ol/geom/linearring.js

@@ -12,6 +12,9 @@ goog.require('ol.geom.flat.simplify');
 
 
 /**
+ * @classdesc
+ * Linear ring geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawLinearRing} coordinates Coordinates.

src/ol/geom/linestring.js

@@ -15,6 +15,9 @@ goog.require('ol.geom.flat.simplify');
 
 
 /**
+ * @classdesc
+ * Linestring geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawLineString} coordinates Coordinates.

src/ol/geom/multilinestring.js

@@ -15,6 +15,9 @@ goog.require('ol.geom.flat.simplify');
 
 
 /**
+ * @classdesc
+ * Multi-linestring geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawMultiLineString} coordinates Coordinates.

src/ol/geom/multipoint.js

@@ -13,6 +13,9 @@ goog.require('ol.math');
 
 
 /**
+ * @classdesc
+ * Multi-point geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawMultiPoint} coordinates Coordinates.

src/ol/geom/multipolygon.js

@@ -20,6 +20,9 @@ goog.require('ol.geom.flat.simplify');
 
 
 /**
+ * @classdesc
+ * Multi-polygon geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawMultiPolygon} coordinates Coordinates.

src/ol/geom/point.js

@@ -10,6 +10,9 @@ goog.require('ol.math');
 
 
 /**
+ * @classdesc
+ * Point geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawPoint} coordinates Coordinates.

src/ol/geom/polygon.js

@@ -20,6 +20,9 @@ goog.require('ol.geom.flat.simplify');
 
 
 /**
+ * @classdesc
+ * Polygon geometry.
+ *
  * @constructor
  * @extends {ol.geom.SimpleGeometry}
  * @param {ol.geom.RawPolygon} coordinates Coordinates.

src/ol/geom/simplegeometry.js

@@ -10,6 +10,9 @@ goog.require('ol.geom.flat.transform');
 
 
 /**
+ * @classdesc
+ * Abstract base class for geometry objects
+ *
  * @constructor
  * @extends {ol.geom.Geometry}
  * @todo api

src/ol/interaction/doubleclickzoominteraction.js

@@ -10,6 +10,7 @@ goog.require('ol.interaction.Interaction');
 
 
 /**
+ * @classdesc
  * Allows the user to zoom by double-clicking on the map.
  *
  * @constructor

src/ol/interaction/draganddropinteraction.js

@@ -16,6 +16,9 @@ goog.require('ol.proj');
 
 
 /**
+ * @classdesc
+ * Handles input of vector data by drag and drop.
+ *
  * @constructor
  * @extends {ol.interaction.Interaction}
  * @fires ol.interaction.DragAndDropEvent

src/ol/interaction/dragboxinteraction.js

@@ -44,6 +44,7 @@ ol.DragBoxEventType = {
 
 
 /**
+ * @classdesc
  * Object representing a dragbox event.
  *
  * @param {string} type The event type.
@@ -69,6 +70,7 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
 
 
 /**
+ * @classdesc
  * Allows the user to zoom the map by clicking and dragging on the map,
  * normally combined with an {@link ol.events.condition} that limits
  * it to when the shift key is held down.

src/ol/interaction/dragpaninteraction.js

@@ -14,7 +14,9 @@ goog.require('ol.interaction.Pointer');
 
 
 /**
+ * @classdesc
  * Allows the user to pan the map by dragging the map.
+ *
  * @constructor
  * @extends {ol.interaction.Pointer}
  * @param {olx.interaction.DragPanOptions=} opt_options Options.

src/ol/interaction/dragrotateandzoominteraction.js

@@ -15,6 +15,7 @@ goog.require('ol.interaction.Pointer');
 
 
 /**
+ * @classdesc
  * Allows the user to zoom and rotate the map by clicking and dragging
  * on the map.  By default, this interaction is limited to when the shift
  * key is held down.

src/ol/interaction/dragrotateinteraction.js

@@ -11,6 +11,7 @@ goog.require('ol.interaction.Pointer');
 
 
 /**
+ * @classdesc
  * Allows the user to rotate the map by clicking and dragging on the map,
  * normally combined with an {@link ol.events.condition} that limits
  * it to when the alt and shift keys are held down.

src/ol/interaction/dragzoominteraction.js

@@ -12,9 +12,11 @@ goog.require('ol.style.Style');
 
 
 /**
+ * @classdesc
  * Allows the user to zoom the map by clicking and dragging on the map,
  * normally combined with an {@link ol.events.condition} that limits
  * it to when the shift key is held down.
+ *
  * @constructor
  * @extends {ol.interaction.DragBox}
  * @param {olx.interaction.DragZoomOptions=} opt_options Options.

src/ol/interaction/drawinteraction.js

@@ -66,7 +66,9 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
 
 
 /**
- * Interaction that allows drawing geometries
+ * @classdesc
+ * Interaction that allows drawing geometries.
+ *
  * @constructor
  * @extends {ol.interaction.Pointer}
  * @fires ol.DrawEvent

src/ol/interaction/interaction.js

@@ -12,6 +12,13 @@ goog.require('ol.easing');
 
 
 /**
+ * @classdesc
+ * User actions that change the state of the map. Some are similar to controls,
+ * but are not associated with a DOM element.
+ * For example, {@link ol.interaction.KeyboardZoom} is functionally the same as
+ * {@link ol.control.Zoom}, but triggered by a keyboard event not a button
+ * element event.
+ *
  * @constructor
  * @extends {ol.Observable}
  */

src/ol/interaction/interactiondefaults.js

@@ -14,11 +14,11 @@ goog.require('ol.interaction.PinchZoom');
 
 
 /**
- * This method is a convenience method to create a set of interactions
- * to be used with an {@link ol.Map}.  Specific interactions can be excluded by
- * setting the appropriate option to false in the constructor options,
- * but the order of the interactions is fixed.  If you want to specify a
- * different order for interactions, you will need to create your own
+ * @classdesc
+ * Set of interactions included in maps by default. Specific interactions can be
+ * excluded by setting the appropriate option to false in the constructor
+ * options, but the order of the interactions is fixed.  If you want to specify
+ * a different order for interactions, you will need to create your own
  * {@link ol.interaction.Interaction} instances and insert them into a
  * {@link ol.Collection} in the order you want before creating your
  * {@link ol.Map} instance. The default set of interactions, in sequence, is:
@@ -31,6 +31,7 @@ goog.require('ol.interaction.PinchZoom');
  * * {@link ol.interaction.KeyboardZoom}
  * * {@link ol.interaction.MouseWheelZoom}
  * * {@link ol.interaction.DragZoom}
+ *
  * @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
  * @return {ol.Collection} A collection of interactions to be used with
  * the ol.Map constructor's interactions option.

src/ol/interaction/keyboardpaninteraction.js

@@ -16,6 +16,7 @@ goog.require('ol.interaction.Interaction');
 
 
 /**
+ * @classdesc
  * Allows the user to pan the map using keyboard arrows.
  * Note that, although this interaction is by default included in maps,
  * the keys can only be used when browser focus is on the element to which
@@ -25,6 +26,7 @@ goog.require('ol.interaction.Interaction');
  * focus will have to be on, and returned to, this element if the keys are to
  * function.
  * See also {@link ol.interaction.KeyboardZoom}.
+ *
  * @constructor
  * @extends {ol.interaction.Interaction}
  * @param {olx.interaction.KeyboardPanOptions=} opt_options Options.

src/ol/interaction/keyboardzoominteraction.js

@@ -11,6 +11,7 @@ goog.require('ol.interaction.Interaction');
 
 
 /**
+ * @classdesc
  * Allows the user to zoom the map using keyboard + and -.
  * Note that, although this interaction is by default included in maps,
  * the keys can only be used when browser focus is on the element to which
@@ -20,6 +21,7 @@ goog.require('ol.interaction.Interaction');
  * focus will have to be on, and returned to, this element if the keys are to
  * function.
  * See also {@link ol.interaction.KeyboardPan}.
+ *
  * @constructor
  * @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
  * @extends {ol.interaction.Interaction}

src/ol/interaction/modifyinteraction.js

@@ -37,6 +37,9 @@ ol.interaction.SegmentDataType;
 
 
 /**
+ * @classdesc
+ * Interaction for modifying vector data.
+ *
  * @constructor
  * @extends {ol.interaction.Pointer}
  * @param {olx.interaction.ModifyOptions} options Options.

src/ol/interaction/mousewheelzoominteraction.js

@@ -13,7 +13,9 @@ goog.require('ol.interaction.Interaction');
 
 
 /**
+ * @classdesc
  * Allows the user to zoom the map by scrolling the mouse wheel.
+ *
  * @constructor
  * @extends {ol.interaction.Interaction}
  * @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.

src/ol/interaction/pinchrotateinteraction.js

@@ -13,8 +13,10 @@ goog.require('ol.interaction.Pointer');
 
 
 /**
+ * @classdesc
  * Allows the user to rotate the map by twisting with two fingers
  * on a touch screen.
+ *
  * @constructor
  * @extends {ol.interaction.Pointer}
  * @param {olx.interaction.PinchRotateOptions=} opt_options Options.

src/ol/interaction/pinchzoominteraction.js

@@ -12,8 +12,10 @@ goog.require('ol.interaction.Pointer');
 
 
 /**
+ * @classdesc
  * Allows the user to zoom the map by pinching with two fingers
  * on a touch screen.
+ *
  * @constructor
  * @extends {ol.interaction.Pointer}
  * @param {olx.interaction.PinchZoomOptions=} opt_options Options.

src/ol/interaction/pointerinteraction.js

@@ -12,7 +12,9 @@ goog.require('ol.interaction.Interaction');
 
 
 /**
- * Base class for pointer interactions.
+ * @classdesc
+ * Abstract base class for pointer interactions.
+ *
  * @constructor
  * @extends {ol.interaction.Interaction}
  */

src/ol/interaction/selectinteraction.js

@@ -15,6 +15,9 @@ goog.require('ol.interaction.Interaction');
 
 
 /**
+ * @classdesc
+ * Handles selection of vector data.
+ *
  * @constructor
  * @extends {ol.interaction.Interaction}
  * @param {olx.interaction.SelectOptions=} opt_options Options.

src/ol/layer/heatmaplayer.js

@@ -21,6 +21,9 @@ ol.layer.HeatmapLayerProperty = {
 
 
 /**
+ * @classdesc
+ * Layer for rendering vector data as a heatmap.
+ *
  * @constructor
  * @extends {ol.layer.Vector}
  * @fires ol.render.Event

src/ol/layer/imagelayer.js

@@ -5,6 +5,10 @@ goog.require('ol.layer.Layer');
 
 
 /**
+ * @classdesc
+ * Server-rendered images that are available for arbitrary extents and
+ * resolutions.
+ *
  * @constructor
  * @extends {ol.layer.Layer}
  * @fires ol.render.Event

src/ol/layer/layer.js

@@ -10,6 +10,11 @@ goog.require('ol.source.Source');
 
 
 /**
+ * @classdesc
+ * Abstract base class. A visual representation of raster or vector map data.
+ * Layers group together those properties that pertain to how the data is to be
+ * displayed, irrespective of the source of that data.
+ *
  * @constructor
  * @extends {ol.layer.Base}
  * @fires ol.render.Event

src/ol/layer/layerbase.js

@@ -41,7 +41,9 @@ ol.layer.LayerState;
 
 
 /**
- * Base class for all layers.
+ * @classdesc
+ * Abstract base class for all layers.
+ *
  * @constructor
  * @extends {ol.Object}
  * @param {olx.layer.BaseOptions} options Layer options.

src/ol/layer/layergroup.js

@@ -25,6 +25,9 @@ ol.layer.GroupProperty = {
 
 
 /**
+ * @classdesc
+ * A {@link ol.Collection} of layers that are handled together.
+ *
  * @constructor
  * @extends {ol.layer.Base}
  * @fires change Triggered when the state of the source of any of the layers of

src/ol/layer/tilelayer.js

@@ -14,6 +14,10 @@ ol.layer.TileProperty = {
 
 
 /**
+ * @classdesc
+ * For layer sources that provide pre-rendered, tiled images in grids that are
+ * organized by zoom levels for specific resolutions.
+ *
  * @constructor
  * @extends {ol.layer.Layer}
  * @fires ol.render.Event

src/ol/layer/vectorlayer.js

@@ -15,6 +15,8 @@ ol.layer.VectorProperty = {
 
 
 /**
+ * @classdesc
+ * Vector data that is rendered client-side.
  *
  * @constructor
  * @extends {ol.layer.Layer}

src/ol/object.js

@@ -104,7 +104,17 @@ ol.ObjectAccessor.prototype.transform = function(from, to) {
 
 
 /**
- * Base class implementing KVO (Key Value Observing).
+ * @classdesc
+ * Abstract base class from which all non-trivial classes inherit.
+ *
+ * It provides standardised get/set methods, and implements a form of
+ * Key Value Observing. Setting a value triggers a change event, and 2 objects
+ * can be bound together such that a change in one will automatically be
+ * reflected in the other.
+ *
+ * See {@link ol.dom.Input} for specific case of binding an object with an
+ * HTML element.
+ *
  * @constructor
  * @extends {ol.Observable}
  * @param {Object.<string, *>=} opt_values Values.

src/ol/observable.js

@@ -7,9 +7,12 @@ goog.require('goog.events.EventType');
 
 
 /**
+ * @classdesc
+ * Abstract base class.
  * An event target providing convenient methods for listener registration
  * and unregistration. A generic `change` event is always available through
  * {@link ol.Observable#dispatchChangeEvent}.
+ *
  * @constructor
  * @extends {goog.events.EventTarget}
  * @suppress {checkStructDictInheritance}

src/ol/overlay.js

@@ -46,7 +46,11 @@ ol.OverlayPositioning = {
 
 
 /**
- * An element to show on top of the map, such as for a popup.
+ * @classdesc
+ * Like {@link ol.control.Control}, Overlays are visible widgets.
+ * Unlike Controls, they are not in a fixed position on the screen, but are tied
+ * to a geographical coordinate, so panning the map will move an Overlay but not
+ * a Control.
  *
  * Example:
  *

src/ol/proj/epsg3857projection.js

@@ -10,6 +10,9 @@ goog.require('ol.proj.Units');
 
 
 /**
+ * @classdesc
+ * Projection object for web/spherical Mercator (EPSG:3857).
+ *
  * @constructor
  * @extends {ol.proj.Projection}
  * @param {string} code Code.

src/ol/proj/epsg4326projection.js

@@ -7,6 +7,9 @@ goog.require('ol.proj.Units');
 
 
 /**
+ * @classdesc
+ * Projection object for WGS84 geographic coordinates (EPSG:4326).
+ *
  * @constructor
  * @extends {ol.proj.Projection}
  * @param {string} code Code.

src/ol/proj/proj.js

@@ -57,6 +57,17 @@ ol.proj.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
 
 
 /**
+ * @classdesc
+ * Class for coordinate transforms between coordinate systems. By default,
+ * OpenLayers ships with the ability to transform coordinates between
+ * geographic (EPSG:4326) and web or spherical mercator (EPSG:3857)
+ * coordinate reference systems.
+ *
+ * Additional transforms may be added by using the
+ * {@link http://proj4js.org/|proj4js} library. If the proj4js library is
+ * included, the <transform> method will work between any two coordinate
+ * reference systems with proj4js definitions.
+ *
  * @constructor
  * @param {olx.ProjectionOptions} options Projection options.
  * @struct

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.

src/ol/style/circlestyle.js

@@ -12,6 +12,9 @@ goog.require('ol.style.Stroke');
 
 
 /**
+ * @classdesc
+ * Set circle style for vector features.
+ *
  * @constructor
  * @param {olx.style.CircleOptions=} opt_options Options.
  * @extends {ol.style.Image}