All @api annotations imply stability

2017-02-06 09:22:05 -07:00
parent ca23c7337f
commit f5aea97d3b
109 changed files with 705 additions and 747 deletions
--- a/src/ol/interaction/doubleclickzoom.js
+++ b/src/ol/interaction/doubleclickzoom.js
@@ -12,7 +12,7 @@ goog.require('ol.interaction.Interaction');
 * @constructor
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.DoubleClickZoom = function(opt_options) {

--- a/src/ol/interaction/draganddrop.js
+++ b/src/ol/interaction/draganddrop.js
@@ -19,7 +19,7 @@ goog.require('ol.proj');
 * @extends {ol.interaction.Interaction}
 * @fires ol.interaction.DragAndDrop.Event
 * @param {olx.interaction.DragAndDropOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.DragAndDrop = function(opt_options) {

@@ -189,7 +189,7 @@ ol.interaction.DragAndDrop.EventType_ = {
  /**
   * Triggered when features are added
   * @event ol.interaction.DragAndDrop.Event#addfeatures
-   * @api stable
+   * @api
   */
  ADD_FEATURES: 'addfeatures'
 };
@@ -215,14 +215,14 @@ ol.interaction.DragAndDrop.Event = function(type, file, opt_features, opt_projec
  /**
   * The features parsed from dropped data.
   * @type {Array.<ol.Feature>|undefined}
-   * @api stable
+   * @api
   */
  this.features = opt_features;

  /**
   * The dropped file.
   * @type {File}
-   * @api stable
+   * @api
   */
  this.file = file;

--- a/src/ol/interaction/dragbox.js
+++ b/src/ol/interaction/dragbox.js
@@ -32,7 +32,7 @@ ol.DRAG_BOX_HYSTERESIS_PIXELS_SQUARED =
 * @extends {ol.interaction.Pointer}
 * @fires ol.interaction.DragBox.Event
 * @param {olx.interaction.DragBoxOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.DragBox = function(opt_options) {

@@ -111,7 +111,7 @@ ol.interaction.DragBox.handleDragEvent_ = function(mapBrowserEvent) {
 /**
 * Returns geometry of last drawn box.
 * @return {ol.geom.Polygon} Geometry.
- * @api stable
+ * @api
 */
 ol.interaction.DragBox.prototype.getGeometry = function() {
  return this.box_.getGeometry();
@@ -183,7 +183,7 @@ ol.interaction.DragBox.EventType_ = {
  /**
   * Triggered upon drag box start.
   * @event ol.interaction.DragBox.Event#boxstart
-   * @api stable
+   * @api
   */
  BOXSTART: 'boxstart',

@@ -197,7 +197,7 @@ ol.interaction.DragBox.EventType_ = {
  /**
   * Triggered upon drag box end.
   * @event ol.interaction.DragBox.Event#boxend
-   * @api stable
+   * @api
   */
  BOXEND: 'boxend'
 };
@@ -222,7 +222,7 @@ ol.interaction.DragBox.Event = function(type, coordinate, mapBrowserEvent) {
   * The coordinate of the drag event.
   * @const
   * @type {ol.Coordinate}
-   * @api stable
+   * @api
   */
  this.coordinate = coordinate;

--- a/src/ol/interaction/dragpan.js
+++ b/src/ol/interaction/dragpan.js
@@ -16,7 +16,7 @@ goog.require('ol.interaction.Pointer');
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.DragPanOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.DragPan = function(opt_options) {

--- a/src/ol/interaction/dragrotate.js
+++ b/src/ol/interaction/dragrotate.js
@@ -19,7 +19,7 @@ goog.require('ol.interaction.Pointer');
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.DragRotateOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.DragRotate = function(opt_options) {

--- a/src/ol/interaction/dragrotateandzoom.js
+++ b/src/ol/interaction/dragrotateandzoom.js
@@ -20,7 +20,7 @@ goog.require('ol.interaction.Pointer');
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.DragRotateAndZoom = function(opt_options) {

--- a/src/ol/interaction/dragzoom.js
+++ b/src/ol/interaction/dragzoom.js
@@ -19,7 +19,7 @@ goog.require('ol.interaction.DragBox');
 * @constructor
 * @extends {ol.interaction.DragBox}
 * @param {olx.interaction.DragZoomOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.DragZoom = function(opt_options) {
  var options = opt_options ? opt_options : {};
--- a/src/ol/interaction/draw.js
+++ b/src/ol/interaction/draw.js
@@ -34,7 +34,7 @@ goog.require('ol.style.Style');
 * @extends {ol.interaction.Pointer}
 * @fires ol.interaction.Draw.Event
 * @param {olx.interaction.DrawOptions} options Options.
- * @api stable
+ * @api
 */
 ol.interaction.Draw = function(options) {

@@ -853,7 +853,7 @@ ol.interaction.Draw.Event = function(type, feature) {
  /**
   * The feature being drawn.
   * @type {ol.Feature}
-   * @api stable
+   * @api
   */
  this.feature = feature;

--- a/src/ol/interaction/draweventtype.js
+++ b/src/ol/interaction/draweventtype.js
@@ -8,13 +8,13 @@ ol.interaction.DrawEventType = {
  /**
   * Triggered upon feature draw start
   * @event ol.interaction.Draw.Event#drawstart
-   * @api stable
+   * @api
   */
  DRAWSTART: 'drawstart',
  /**
   * Triggered upon feature draw end
   * @event ol.interaction.Draw.Event#drawend
-   * @api stable
+   * @api
   */
  DRAWEND: 'drawend'
 };
--- a/src/ol/interaction/keyboardpan.js
+++ b/src/ol/interaction/keyboardpan.js
@@ -23,7 +23,7 @@ goog.require('ol.interaction.Interaction');
 * @constructor
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.KeyboardPanOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.KeyboardPan = function(opt_options) {

--- a/src/ol/interaction/keyboardzoom.js
+++ b/src/ol/interaction/keyboardzoom.js
@@ -21,7 +21,7 @@ goog.require('ol.interaction.Interaction');
 * @constructor
 * @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
 * @extends {ol.interaction.Interaction}
- * @api stable
+ * @api
 */
 ol.interaction.KeyboardZoom = function(opt_options) {

--- a/src/ol/interaction/mousewheelzoom.js
+++ b/src/ol/interaction/mousewheelzoom.js
@@ -16,7 +16,7 @@ goog.require('ol.math');
 * @constructor
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.MouseWheelZoom = function(opt_options) {

--- a/src/ol/interaction/pinchrotate.js
+++ b/src/ol/interaction/pinchrotate.js
@@ -15,7 +15,7 @@ goog.require('ol.interaction.Pointer');
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.PinchRotateOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.PinchRotate = function(opt_options) {

--- a/src/ol/interaction/pinchzoom.js
+++ b/src/ol/interaction/pinchzoom.js
@@ -15,7 +15,7 @@ goog.require('ol.interaction.Pointer');
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.PinchZoomOptions=} opt_options Options.
- * @api stable
+ * @api
 */
 ol.interaction.PinchZoom = function(opt_options) {

--- a/src/ol/interaction/select.js
+++ b/src/ol/interaction/select.js
@@ -31,7 +31,7 @@ goog.require('ol.style.Style');
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.SelectOptions=} opt_options Options.
 * @fires ol.interaction.Select.Event
- * @api stable
+ * @api
 */
 ol.interaction.Select = function(opt_options) {

@@ -159,7 +159,7 @@ ol.interaction.Select.prototype.addFeatureLayerAssociation_ = function(feature,
 /**
 * Get the selected features.
 * @return {ol.Collection.<ol.Feature>} Features collection.
- * @api stable
+ * @api
 */
 ol.interaction.Select.prototype.getFeatures = function() {
  return this.featureOverlay_.getSource().getFeaturesCollection();
@@ -304,7 +304,7 @@ ol.interaction.Select.prototype.setHitTolerance = function(hitTolerance) {
 * map, if any. Pass `null` to just remove the interaction from the current map.
 * @param {ol.Map} map Map.
 * @override
- * @api stable
+ * @api
 */
 ol.interaction.Select.prototype.setMap = function(map) {
  var currentMap = this.getMap();