Get rid of stability annotations and document stability with api

This change adds a stability value to the api annotation, with 'experimental' as default value. enum, typedef and event annotations are never exportable, but api annotations are needed there to make them appear in the docs. Nested typedefs are no longer inlined recursively, because the resulting tables get too wide with the current template.
2014-04-17 00:56:44 +02:00
parent 29b643c7b0
commit fbdbbfb7a7
146 changed files with 506 additions and 764 deletions
--- a/src/ol/interaction/doubleclickzoominteraction.js
+++ b/src/ol/interaction/doubleclickzoominteraction.js
@@ -15,7 +15,6 @@ goog.require('ol.interaction.Interaction');
 * @constructor
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DoubleClickZoom = function(opt_options) {
--- a/src/ol/interaction/draganddropinteraction.js
+++ b/src/ol/interaction/draganddropinteraction.js
@@ -22,7 +22,6 @@ goog.require('ol.proj');
 * @fires {@link ol.interaction.DragAndDropEvent}
 *     ol.interaction.DragAndDropEvent
 * @param {olx.interaction.DragAndDropOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DragAndDrop = function(opt_options) {
@@ -184,7 +183,7 @@ ol.interaction.DragAndDropEventType = {
  /**
   * Triggered when features are added
   * @event ol.interaction.DragAndDropEvent#addfeatures
-   * @todo stability experimental
+   * @todo api
   */
  ADD_FEATURES: 'addfeatures'
 };
@@ -208,19 +207,16 @@ ol.interaction.DragAndDropEvent =

  /**
   * @type {Array.<ol.Feature>|undefined}
-   * @todo stability experimental
   */
  this.features = opt_features;

  /**
   * @type {File}
-   * @todo stability experimental
   */
  this.file = file;

  /**
   * @type {ol.proj.Projection|undefined}
-   * @todo stability experimental
   */
  this.projection = opt_projection;

--- a/src/ol/interaction/dragboxinteraction.js
+++ b/src/ol/interaction/dragboxinteraction.js
@@ -35,13 +35,13 @@ ol.DragBoxEventType = {
  /**
   * Triggered upon drag box start.
   * @event ol.DragBoxEvent#boxstart
-   * @todo stability experimental
+   * @todo api
   */
  BOXSTART: 'boxstart',
  /**
   * Triggered upon drag box end.
   * @event ol.DragBoxEvent#boxstart
-   * @todo stability experimental
+   * @todo api
   */
  BOXEND: 'boxend'
 };
@@ -83,7 +83,6 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
 * @extends {ol.interaction.Pointer}
 * @fires {@link ol.DragBoxEvent} ol.DragBoxEvent
 * @param {olx.interaction.DragBoxOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DragBox = function(opt_options) {
@@ -136,7 +135,6 @@ ol.interaction.DragBox.prototype.handlePointerDrag = function(mapBrowserEvent) {
 /**
 * Returns geometry of last drawn box.
 * @return {ol.geom.Geometry} Geometry.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DragBox.prototype.getGeometry = function() {
--- a/src/ol/interaction/dragpaninteraction.js
+++ b/src/ol/interaction/dragpaninteraction.js
@@ -18,7 +18,6 @@ goog.require('ol.interaction.Pointer');
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.DragPanOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DragPan = function(opt_options) {
--- a/src/ol/interaction/dragrotateandzoominteraction.js
+++ b/src/ol/interaction/dragrotateandzoominteraction.js
@@ -31,7 +31,6 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400;
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DragRotateAndZoom = function(opt_options) {
--- a/src/ol/interaction/dragrotateinteraction.js
+++ b/src/ol/interaction/dragrotateinteraction.js
@@ -25,7 +25,6 @@ ol.interaction.DRAGROTATE_ANIMATION_DURATION = 250;
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.DragRotateOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DragRotate = function(opt_options) {
--- a/src/ol/interaction/dragzoominteraction.js
+++ b/src/ol/interaction/dragzoominteraction.js
@@ -23,7 +23,6 @@ ol.interaction.DRAGZOOM_ANIMATION_DURATION = 200;
 * @constructor
 * @extends {ol.interaction.DragBox}
 * @param {olx.interaction.DragZoomOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.DragZoom = function(opt_options) {
--- a/src/ol/interaction/drawinteraction.js
+++ b/src/ol/interaction/drawinteraction.js
@@ -29,13 +29,13 @@ ol.DrawEventType = {
  /**
   * Triggered upon feature draw start
   * @event ol.DrawEvent#drawstart
-   * @todo stability experimental
+   * @todo api
   */
  DRAWSTART: 'drawstart',
  /**
   * Triggered upon feature draw end
   * @event ol.DrawEvent#drawend
-   * @todo stability experimental
+   * @todo api
   */
  DRAWEND: 'drawend'
 };
@@ -56,7 +56,6 @@ ol.DrawEvent = function(type, feature) {
  /**
   * The feature being drawn.
   * @type {ol.Feature}
-   * @todo stability experimental
   */
  this.feature = feature;

@@ -71,7 +70,6 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
 * @extends {ol.interaction.Pointer}
 * @fires {@link ol.DrawEvent} ol.DrawEvent
 * @param {olx.interaction.DrawOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.Draw = function(options) {
--- a/src/ol/interaction/interactiondefaults.js
+++ b/src/ol/interaction/interactiondefaults.js
@@ -25,7 +25,6 @@ goog.require('ol.interaction.PinchZoom');
 * @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.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.defaults = function(opt_options) {
--- a/src/ol/interaction/keyboardpaninteraction.js
+++ b/src/ol/interaction/keyboardpaninteraction.js
@@ -33,7 +33,6 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100;
 * @constructor
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.KeyboardPanOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.KeyboardPan = function(opt_options) {
--- a/src/ol/interaction/keyboardzoominteraction.js
+++ b/src/ol/interaction/keyboardzoominteraction.js
@@ -23,7 +23,6 @@ goog.require('ol.interaction.Interaction');
 * @constructor
 * @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
 * @extends {ol.interaction.Interaction}
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.KeyboardZoom = function(opt_options) {
--- a/src/ol/interaction/modifyinteraction.js
+++ b/src/ol/interaction/modifyinteraction.js
@@ -40,7 +40,6 @@ ol.interaction.SegmentDataType;
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.ModifyOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.Modify = function(options) {
--- a/src/ol/interaction/mousewheelzoominteraction.js
+++ b/src/ol/interaction/mousewheelzoominteraction.js
@@ -28,7 +28,6 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80;
 * @constructor
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.MouseWheelZoom = function(opt_options) {
--- a/src/ol/interaction/pinchrotateinteraction.js
+++ b/src/ol/interaction/pinchrotateinteraction.js
@@ -23,7 +23,6 @@ ol.interaction.ROTATE_ANIMATION_DURATION = 250;
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.PinchRotateOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.PinchRotate = function(opt_options) {
--- a/src/ol/interaction/pinchzoominteraction.js
+++ b/src/ol/interaction/pinchzoominteraction.js
@@ -17,7 +17,6 @@ goog.require('ol.interaction.Pointer');
 * @constructor
 * @extends {ol.interaction.Pointer}
 * @param {olx.interaction.PinchZoomOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.PinchZoom = function(opt_options) {
--- a/src/ol/interaction/selectinteraction.js
+++ b/src/ol/interaction/selectinteraction.js
@@ -18,7 +18,6 @@ goog.require('ol.interaction.Interaction');
 * @constructor
 * @extends {ol.interaction.Interaction}
 * @param {olx.interaction.SelectOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.Select = function(opt_options) {
@@ -101,7 +100,6 @@ goog.inherits(ol.interaction.Select, ol.interaction.Interaction);

 /**
 * @return {ol.Collection} Features collection.
- * @todo stability experimental
 * @todo api
 */
 ol.interaction.Select.prototype.getFeatures = function() {