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/source/bingmapssource.js
+++ b/src/ol/source/bingmapssource.js
@@ -19,7 +19,6 @@ goog.require('ol.tilegrid.XYZ');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.BingMapsOptions} options Bing Maps options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.BingMaps = function(options) {
@@ -56,7 +55,6 @@ goog.inherits(ol.source.BingMaps, ol.source.TileImage);
 /**
 * @const
 * @type {ol.Attribution}
- * @todo stability experimental
 * @todo api
 */
 ol.source.BingMaps.TOS_ATTRIBUTION = new ol.Attribution({
--- a/src/ol/source/debugtilesource.js
+++ b/src/ol/source/debugtilesource.js
@@ -77,7 +77,6 @@ ol.DebugTile_.prototype.getImage = function(opt_context) {
 * @constructor
 * @extends {ol.source.Tile}
 * @param {olx.source.TileDebugOptions} options Debug tile options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileDebug = function(options) {
--- a/src/ol/source/geojsonsource.js
+++ b/src/ol/source/geojsonsource.js
@@ -10,7 +10,6 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.GeoJSONOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.GeoJSON = function(opt_options) {
--- a/src/ol/source/gpxsource.js
+++ b/src/ol/source/gpxsource.js
@@ -10,7 +10,6 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.GPXOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.GPX = function(opt_options) {
--- a/src/ol/source/igcsource.js
+++ b/src/ol/source/igcsource.js
@@ -10,7 +10,6 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.IGCOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.IGC = function(opt_options) {
--- a/src/ol/source/imagecanvassource.js
+++ b/src/ol/source/imagecanvassource.js
@@ -11,7 +11,6 @@ goog.require('ol.source.Image');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.ImageCanvasOptions} options
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageCanvas = function(options) {
--- a/src/ol/source/imagestaticsource.js
+++ b/src/ol/source/imagestaticsource.js
@@ -11,7 +11,6 @@ goog.require('ol.source.Image');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.ImageStaticOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageStatic = function(options) {
--- a/src/ol/source/imagevectorsource.js
+++ b/src/ol/source/imagevectorsource.js
@@ -29,7 +29,6 @@ goog.require('ol.vec.Mat4');
 * @constructor
 * @extends {ol.source.ImageCanvas}
 * @param {olx.source.ImageVectorOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageVector = function(options) {
--- a/src/ol/source/imagewmssource.js
+++ b/src/ol/source/imagewmssource.js
@@ -19,7 +19,6 @@ goog.require('ol.source.wms.ServerType');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.ImageWMSOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageWMS = function(opt_options) {
@@ -125,7 +124,6 @@ goog.inherits(ol.source.ImageWMS, ol.source.Image);
 *     in the `LAYERS` parameter will be used. `VERSION` should not be
 *     specified here.
 * @return {string|undefined} GetFeatureInfo URL.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
@@ -176,7 +174,6 @@ ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
 * Get the user-provided params, i.e. those passed to the constructor through
 * the "params" option, and possibly updated using the updateParams method.
 * @return {Object} Params.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageWMS.prototype.getParams = function() {
@@ -320,7 +317,6 @@ ol.source.ImageWMS.prototype.getRequestUrl_ =
 /**
 * Return the URL used for this WMS source.
 * @return {string|undefined} URL.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageWMS.prototype.getUrl = function() {
@@ -330,7 +326,6 @@ ol.source.ImageWMS.prototype.getUrl = function() {

 /**
 * @param {string|undefined} url URL.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageWMS.prototype.setUrl = function(url) {
@@ -345,7 +340,6 @@ ol.source.ImageWMS.prototype.setUrl = function(url) {
 /**
 * Update the user-provided params.
 * @param {Object} params Params.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ImageWMS.prototype.updateParams = function(params) {
--- a/src/ol/source/kmlsource.js
+++ b/src/ol/source/kmlsource.js
@@ -10,7 +10,6 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.KMLOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.KML = function(opt_options) {
--- a/src/ol/source/mapguidesource.js
+++ b/src/ol/source/mapguidesource.js
@@ -13,7 +13,6 @@ goog.require('ol.source.Image');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.MapGuideOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.MapGuide = function(options) {
--- a/src/ol/source/mapquestsource.js
+++ b/src/ol/source/mapquestsource.js
@@ -11,7 +11,6 @@ goog.require('ol.source.XYZ');
 * @constructor
 * @extends {ol.source.XYZ}
 * @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.MapQuest = function(opt_options) {
--- a/src/ol/source/osmsource.js
+++ b/src/ol/source/osmsource.js
@@ -9,7 +9,6 @@ goog.require('ol.source.XYZ');
 * @constructor
 * @extends {ol.source.XYZ}
 * @param {olx.source.OSMOptions=} opt_options Open Street Map options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.OSM = function(opt_options) {
@@ -46,7 +45,6 @@ goog.inherits(ol.source.OSM, ol.source.XYZ);
 /**
 * @const
 * @type {ol.Attribution}
- * @todo stability experimental
 * @todo api
 */
 ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution({
@@ -60,7 +58,6 @@ ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution({
 /**
 * @const
 * @type {ol.Attribution}
- * @todo stability experimental
 * @todo api
 */
 ol.source.OSM.TILE_ATTRIBUTION = new ol.Attribution({
--- a/src/ol/source/osmxmlsource.js
+++ b/src/ol/source/osmxmlsource.js
@@ -10,7 +10,6 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.OSMXMLOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.OSMXML = function(opt_options) {
--- a/src/ol/source/servervectorsource.js
+++ b/src/ol/source/servervectorsource.js
@@ -13,7 +13,6 @@ goog.require('ol.structs.RBush');
 * @constructor
 * @extends {ol.source.FormatVector}
 * @param {olx.source.ServerVectorOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ServerVector = function(options) {
@@ -105,7 +104,6 @@ ol.source.ServerVector.prototype.loadFeatures =
 * @function
 * @param {ArrayBuffer|Document|Node|Object|string} source Source.
 * @return {Array.<ol.Feature>} Features.
- * @todo stability experimental
 * @todo api
 */
 ol.source.ServerVector.prototype.readFeatures;
--- a/src/ol/source/source.js
+++ b/src/ol/source/source.js
@@ -24,7 +24,6 @@ ol.source.State = {
 *            logo: (string|undefined),
 *            projection: ol.proj.ProjectionLike,
 *            state: (ol.source.State|string|undefined)}}
- * @todo stability experimental
 */
 ol.source.SourceOptions;

@@ -130,7 +129,6 @@ ol.source.Source.prototype.getResolutions = goog.abstractMethod;

 /**
 * @return {ol.source.State} State.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Source.prototype.getState = function() {
--- a/src/ol/source/stamensource.js
+++ b/src/ol/source/stamensource.js
@@ -81,7 +81,6 @@ ol.source.StamenProviderConfig = {
 * @constructor
 * @extends {ol.source.XYZ}
 * @param {olx.source.StamenOptions} options Stamen options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Stamen = function(options) {
--- a/src/ol/source/staticvectorsource.js
+++ b/src/ol/source/staticvectorsource.js
@@ -10,7 +10,6 @@ goog.require('ol.source.State');
 * @extends {ol.source.FormatVector}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.StaticVectorOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.StaticVector = function(options) {
--- a/src/ol/source/tileimagesource.js
+++ b/src/ol/source/tileimagesource.js
@@ -17,7 +17,6 @@ goog.require('ol.source.Tile');
 * @constructor
 * @extends {ol.source.Tile}
 * @param {olx.source.TileImageOptions} options Image tile options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileImage = function(options) {
--- a/src/ol/source/tilejsonsource.js
+++ b/src/ol/source/tilejsonsource.js
@@ -25,7 +25,6 @@ goog.require('ol.tilegrid.XYZ');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.TileJSONOptions} options TileJSON options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileJSON = function(options) {
--- a/src/ol/source/tilesource.js
+++ b/src/ol/source/tilesource.js
@@ -18,7 +18,6 @@ goog.require('ol.tilegrid.TileGrid');
 *            opaque: (boolean|undefined),
 *            projection: ol.proj.ProjectionLike,
 *            tileGrid: (ol.tilegrid.TileGrid|undefined)}}
- * @todo stability experimental
 */
 ol.source.TileOptions;

@@ -28,7 +27,6 @@ ol.source.TileOptions;
 * @constructor
 * @extends {ol.source.Source}
 * @param {ol.source.TileOptions} options Tile source options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Tile = function(options) {
@@ -154,7 +152,6 @@ ol.source.Tile.prototype.getTile = goog.abstractMethod;

 /**
 * @return {ol.tilegrid.TileGrid} Tile grid.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Tile.prototype.getTileGrid = function() {
--- a/src/ol/source/tilevectorsource.js
+++ b/src/ol/source/tilevectorsource.js
@@ -14,7 +14,6 @@ goog.require('ol.tilegrid.TileGrid');
 * @constructor
 * @extends {ol.source.FormatVector}
 * @param {olx.source.TileVectorOptions} options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileVector = function(options) {
--- a/src/ol/source/tilewmssource.js
+++ b/src/ol/source/tilewmssource.js
@@ -23,7 +23,6 @@ goog.require('ol.source.wms.ServerType');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.TileWMSOptions=} opt_options Tile WMS options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileWMS = function(opt_options) {
@@ -125,7 +124,6 @@ goog.inherits(ol.source.TileWMS, ol.source.TileImage);
 *     in the `LAYERS` parameter will be used. `VERSION` should not be
 *     specified here.
 * @return {string|undefined} GetFeatureInfo URL.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileWMS.prototype.getGetFeatureInfoUrl =
@@ -208,7 +206,6 @@ ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) {
 * Get the user-provided params, i.e. those passed to the constructor through
 * the "params" option, and possibly updated using the updateParams method.
 * @return {Object} Params.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileWMS.prototype.getParams = function() {
@@ -309,7 +306,6 @@ ol.source.TileWMS.prototype.getTilePixelSize =
 /**
 * Return the URLs used for this WMS source.
 * @return {Array.<string>|undefined} URLs.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileWMS.prototype.getUrls = function() {
@@ -394,7 +390,6 @@ ol.source.TileWMS.prototype.tileUrlFunction_ =
 /**
 * Update the user-provided params.
 * @param {Object} params Params.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TileWMS.prototype.updateParams = function(params) {
--- a/src/ol/source/topojsonsource.js
+++ b/src/ol/source/topojsonsource.js
@@ -10,7 +10,6 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.TopoJSONOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.TopoJSON = function(opt_options) {
--- a/src/ol/source/vectorsource.js
+++ b/src/ol/source/vectorsource.js
@@ -25,13 +25,13 @@ ol.source.VectorEventType = {
  /**
   * Triggered when a feature is added to the source.
   * @event ol.source.VectorEvent#addfeature
-   * @todo stability experimental
+   * @todo api
   */
  ADDFEATURE: 'addfeature',
  /**
   * Triggered when a feature is removed from the source.
   * @event ol.source.VectorEvent#removefeature
-   * @todo stability experimental
+   * @todo api
   */
  REMOVEFEATURE: 'removefeature'
 };
@@ -43,7 +43,6 @@ ol.source.VectorEventType = {
 * @extends {ol.source.Source}
 * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
 * @param {olx.source.VectorOptions=} opt_options Vector source options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector = function(opt_options) {
@@ -86,7 +85,6 @@ goog.inherits(ol.source.Vector, ol.source.Source);

 /**
 * @param {ol.Feature} feature Feature.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.addFeature = function(feature) {
@@ -125,7 +123,6 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) {

 /**
 * @param {Array.<ol.Feature>} features Features.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.addFeatures = function(features) {
@@ -167,7 +164,6 @@ ol.source.Vector.prototype.clear = function() {
 * @param {T=} opt_this The object to use as `this` in `f`.
 * @return {S|undefined}
 * @template T,S
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.forEachFeature = function(f, opt_this) {
@@ -203,7 +199,6 @@ ol.source.Vector.prototype.forEachFeatureAtCoordinate =
 * @param {T=} opt_this The object to use as `this` in `f`.
 * @return {S|undefined}
 * @template T,S
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.forEachFeatureInExtent =
@@ -228,7 +223,6 @@ ol.source.Vector.prototype.forEachFeatureInExtentAtResolution =

 /**
 * @return {Array.<ol.Feature>} Features.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.getFeatures = function() {
@@ -244,7 +238,6 @@ ol.source.Vector.prototype.getFeatures = function() {
 /**
 * @param {ol.Coordinate} coordinate Coordinate.
 * @return {Array.<ol.Feature>} Features.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.getFeaturesAtCoordinate = function(coordinate) {
@@ -268,7 +261,6 @@ ol.source.Vector.prototype.getFeaturesInExtent = function(extent) {
 /**
 * @param {ol.Coordinate} coordinate Coordinate.
 * @return {ol.Feature} Closest feature.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.getClosestFeatureToCoordinate =
@@ -315,7 +307,6 @@ ol.source.Vector.prototype.getClosestFeatureToCoordinate =

 /**
 * @return {ol.Extent} Extent.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.getExtent = function() {
@@ -368,7 +359,6 @@ ol.source.Vector.prototype.loadFeatures = goog.nullFunction;

 /**
 * @param {ol.Feature} feature Feature.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Vector.prototype.removeFeature = function(feature) {
@@ -406,7 +396,6 @@ ol.source.Vector.prototype.removeFeatureInternal = function(feature) {
 * @implements {oli.source.VectorEvent}
 * @param {string} type Type.
 * @param {ol.Feature=} opt_feature Feature.
- * @todo stability experimental
 */
 ol.source.VectorEvent = function(type, opt_feature) {

@@ -415,7 +404,6 @@ ol.source.VectorEvent = function(type, opt_feature) {
  /**
   * The feature being added or removed.
   * @type {ol.Feature|undefined}
-   * @todo stability experimental
   */
  this.feature = opt_feature;

--- a/src/ol/source/wmtssource.js
+++ b/src/ol/source/wmtssource.js
@@ -29,7 +29,6 @@ ol.source.WMTSRequestEncoding = {
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.WMTSOptions} options WMTS options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.WMTS = function(options) {
@@ -196,7 +195,6 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage);
 * "dimensions" option, and possibly updated using the updateDimensions
 * method.
 * @return {Object} Dimensions.
- * @todo stability experimental
 * @todo api
 */
 ol.source.WMTS.prototype.getDimensions = function() {
@@ -228,7 +226,6 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() {
 /**
 * Update the dimensions.
 * @param {Object} dimensions Dimensions.
- * @todo stability experimental
 * @todo api
 */
 ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
@@ -242,7 +239,6 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
 * @param {Object} wmtsCap An object representing the capabilities document.
 * @param {string} layer The layer identifier.
 * @return {olx.source.WMTSOptions} WMTS source options object.
- * @todo stability experimental
 * @todo api
 */
 ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) {
--- a/src/ol/source/xyzsource.js
+++ b/src/ol/source/xyzsource.js
@@ -12,7 +12,6 @@ goog.require('ol.tilegrid.XYZ');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.XYZOptions} options XYZ options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.XYZ = function(options) {
@@ -70,7 +69,6 @@ ol.source.XYZ.prototype.setTileUrlFunction = function(tileUrlFunction) {

 /**
 * @param {string} url URL.
- * @todo stability experimental
 * @todo api
 */
 ol.source.XYZ.prototype.setUrl = function(url) {
--- a/src/ol/source/zoomifysource.js
+++ b/src/ol/source/zoomifysource.js
@@ -26,7 +26,6 @@ ol.source.ZoomifyTierSizeCalculation = {
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.ZoomifyOptions=} opt_options Options.
- * @todo stability experimental
 * @todo api
 */
 ol.source.Zoomify = function(opt_options) {