Merge pull request #2178 from probins/classdesc

Use @classdesc notation.

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.