Set api annotation on classdesc, not constructor

2018-07-21 17:25:22 +02:00
parent 2767ddfdc7
commit bbe0a66d07
101 changed files with 484 additions and 382 deletions
@@ -15,12 +15,12 @@ import Interaction, {zoomByDelta} from '../interaction/Interaction.js';
 /**
 * @classdesc
 * Allows the user to zoom by double-clicking on the map.
+ * @api
 */
 class DoubleClickZoom extends Interaction {

  /**
   * @param {module:ol/interaction/DoubleClickZoom~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {
    super({
@@ -83,13 +83,13 @@ class DragAndDropEvent extends Event {
 /**
 * @classdesc
 * Handles input of vector data by drag and drop.
+ * @api
 *
 * @fires module:ol/interaction/DragAndDrop~DragAndDropEvent
 */
 class DragAndDrop extends Interaction {
  /**
   * @param {module:ol/interaction/DragAndDrop~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -107,11 +107,11 @@ class DragBoxEvent extends Event {
 * This interaction is only supported for mouse devices.
 *
 * @fires module:ol/interaction/DragBox~DragBoxEvent
+ * @api
 */
 class DragBox extends PointerInteraction {
  /**
   * @param {module:ol/interaction/DragBox~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -21,11 +21,11 @@ import PointerInteraction, {centroid as centroidFromPointers} from '../interacti
 /**
 * @classdesc
 * Allows the user to pan the map by dragging the map.
+ * @api
 */
 class DragPan extends PointerInteraction {
  /**
   * @param {module:ol/interaction/DragPan~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -26,12 +26,12 @@ import PointerInteraction from '../interaction/Pointer.js';
 * it to when the alt and shift keys are held down.
 *
 * This interaction is only supported for mouse devices.
+ * @api
 */
 class DragRotate extends PointerInteraction {

  /**
   * @param {module:ol/interaction/DragRotate~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -27,12 +27,12 @@ import PointerInteraction from '../interaction/Pointer.js';
 * This interaction is only supported for mouse devices.
 *
 * And this interaction is not included in the default interactions.
+ * @api
 */
 class DragRotateAndZoom extends PointerInteraction {

  /**
   * @param {module:ol/interaction/DragRotateAndZoom~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -28,11 +28,11 @@ import DragBox from '../interaction/DragBox.js';
 *
 * To change the style of the box, use CSS and the `.ol-dragzoom` selector, or
 * your custom one configured with `className`.
+ * @api
 */
 class DragZoom extends DragBox {
  /**
   * @param {module:ol/interaction/DragZoom~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {
    const options = opt_options ? opt_options : {};
@@ -154,11 +154,11 @@ class DrawEvent extends Event {
 * Interaction for drawing feature geometries.
 *
 * @fires module:ol/interaction/Draw~DrawEvent
+ * @api
 */
 class Draw extends PointerInteraction {
  /**
   * @param {module:ol/interaction/Draw~Options} options Options.
-   * @api
   */
  constructor(options) {

@@ -77,11 +77,11 @@ class ExtentInteractionEvent extends Event {
 * This interaction is only supported for mouse devices.
 *
 * @fires module:ol/interaction/Extent~Event
+ * @api
 */
 class ExtentInteraction extends PointerInteraction {
  /**
   * @param {module:ol/interaction/Extent~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -29,11 +29,11 @@ import {clamp} from '../math.js';
 * by a keyboard event not a button element event.
 * Although interactions do not have a DOM element, some of them do render
 * vectors and so are visible on the screen.
+ * @api
 */
 class Interaction extends BaseObject {
  /**
   * @param {module:ol/interaction/Interaction~InteractionOptions} options Options.
-   * @api
   */
  constructor(options) {
    super();
@@ -32,11 +32,11 @@ import Interaction, {pan} from '../interaction/Interaction.js';
 * element, focus will have to be on, and returned to, this element if the keys
 * are to function.
 * See also {@link module:ol/interaction/KeyboardZoom~KeyboardZoom}.
+ * @api
 */
 class KeyboardPan extends Interaction {
  /**
   * @param {module:ol/interaction/KeyboardPan~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -28,11 +28,11 @@ import Interaction, {zoomByDelta} from '../interaction/Interaction.js';
 * element, focus will have to be on, and returned to, this element if the keys
 * are to function.
 * See also {@link moudle:ol/interaction/KeyboardPan~KeyboardPan}.
+ * @api
 */
 class KeyboardZoom extends Interaction {
  /**
   * @param {module:ol/interaction/KeyboardZoom~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -149,11 +149,11 @@ export class ModifyEvent extends Event {
 * key is pressed.  To configure the interaction with a different condition
 * for deletion, use the `deleteCondition` option.
 * @fires module:ol/interaction/Modify~ModifyEvent
+ * @api
 */
 class Modify extends PointerInteraction {
  /**
   * @param {module:ol/interaction/Modify~Options} options Options.
-   * @api
   */
  constructor(options) {

@@ -46,11 +46,11 @@ export const Mode = {
 /**
 * @classdesc
 * Allows the user to zoom the map by scrolling the mouse wheel.
+ * @api
 */
 class MouseWheelZoom extends Interaction {
  /**
   * @param {module:ol/interaction/MouseWheelZoom~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -20,11 +20,11 @@ import {disable} from '../rotationconstraint.js';
 * @classdesc
 * Allows the user to rotate the map by twisting with two fingers
 * on a touch screen.
+ * @api
 */
 class PinchRotate extends PointerInteraction {
  /**
   * @param {module:ol/interaction/PinchRotate~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -19,11 +19,11 @@ import PointerInteraction, {centroid as centroidFromPointers} from '../interacti
 * @classdesc
 * Allows the user to zoom the map by pinching with two fingers
 * on a touch screen.
+ * @api
 */
 class PinchZoom extends PointerInteraction {
  /**
   * @param {module:ol/interaction/PinchZoom~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -73,11 +73,11 @@ const handleMoveEvent = UNDEFINED;
 * started. During a drag sequence the `handleDragEvent` user function is
 * called on `move` events. The drag sequence ends when the `handleUpEvent`
 * user function is called and returns `false`.
+ * @api
 */
 class PointerInteraction extends Interaction {
  /**
   * @param {module:ol/interaction/Pointer~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -152,11 +152,11 @@ class SelectEvent extends Event {
 * Selected features are added to an internal unmanaged layer.
 *
 * @fires SelectEvent
+ * @api
 */
 class Select extends Interaction {
  /**
   * @param {module:ol/interaction/Select~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -62,11 +62,12 @@ import RBush from '../structs/RBush.js';
 *     var snap = new Snap({
 *       source: source
 *     });
+ *
+ * @api
 */
 class Snap extends PointerInteraction {
  /**
   * @param {module:ol/interaction/Snap~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {

@@ -91,11 +91,11 @@ export class TranslateEvent extends Event {
 * Interaction for translating (moving) features.
 *
 * @fires module:ol/interaction/Translate~TranslateEvent
+ * @api
 */
 class Translate extends PointerInteraction {
  /**
   * @param {module:ol/interaction/Translate~Options=} opt_options Options.
-   * @api
   */
  constructor(opt_options) {
    super({