diff --git a/apidoc/conf.json b/apidoc/conf.json
index a61f28b070..9ec1e68f20 100644
--- a/apidoc/conf.json
+++ b/apidoc/conf.json
@@ -22,11 +22,11 @@
"node_modules/jsdoc/plugins/markdown",
"apidoc/plugins/inheritdoc",
"apidoc/plugins/interface",
+ "apidoc/plugins/typedefs",
+ "apidoc/plugins/inheritdoc",
"apidoc/plugins/api",
- "apidoc/plugins/olx-typedefs",
"apidoc/plugins/todo",
- "apidoc/plugins/observable",
- "apidoc/plugins/stability"
+ "apidoc/plugins/observable"
],
"markdown": {
"parser": "gfm"
diff --git a/apidoc/plugins/api.js b/apidoc/plugins/api.js
index 1300f3482f..824fb82334 100644
--- a/apidoc/plugins/api.js
+++ b/apidoc/plugins/api.js
@@ -1,3 +1,29 @@
+/**
+ * Define an @api tag
+ */
+var conf = env.conf.stability;
+var defaultLevels = ["deprecated","experimental","unstable","stable","frozen","locked"];
+var levels = conf.levels || defaultLevels;
+var util = require('util');
+exports.defineTags = function(dictionary) {
+ dictionary.defineTag('api', {
+ mustHaveValue: false,
+ canHaveType: false,
+ canHaveName: false,
+ onTagged: function(doclet, tag) {
+ var level = tag.text || "experimental";
+ if (levels.indexOf(level) >= 0) {
+ doclet.stability = level;
+ } else {
+ var errorText = util.format('Invalid stability level (%s) in %s line %s', tag.text, doclet.meta.filename, doclet.meta.lineno);
+ require('jsdoc/util/error').handle( new Error(errorText) );
+ }
+ }
+ });
+};
+
+
+
/*
* Based on @stability annotations, and assuming that items with no @stability
* annotation should not be documented, this plugin removes undocumented symbols
diff --git a/apidoc/plugins/inheritdoc.js b/apidoc/plugins/inheritdoc.js
index 673017b702..8340e0b721 100644
--- a/apidoc/plugins/inheritdoc.js
+++ b/apidoc/plugins/inheritdoc.js
@@ -5,11 +5,104 @@
* TODO: Remove this hack when https://github.com/jsdoc3/jsdoc/issues/53
* is addressed.
*/
-exports.astNodeVisitor = {
- visitNode: function(node, e, parser, currentSourceName) {
- if (/@(inheritDoc)(\n|\r)/.test(e.comment)) {
- e.preventDefault = true;
+
+exports.defineTags = function(dictionary) {
+ dictionary.defineTag('inheritDoc', {
+ mustHaveValue: false,
+ canHaveType: false,
+ canHaveName: false,
+ onTagged: function(doclet, tag) {
+ doclet.inheritdoc = true;
+ }
+ });
+};
+
+
+var lookup = {};
+var incompleteByClass = {};
+var keepKeys = ['comment', 'meta', 'name', 'memberof', 'longname', 'augment',
+ 'stability'];
+
+exports.handlers = {
+
+ newDoclet: function(e) {
+ var doclet = e.doclet;
+ var incompletes;
+ if (!(doclet.longname in lookup)) {
+ lookup[doclet.longname] = [];
+ }
+ lookup[doclet.longname].push(doclet);
+ if (doclet.inheritdoc) {
+ if (!(doclet.memberof in incompleteByClass)) {
+ incompleteByClass[doclet.memberof] = [];
+ }
+ incompletes = incompleteByClass[doclet.memberof];
+ if (incompletes.indexOf(doclet.name) == -1) {
+ incompletes.push(doclet.name);
+ }
+ }
+ },
+
+ parseComplete: function(e) {
+ var ancestors, candidate, candidates, doclet, i, j, k, l, key;
+ var incompleteDoclet, stability, incomplete, incompletes;
+ var doclets = e.doclets;
+ for (i = doclets.length - 1; i >= 0; --i) {
+ doclet = doclets[i];
+ if (doclet.augments) {
+ ancestors = [].concat(doclet.augments);
+ }
+ incompletes = incompleteByClass[doclet.longname];
+ if (ancestors && incompletes) {
+ // collect ancestors from the whole hierarchy
+ for (j = 0; j < ancestors.length; ++j) {
+ candidates = lookup[ancestors[j]];
+ if (candidates) {
+ for (k = candidates.length - 1; k >= 0; --k) {
+ candidate = candidates[k];
+ if (candidate.augments) {
+ ancestors = ancestors.concat(candidate.augments);
+ }
+ }
+ }
+ }
+ // walk through all inheritDoc members
+ for (j = incompletes.length - 1; j >= 0; --j) {
+ incomplete = incompletes[j];
+ candidates = lookup[doclet.longname + '#' + incomplete];
+ if (candidates) {
+ // get the incomplete doclet that needs to be augmented
+ for (k = candidates.length - 1; k >= 0; --k) {
+ incompleteDoclet = candidates[k];
+ if (incompleteDoclet.inheritdoc) {
+ break;
+ }
+ }
+ }
+ // find the documented ancestor
+ for (k = ancestors.length - 1; k >= 0; --k) {
+ candidates = lookup[ancestors[k] + '#' + incomplete];
+ if (candidates) {
+ for (l = candidates.length - 1; l >= 0; --l) {
+ candidate = candidates[l];
+ if (candidate && !candidate.inheritdoc) {
+ stability = candidate.stability || incompleteDoclet.stability
+ if (stability) {
+ incompleteDoclet.stability = stability;
+ for (key in candidate) {
+ if (candidate.hasOwnProperty(key) &&
+ keepKeys.indexOf(key) == -1) {
+ incompleteDoclet[key] = candidate[key];
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
}
diff --git a/apidoc/plugins/stability.js b/apidoc/plugins/stability.js
deleted file mode 100644
index bd006cdbab..0000000000
--- a/apidoc/plugins/stability.js
+++ /dev/null
@@ -1,20 +0,0 @@
-var conf = env.conf.stability;
-var defaultLevels = ["deprecated","experimental","unstable","stable","frozen","locked"];
-var levels = conf.levels || defaultLevels;
-var util = require('util');
-exports.defineTags = function(dictionary) {
- dictionary.defineTag('stability', {
- mustHaveValue: true,
- canHaveType: false,
- canHaveName: true,
- onTagged: function(doclet, tag) {
- var level = tag.text;
- if (levels.indexOf(level) >=0) {
- doclet.stability = level;
- } else {
- var errorText = util.format('Invalid stability level (%s) in %s line %s', tag.text, doclet.meta.filename, doclet.meta.lineno);
- require('jsdoc/util/error').handle( new Error(errorText) );
- }
- }
- })
-};
diff --git a/apidoc/plugins/todo.js b/apidoc/plugins/todo.js
index 2a2d05a027..0a76e89e6e 100644
--- a/apidoc/plugins/todo.js
+++ b/apidoc/plugins/todo.js
@@ -6,8 +6,8 @@ exports.defineTags = function(dictionary) {
canHaveName: true,
onTagged: function(doclet, tag) {
var parts = tag.text.split(' ');
- if (parts[0] === 'stability') {
- doclet.stability = parts.slice(1).join(' ');
+ if (parts[0] === 'api') {
+ doclet.stability = parts.slice(1).join(' ') || 'experimental';
} else if (parts[0] === 'observable') {
if (!doclet.observables) {
doclet.observables = [];
diff --git a/apidoc/plugins/olx-typedefs.js b/apidoc/plugins/typedefs.js
similarity index 79%
rename from apidoc/plugins/olx-typedefs.js
rename to apidoc/plugins/typedefs.js
index 9eb0302873..35eb804335 100644
--- a/apidoc/plugins/olx-typedefs.js
+++ b/apidoc/plugins/typedefs.js
@@ -1,5 +1,6 @@
/*
* Converts olx.js @type annotations into properties of the previous @typedef.
+ * Changes @enum annotations into @typedef.
*/
var lastOlxTypedef = null;
@@ -13,8 +14,9 @@ function addSubparams(params) {
var name = types[k];
if (name in olxTypes) {
param.subparams = olxTypes[name];
- addSubparams(param.subparams);
- types[k] = 'Object';
+ // TODO Change template before recursing here, because the table gets
+ // too wide.
+ //addSubparams(param.subparams);
// TODO Do we need to support multiple object literal types per
// param?
break;
@@ -38,6 +40,10 @@ exports.handlers = {
} else {
lastOlxTypedef = null;
}
+ } else if (doclet.isEnum) {
+ // We never export enums, so we document them like typedefs
+ doclet.kind = 'typedef';
+ delete doclet.isEnum;
}
},
diff --git a/apidoc/readme.md b/apidoc/readme.md
index 94eb732e1a..bdedae5f89 100644
--- a/apidoc/readme.md
+++ b/apidoc/readme.md
@@ -11,7 +11,6 @@ In the simplest case, a JSDoc block can look like this:
/**
* Add the given control to the map.
* @param {ol.control.Control} control Control.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.addControl = function(control) {
@@ -23,42 +22,7 @@ contain Markdown.
The second line tells the Closure compiler the type of the argument.
-The third line marks the API stability. Once the documentation story is fully settled, we will remove the `todo ` and just write `@stability experimental`. Without such a stability note, the method will not be documented in the generated API documentation.
-
-The last line marks the method as exportable so it can be made available to the user facing API. This will also change to just `@api` eventually.
-
-### Observable properties
-
-For classes that inherit from `ol.Object`, there is a special documentation case for getters and setters:
-```js
-/**
- * Get the size of this map.
- * @return {ol.Size|undefined} Size.
- * @todo stability experimental
- */
-ol.Map.prototype.getSize = function() {
- // ...
-};
-goog.exportProperty(
- ol.Map.prototype,
- 'getSize',
- ol.Map.prototype.getSize);
-```
-Because `ol.Object` needs to rely on these getter and setter names, these methods are not marked `@api` as exportable. Instead, `goog.exportProperty()` is used after the method definition to make sure that this method is always part of the API and not renamed in build configurations that do not need it.
-
-To document observable properties with the `ol.ObjectEvent` types they are associated with, the `@observable` property is used (currently still `@todo observable`):
-```js
- * @constructor
- * @todo observable layergroup {ol.layer.Group} a layer group containing the
- * layers in this map.
- * @todo observable size {ol.Size} the size in pixels of the map in the DOM
- * @todo observable target {string|Element} the Element or id of the Element
- * that the map is rendered in.
- * @todo observable view {ol.IView} the view that controls this map
- */
-ol.Map = function(options) {
-```
-The first argument to that annotation is the name of the property, then the type(s) in curly braces, and then a description. NOTE/TODO: The `apidoc/plugins/observable.js` plugin does currently not handle inherited observable properties.
+The third line (`@todo api`) marks the method as exportable. The stability can be added as value, e.g. `@todo api stable`. Once the documentation story is fully settled, we will remove the `todo ` and just write `@api` or `@api stable`. Without such an api note, the method will not be exported and not documented in the generated API documentation.
### Events
@@ -73,25 +37,26 @@ ol.MapBrowserEvent.EventType = {
* A true single click with no dragging and no double click. Note that this
* event is delayed by 250 ms to ensure that it is not a double click.
* @event ol.MapBrowserEvent#singleclick
- * @todo stability experimental
+ * @todo api
*/
SINGLECLICK: 'singleclick',
// ...
};
```
-Note the value of the `@event` annotation. The text before the hash refers to the event class that the event belongs to, and the text after the hash is the type of the event. To export these properties, they need to be defined in `externs/oli.js` (also see `readme.md` in `externs/`). In addition, a stability note is required in the source code (`src/ol/MapBrowserEvent.js`) to make sure that documentation gets generated:
+Note the value of the `@event` annotation. The text before the hash refers to the event class that the event belongs to, and the text after the hash is the type of the event.
+
+To export event properties, they need to be defined in `externs/oli.js` (also see `readme.md` in `externs/`) and marked with an @api annotation:
```js
-ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
+/** @interface */
+oli.MapBrowserEvent;
- // ...
+/**
+ * @type {ol.Coordinate}
+ * @todo api
+ */
+oli.MapBrowserEvent.prototype.coordinate;
- /**
- * @type {ol.Coordinate}
- * @todo stability experimental
- */
- this.coordinate = map.getEventCoordinate(this.originalEvent);
-
- // ...
+// ...
};
```
@@ -100,37 +65,10 @@ To document which events are fired by a class or method, the `@fires` annotation
* @fires {@link ol.MapBrowserEvent} ol.MapBrowserEvent
* @fires {@link ol.MapEvent} ol.MapEvent
* @fires {@link ol.render.Event} ol.render.Event
+ * ...
*/
ol.Map = function(options) {
// ...
};
```
Again, note the syntax of the `@fires` annotation. The link is necessary to provide a link to the documentation of the event, and the name of the event class is necessary for JSDoc3 to know which event we are talking about.
-
-### Special cases with inheritance
-
-When an item is marked `@api` in a subclass and not the base class, the documentation needs to be provided in the class where the item is exported. If the item is a (member) function, the `@function` annotation needs to be used:
-```js
-/**
- * Read a feature from a GeoJSON Feature source. This method will throw
- * an error if used with a FeatureCollection source.
- * @function
- * @param {ArrayBuffer|Document|Node|Object|string} source Source.
- * @return {ol.Feature} Feature.
- * @todo stability experimental
- * @todo api
- */
-ol.format.GeoJSON.prototype.readFeature;
-```
-The `@function` annotation is also needed when the function assignment is a
-constant function from a `goog` namespace (e.g. `goog.AbstractMethod`).
-
-For an abstract method, if it exported by every subclass, the documentation can be provided in the abstract class, with a `@stability` note. Implementing classes can use `@inheritDoc` and export the item:
-```js
-/**
- * @inheritDoc
- * @todo api
- */
-```
-When only a subset of the subclasses exports the item, @inheritDoc cannot
-be used, and every exporting class needs to provide the documentation.
diff --git a/apidoc/template/tmpl/container.tmpl b/apidoc/template/tmpl/container.tmpl
index f65f3bc6a3..7c744204b5 100644
--- a/apidoc/template/tmpl/container.tmpl
+++ b/apidoc/template/tmpl/container.tmpl
@@ -142,7 +142,7 @@
TypeDefs
-
+
diff --git a/buildcfg/jsdoc/symbols/publish.js b/buildcfg/jsdoc/symbols/publish.js
index c15c972c19..00fedd747d 100644
--- a/buildcfg/jsdoc/symbols/publish.js
+++ b/buildcfg/jsdoc/symbols/publish.js
@@ -14,8 +14,13 @@ var path = require('path');
exports.publish = function(data, opts) {
var cwd = process.cwd();
- // get all doclets with the "api" property.
- var docs = data({api: {isString: true}}).get();
+ // get all doclets with the "api" property, but no enums, typedefs and events.
+ var docs = data(
+ {api: {isString: true}},
+ {isEnum: {'!is': true}},
+ {kind: {'!is': 'typedef'}},
+ {kind: {'!is': 'event'}}
+ ).get();
// get symbols data, filter out those that are members of private classes
var symbols = docs.filter(function(doc) {
diff --git a/externs/oli.js b/externs/oli.js
index 95d8afc147..1d3990a2ba 100644
--- a/externs/oli.js
+++ b/externs/oli.js
@@ -14,7 +14,11 @@ var oli;
oli.CollectionEvent;
-/** @type {*} */
+/**
+ * The element that is added to or removed from the collection.
+ * @type {*}
+ * @todo api
+ */
oli.CollectionEvent.prototype.element;
@@ -23,7 +27,10 @@ oli.CollectionEvent.prototype.element;
oli.DragBoxEvent;
-/** @type {ol.Coordinate} */
+/**
+ * @type {ol.Coordinate}
+ * @todo api
+ */
oli.DragBoxEvent.prototype.coordinate;
@@ -32,7 +39,11 @@ oli.DragBoxEvent.prototype.coordinate;
oli.DrawEvent;
-/** @type {ol.Feature} */
+/**
+ * The feature being drawn.
+ * @type {ol.Feature}
+ * @todo api
+ */
oli.DrawEvent.prototype.feature;
@@ -79,7 +90,7 @@ oli.FrameState.prototype.logos;
/**
* @type {number}
- * @todo stability experimental
+ * @todo api
*/
oli.FrameState.prototype.pixelRatio;
@@ -106,7 +117,7 @@ oli.FrameState.prototype.tileQueue;
/**
* @type {number}
- * @todo stability experimental
+ * @todo api
*/
oli.FrameState.prototype.time;
@@ -117,7 +128,7 @@ oli.FrameState.prototype.usedTiles;
/**
* @type {oli.View2DState}
- * @todo stability experimental
+ * @todo api
*/
oli.FrameState.prototype.view2DState;
@@ -144,15 +155,24 @@ oli.ObjectEvent.prototype.key;
oli.MapBrowserEvent;
-/** @type {ol.Coordinate} */
+/**
+ * @type {ol.Coordinate}
+ * @todo api
+ */
oli.MapBrowserEvent.prototype.coordinate;
-/** @type {Event} */
+/**
+ * @type {Event}
+ * @todo api
+ */
oli.MapBrowserEvent.prototype.originalEvent;
-/** @type {ol.Pixel} */
+/**
+ * @type {ol.Pixel}
+ * @todo api
+ */
oli.MapBrowserEvent.prototype.pixel;
@@ -196,15 +216,24 @@ oli.control.Control.prototype.setMap = function(map) {};
oli.interaction.DragAndDropEvent;
-/** @type {Array.} */
+/**
+ * @type {Array.|undefined}
+ * @todo api
+ */
oli.interaction.DragAndDropEvent.prototype.features;
-/** @type {ol.proj.Projection} */
+/**
+ * @type {ol.proj.Projection|undefined}
+ * @todo api
+ */
oli.interaction.DragAndDropEvent.prototype.projection;
-/** @type {File} */
+/**
+ * @type {File}
+ * @todo api
+ */
oli.interaction.DragAndDropEvent.prototype.file;
@@ -212,19 +241,35 @@ oli.interaction.DragAndDropEvent.prototype.file;
oli.render.Event;
-/** @type {CanvasRenderingContext2D|null|undefined} */
+/**
+ * Canvas context. Only available when a Canvas renderer is used, null
+ * otherwise.
+ * @type {CanvasRenderingContext2D|null|undefined}
+ * @todo api
+ */
oli.render.Event.prototype.context;
-/** @type {oli.FrameState|undefined} */
+/**
+ * @type {oli.FrameState|undefined}
+ * @todo api
+ */
oli.render.Event.prototype.frameState;
-/** @type {ol.webgl.Context|null|undefined} */
+/**
+ * WebGL context. Only available when a WebGL renderer is used, null otherwise.
+ * @type {ol.webgl.Context|null|undefined}
+ * @todo api
+ */
oli.render.Event.prototype.glContext;
-/** @type {ol.render.IVectorContext|undefined} */
+/**
+ * For canvas, this is an instance of {@link ol.render.canvas.Immediate}.
+ * @type {ol.render.IVectorContext|undefined}
+ * @todo api
+ */
oli.render.Event.prototype.vectorContext;
@@ -233,5 +278,9 @@ oli.render.Event.prototype.vectorContext;
oli.source.VectorEvent;
-/** @type {ol.Feature} */
+/**
+ * The feature being added or removed.
+ * @type {ol.Feature}
+ * @todo api
+ */
oli.source.VectorEvent.prototype.feature;
diff --git a/externs/olx.js b/externs/olx.js
index 7d51dbbbfd..c939b81be9 100644
--- a/externs/olx.js
+++ b/externs/olx.js
@@ -7,7 +7,7 @@ var olx;
/**
* @typedef {{html: string,
* tileRanges: (Object.>|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.AttributionOptions;
@@ -29,7 +29,7 @@ olx.AttributionOptions.prototype.tileRanges;
/**
* @typedef {{loadTilesWhileAnimating: (boolean|undefined),
* loadTilesWhileInteracting: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.DeviceOptions;
@@ -52,7 +52,7 @@ olx.DeviceOptions.prototype.loadTilesWhileInteracting;
/**
* @typedef {{tracking: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.DeviceOrientationOptions;
@@ -68,7 +68,7 @@ olx.DeviceOrientationOptions.prototype.tracking;
* @typedef {{tracking: (boolean|undefined),
* trackingOptions: (GeolocationPositionOptions|undefined),
* projection: ol.proj.ProjectionLike}}
- * @todo stability experimental
+ * @todo api
*/
olx.GeolocationOptions;
@@ -107,7 +107,7 @@ olx.GeolocationOptions.prototype.projection;
* renderer: (ol.RendererHint|Array.|string|undefined),
* target: (Element|string|undefined),
* view: (ol.IView|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.MapOptions;
@@ -155,7 +155,8 @@ olx.MapOptions.prototype.keyboardEventTarget;
/**
- * Layers.
+ * Layers. Array or {@link ol.Collection} items are instances of
+ * {@link ol.layer.Layer} or any of its {@link ol.layer} subclasses.
* @type {Array.|ol.Collection|undefined}
*/
olx.MapOptions.prototype.layers;
@@ -205,7 +206,7 @@ olx.MapOptions.prototype.view;
* insertFirst: (boolean|undefined),
* offsetX: (number|undefined),
* offsetY: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.OverlayOptions;
@@ -271,7 +272,7 @@ olx.OverlayOptions.prototype.offsetY;
* @typedef {{code: string,
* extent: (ol.Extent|undefined),
* global: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.Proj4jsProjectionOptions;
@@ -304,7 +305,7 @@ olx.Proj4jsProjectionOptions.prototype.global;
* extent: (ol.Extent|undefined),
* axisOrientation: (string|undefined),
* global: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.ProjectionOptions;
@@ -358,7 +359,7 @@ olx.ProjectionOptions.prototype.global;
* rotation: (number|undefined),
* zoom: (number|undefined),
* zoomFactor: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.View2DOptions;
@@ -471,7 +472,7 @@ olx.View2DOptions.prototype.zoomFactor;
* start: (number|undefined),
* duration: (number|undefined),
* easing: (function(number):number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.animation.BounceOptions;
@@ -510,7 +511,7 @@ olx.animation.BounceOptions.prototype.easing;
* start: (number|undefined),
* duration: (number|undefined),
* easing: (function(number):number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.animation.PanOptions;
@@ -549,7 +550,7 @@ olx.animation.PanOptions.prototype.easing;
* start: (number|undefined),
* duration: (number|undefined),
* easing: (function(number):number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.animation.RotateOptions;
@@ -596,7 +597,7 @@ olx.animation.RotateOptions.prototype.easing;
* start: (number|undefined),
* duration: (number|undefined),
* easing: (function(number):number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.animation.ZoomOptions;
@@ -633,7 +634,7 @@ olx.animation.ZoomOptions.prototype.easing;
/**
* @typedef {{className: (string|undefined),
* target: (Element|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.AttributionOptions;
@@ -655,7 +656,7 @@ olx.control.AttributionOptions.prototype.target;
/**
* @typedef {{element: (Element|undefined),
* target: (Element|string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.ControlOptions;
@@ -683,7 +684,7 @@ olx.control.ControlOptions.prototype.target;
* logoOptions: (olx.control.LogoOptions|undefined),
* zoom: (boolean|undefined),
* zoomOptions: (olx.control.ZoomOptions|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.DefaultsOptions;
@@ -735,7 +736,7 @@ olx.control.DefaultsOptions.prototype.zoomOptions;
* tipLabel: (string|undefined),
* keys: (boolean|undefined),
* target: (Element|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.FullScreenOptions;
@@ -771,7 +772,7 @@ olx.control.FullScreenOptions.prototype.target;
/**
* @typedef {{className: (string|undefined),
* target: (Element|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.LogoOptions;
@@ -796,7 +797,7 @@ olx.control.LogoOptions.prototype.target;
* projection: ol.proj.ProjectionLike,
* target: (Element|undefined),
* undefinedHTML: (string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.MousePositionOptions;
@@ -841,7 +842,7 @@ olx.control.MousePositionOptions.prototype.undefinedHTML;
* minWidth: (number|undefined),
* target: (Element|undefined),
* units: (ol.control.ScaleLineUnits|string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.ScaleLineOptions;
@@ -883,7 +884,7 @@ olx.control.ScaleLineOptions.prototype.units;
* zoomOutTipLabel: (string|undefined),
* delta: (number|undefined),
* target: (Element|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.ZoomOptions;
@@ -948,7 +949,7 @@ olx.control.ZoomOptions.prototype.target;
* @typedef {{className: (string|undefined),
* maxResolution: (number|undefined),
* minResolution: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.ZoomSliderOptions;
@@ -979,7 +980,7 @@ olx.control.ZoomSliderOptions.prototype.minResolution;
* target: (Element|undefined),
* tipLabel: (string|undefined),
* extent: (ol.Extent|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.ZoomToExtentOptions;
@@ -1015,7 +1016,7 @@ olx.control.ZoomToExtentOptions.prototype.extent;
/**
* @typedef {{defaultProjection: ol.proj.ProjectionLike}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.GeoJSONOptions;
@@ -1029,7 +1030,7 @@ olx.format.GeoJSONOptions.prototype.defaultProjection;
/**
* @typedef {{defaultProjection: ol.proj.ProjectionLike}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.TopoJSONOptions;
@@ -1043,7 +1044,7 @@ olx.format.TopoJSONOptions.prototype.defaultProjection;
/**
* @typedef {{altitudeMode: (ol.format.IGCZ|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.IGCOptions;
@@ -1058,7 +1059,7 @@ olx.format.IGCOptions.prototype.altitudeMode;
/**
* @typedef {{defaultStyle: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.KMLOptions;
@@ -1079,7 +1080,7 @@ olx.format.KMLOptions.prototype.defaultStyle;
* multiCurve: (boolean|undefined),
* multiSurface: (boolean|undefined),
* schemaLocation: (string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.GMLOptions;
@@ -1149,7 +1150,7 @@ olx.format.GMLOptions.prototype.schemaLocation;
* @typedef {{featureNS: string,
* featureType: string,
* schemaLocation: (string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.WFSOptions;
@@ -1186,7 +1187,7 @@ olx.format.WFSOptions.prototype.schemaLocation;
* maxFeatures: (number|undefined),
* geometryName: (string|undefined),
* bbox: (ol.Extent|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.WFSWriteGetFeatureOptions;
@@ -1262,7 +1263,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.bbox;
* srsName: (string|undefined),
* handle: (string|undefined),
* nativeElements: Array.}}
- * @todo stability experimental
+ * @todo api
*/
olx.format.WFSWriteTransactionOptions;
@@ -1322,7 +1323,7 @@ olx.format.WFSWriteTransactionOptions.prototype.nativeElements;
* pinchZoom: (boolean|undefined),
* zoomDelta: (number|undefined),
* zoomDuration: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DefaultsOptions;
@@ -1400,7 +1401,7 @@ olx.interaction.DefaultsOptions.prototype.zoomDuration;
/**
* @typedef {{duration: (number|undefined),
* delta: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DoubleClickZoomOptions;
@@ -1422,7 +1423,7 @@ olx.interaction.DoubleClickZoomOptions.prototype.delta;
/**
* @typedef {{formatConstructors: (Array.|undefined),
* reprojectTo: ol.proj.ProjectionLike}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DragAndDropOptions;
@@ -1444,7 +1445,7 @@ olx.interaction.DragAndDropOptions.prototype.reprojectTo;
/**
* @typedef {{condition: (ol.events.ConditionType|undefined),
* style: ol.style.Style}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DragBoxOptions;
@@ -1466,7 +1467,7 @@ olx.interaction.DragBoxOptions.prototype.style;
/**
* @typedef {{kinetic: (ol.Kinetic|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DragPanOptions;
@@ -1480,7 +1481,7 @@ olx.interaction.DragPanOptions.prototype.kinetic;
/**
* @typedef {{condition: (ol.events.ConditionType|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DragRotateAndZoomOptions;
@@ -1495,7 +1496,7 @@ olx.interaction.DragRotateAndZoomOptions.prototype.condition;
/**
* @typedef {{condition: (ol.events.ConditionType|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DragRotateOptions;
@@ -1511,7 +1512,7 @@ olx.interaction.DragRotateOptions.prototype.condition;
/**
* @typedef {{condition: (ol.events.ConditionType|undefined),
* style: ol.style.Style}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DragZoomOptions;
@@ -1538,7 +1539,7 @@ olx.interaction.DragZoomOptions.prototype.style;
* type: ol.geom.GeometryType,
* minPointsPerRing: (number|undefined),
* style: (ol.style.Style|Array.|ol.feature.StyleFunction|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.DrawOptions;
@@ -1590,7 +1591,7 @@ olx.interaction.DrawOptions.prototype.style;
/**
* @typedef {{condition: (ol.events.ConditionType|undefined),
* pixelDelta: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.KeyboardPanOptions;
@@ -1614,7 +1615,7 @@ olx.interaction.KeyboardPanOptions.prototype.pixelDelta;
* @typedef {{duration: (number|undefined),
* condition: (ol.events.ConditionType|undefined),
* delta: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.KeyboardZoomOptions;
@@ -1646,7 +1647,7 @@ olx.interaction.KeyboardZoomOptions.prototype.delta;
* pixelTolerance: (number|undefined),
* style: (ol.style.Style|Array.|ol.feature.StyleFunction|undefined),
* features: ol.Collection}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.ModifyOptions;
@@ -1683,7 +1684,7 @@ olx.interaction.ModifyOptions.prototype.features;
/**
* @typedef {{duration: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.MouseWheelZoomOptions;
@@ -1697,7 +1698,7 @@ olx.interaction.MouseWheelZoomOptions.prototype.duration;
/**
* @typedef {{threshold: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.PinchRotateOptions;
@@ -1711,7 +1712,7 @@ olx.interaction.PinchRotateOptions.prototype.threshold;
/**
* @typedef {{duration: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.PinchZoomOptions;
@@ -1730,7 +1731,7 @@ olx.interaction.PinchZoomOptions.prototype.duration;
* style: (ol.style.Style|Array.|ol.feature.StyleFunction|undefined),
* removeCondition: (ol.events.ConditionType|undefined),
* toggleCondition: (ol.events.ConditionType|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.interaction.SelectOptions;
@@ -1797,7 +1798,7 @@ olx.interaction.SelectOptions.prototype.toggleCondition;
* visible: (boolean|undefined),
* minResolution: (number|undefined),
* maxResolution: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.layer.BaseOptions;
@@ -1868,7 +1869,7 @@ olx.layer.BaseOptions.prototype.maxResolution;
* visible: (boolean|undefined),
* minResolution: (number|undefined),
* maxResolution: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.layer.LayerOptions;
@@ -1946,7 +1947,7 @@ olx.layer.LayerOptions.prototype.maxResolution;
* minResolution: (number|undefined),
* maxResolution: (number|undefined),
* layers: (Array.|ol.Collection|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.layer.GroupOptions;
@@ -2029,7 +2030,7 @@ olx.layer.GroupOptions.prototype.layers;
* saturation: (number|undefined),
* source: ol.source.Vector,
* visible: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.layer.HeatmapOptions;
@@ -2147,7 +2148,7 @@ olx.layer.HeatmapOptions.prototype.visible;
* minResolution: (number|undefined),
* maxResolution: (number|undefined),
* useInterimTilesOnError: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.layer.TileOptions;
@@ -2241,7 +2242,7 @@ olx.layer.TileOptions.prototype.useInterimTilesOnError;
* source: ol.source.Vector,
* style: (ol.style.Style|Array.|ol.feature.StyleFunction|undefined),
* visible: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.layer.VectorOptions;
@@ -2329,7 +2330,7 @@ olx.layer.VectorOptions.prototype.visible;
* @typedef {{features: (Array.|ol.Collection|undefined),
* map: (ol.Map|undefined),
* style: (ol.style.Style|Array.|ol.feature.StyleFunction|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.FeatureOverlayOptions;
@@ -2360,7 +2361,7 @@ olx.FeatureOverlayOptions.prototype.style;
* key: string,
* imagerySet: string,
* tileLoadFunction: (ol.TileLoadFunctionType|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.BingMapsOptions;
@@ -2399,7 +2400,7 @@ olx.source.BingMapsOptions.prototype.tileLoadFunction;
* format: ol.format.Feature,
* logo: (string|undefined),
* projection: ol.proj.ProjectionLike}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.FormatVectorOptions;
@@ -2449,7 +2450,7 @@ olx.source.FormatVectorOptions.prototype.projection;
* text: (string|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.GeoJSONOptions;
@@ -2528,7 +2529,7 @@ olx.source.GeoJSONOptions.prototype.urls;
* text: (string|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.GPXOptions;
@@ -2610,7 +2611,7 @@ olx.source.GPXOptions.prototype.urls;
* tileGrid: (ol.tilegrid.TileGrid|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* tileUrlFunction: (ol.TileUrlFunctionType|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.TileImageOptions;
@@ -2698,7 +2699,7 @@ olx.source.TileImageOptions.prototype.tileUrlFunction;
* tileUrlFunction: (ol.TileUrlFunctionType|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.TileVectorOptions;
@@ -2784,7 +2785,7 @@ olx.source.TileVectorOptions.prototype.urls;
* projection: ol.proj.ProjectionLike,
* text: (string|undefined),
* url: (string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.TopoJSONOptions;
@@ -2852,7 +2853,7 @@ olx.source.TopoJSONOptions.prototype.url;
* text: (string|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.IGCOptions;
@@ -2905,7 +2906,7 @@ olx.source.IGCOptions.prototype.urls;
* ratio: (number|undefined),
* resolutions: (Array.|undefined),
* params: (Object|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.MapGuideOptions;
@@ -2993,7 +2994,7 @@ olx.source.MapGuideOptions.prototype.params;
* text: (string|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.KMLOptions;
@@ -3072,7 +3073,7 @@ olx.source.KMLOptions.prototype.urls;
/**
* @typedef {{layer: string,
* tileLoadFunction: (ol.TileLoadFunctionType|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.MapQuestOptions;
@@ -3095,7 +3096,7 @@ olx.source.MapQuestOptions.prototype.tileLoadFunction;
* @typedef {{extent: (ol.Extent|undefined),
* projection: ol.proj.ProjectionLike,
* tileGrid: (ol.tilegrid.TileGrid|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.TileDebugOptions;
@@ -3127,7 +3128,7 @@ olx.source.TileDebugOptions.prototype.tileGrid;
* maxZoom: (number|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.OSMOptions;
@@ -3180,7 +3181,7 @@ olx.source.OSMOptions.prototype.url;
* text: (string|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.OSMXMLOptions;
@@ -3271,7 +3272,7 @@ olx.source.OSMXMLOptions.prototype.urls;
* ratio: (number|undefined),
* resolutions: (Array.|undefined),
* state: (ol.source.State|string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.ImageCanvasOptions;
@@ -3350,7 +3351,7 @@ olx.source.ImageCanvasOptions.prototype.state;
* resolutions: (Array.|undefined),
* source: ol.source.Vector,
* style: (ol.style.Style|Array.|ol.feature.StyleFunction|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.ImageVectorOptions;
@@ -3426,7 +3427,7 @@ olx.source.ImageVectorOptions.prototype.style;
* ratio: (number|undefined),
* resolutions: (Array.|undefined),
* url: (string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.ImageWMSOptions;
@@ -3520,7 +3521,7 @@ olx.source.ImageWMSOptions.prototype.url;
* opaque: (boolean|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.StamenOptions;
@@ -3576,7 +3577,7 @@ olx.source.StamenOptions.prototype.url;
* logo: (string|undefined),
* projection: ol.proj.ProjectionLike,
* url: string}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.ImageStaticOptions;
@@ -3645,7 +3646,7 @@ olx.source.ImageStaticOptions.prototype.url;
* strategy: (function(ol.Extent, number): Array.|undefined),
* logo: (string|undefined),
* projection: ol.proj.ProjectionLike}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.ServerVectorOptions;
@@ -3703,7 +3704,7 @@ olx.source.ServerVectorOptions.prototype.projection;
* @typedef {{crossOrigin: (null|string|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: string}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.TileJSONOptions;
@@ -3744,7 +3745,7 @@ olx.source.TileJSONOptions.prototype.url;
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.TileWMSOptions;
@@ -3866,7 +3867,7 @@ olx.source.TileWMSOptions.prototype.urls;
* logo: (string|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.VectorOptions;
@@ -3926,7 +3927,7 @@ olx.source.VectorOptions.prototype.state;
* text: (string|undefined),
* url: (string|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.StaticVectorOptions;
@@ -4033,7 +4034,7 @@ olx.source.StaticVectorOptions.prototype.urls;
* maxZoom: (number|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* urls: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.WMTSOptions;
@@ -4170,7 +4171,7 @@ olx.source.WMTSOptions.prototype.urls;
* url: (string|undefined),
* urls: (Array.|undefined),
* wrapX: (boolean|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.XYZOptions;
@@ -4267,7 +4268,7 @@ olx.source.XYZOptions.prototype.wrapX;
* url: !string,
* tierSizeCalculation: (string|undefined),
* size: ol.Size}}
- * @todo stability experimental
+ * @todo api
*/
olx.source.ZoomifyOptions;
@@ -4318,7 +4319,7 @@ olx.source.ZoomifyOptions.prototype.size;
* @typedef {{fill: (ol.style.Fill|undefined),
* radius: number,
* stroke: (ol.style.Stroke|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.style.CircleOptions;
@@ -4346,7 +4347,7 @@ olx.style.CircleOptions.prototype.stroke;
/**
* @typedef {{color: (ol.Color|string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.style.FillOptions;
@@ -4369,7 +4370,7 @@ olx.style.FillOptions.prototype.color;
* rotation: (number|undefined),
* size: (ol.Size|undefined),
* src: string}}
- * @todo stability experimental
+ * @todo api
*/
olx.style.IconOptions;
@@ -4456,7 +4457,7 @@ olx.style.IconOptions.prototype.src;
* lineDash: (Array.|undefined),
* miterLimit: (number|undefined),
* width: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.style.StrokeOptions;
@@ -4514,7 +4515,7 @@ olx.style.StrokeOptions.prototype.width;
* textBaseline: (string|undefined),
* fill: (ol.style.Fill|undefined),
* stroke: (ol.style.Stroke|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.style.TextOptions;
@@ -4597,7 +4598,7 @@ olx.style.TextOptions.prototype.stroke;
* stroke: (ol.style.Stroke|undefined),
* text: (ol.style.Text|undefined),
* zIndex: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.style.StyleOptions;
@@ -4644,7 +4645,7 @@ olx.style.StyleOptions.prototype.zIndex;
* resolutions: !Array.,
* tileSize: (number|undefined),
* tileSizes: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.tilegrid.TileGridOptions;
@@ -4698,7 +4699,7 @@ olx.tilegrid.TileGridOptions.prototype.tileSizes;
* matrixIds: !Array.,
* tileSize: (number|undefined),
* tileSizes: (Array.|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.tilegrid.WMTSOptions;
@@ -4747,7 +4748,7 @@ olx.tilegrid.WMTSOptions.prototype.tileSizes;
/**
* @typedef {{maxZoom: number}}
- * @todo stability experimental
+ * @todo api
*/
olx.tilegrid.XYZOptions;
@@ -4761,7 +4762,7 @@ olx.tilegrid.XYZOptions.prototype.maxZoom;
/**
* @typedef {{resolutions: !Array.}}
- * @todo stability experimental
+ * @todo api
*/
olx.tilegrid.ZoomifyOptions;
@@ -4778,7 +4779,7 @@ olx.tilegrid.ZoomifyOptions.prototype.resolutions;
* constrainResolution: (boolean|undefined),
* nearest: (boolean|undefined),
* minResolution: (number|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.View2D.fitGeometryOptions;
diff --git a/externs/readme.md b/externs/readme.md
index 05b517aba3..9315b6b6c0 100644
--- a/externs/readme.md
+++ b/externs/readme.md
@@ -13,7 +13,10 @@ For events, we make properties available to the application. Other than methods,
/** @interface */
oli.MapBrowserEvent;
-/** @type {ol.Coordinate} */
+/**
+ * @type {ol.Coordinate}
+ * @todo api
+ */
oli.MapBrowserEvent.prototype.coordinate;
```
In the source file (`src/ol/MapBrowserEvent.js`), the class needs to implement this interface:
@@ -29,13 +32,13 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
/**
* @type {ol.Coordinate}
- * @todo stability experimental
*/
this.coordinate = map.getEventCoordinate(this.originalEvent);
// ...
};
+```
### Override methods in custom classes
@@ -69,7 +72,7 @@ ol.control.Control = function(options) {
/**
* Application subclasses may override this.
* @param {ol.Map} map Map.
- * @todo stability experimental
+ * @todo api
*/
ol.control.Control.prototype.setMap = function(map) {
// ...
@@ -83,7 +86,7 @@ Object literals cannot be exported like classes. To make sure that their propert
/**
* @typedef {{element: (Element|undefined),
* target: (Element|string|undefined)}}
- * @todo stability experimental
+ * @todo api
*/
olx.control.ControlOptions;
@@ -103,6 +106,7 @@ olx.control.ControlOptions.prototype.target;
```
In the source code, the name used for the typedef is used as type whenever this object literal is expected:
```js
+/**
* ...
* @param {olx.control.ControlOptions} options Control options.
*/
diff --git a/src/ol/animation.js b/src/ol/animation.js
index e0bb3b7a16..29ec08499a 100644
--- a/src/ol/animation.js
+++ b/src/ol/animation.js
@@ -11,7 +11,6 @@ goog.require('ol.easing');
/**
* @param {olx.animation.BounceOptions} options Bounce options.
* @return {ol.PreRenderFunction} Pre-render function.
- * @todo stability experimental
* @todo api
*/
ol.animation.bounce = function(options) {
@@ -47,7 +46,6 @@ ol.animation.bounce = function(options) {
/**
* @param {olx.animation.PanOptions} options Pan options.
* @return {ol.PreRenderFunction} Pre-render function.
- * @todo stability experimental
* @todo api
*/
ol.animation.pan = function(options) {
@@ -87,7 +85,6 @@ ol.animation.pan = function(options) {
/**
* @param {olx.animation.RotateOptions} options Rotate options.
* @return {ol.PreRenderFunction} Pre-render function.
- * @todo stability experimental
* @todo api
*/
ol.animation.rotate = function(options) {
@@ -133,7 +130,6 @@ ol.animation.rotate = function(options) {
/**
* @param {olx.animation.ZoomOptions} options Zoom options.
* @return {ol.PreRenderFunction} Pre-render function.
- * @todo stability experimental
* @todo api
*/
ol.animation.zoom = function(options) {
diff --git a/src/ol/attribution.js b/src/ol/attribution.js
index bfaebf8364..2f89291d68 100644
--- a/src/ol/attribution.js
+++ b/src/ol/attribution.js
@@ -22,7 +22,6 @@ goog.require('ol.TileRange');
* @constructor
* @param {olx.AttributionOptions} options Attribution options.
* @struct
- * @todo stability experimental
* @todo api
*/
ol.Attribution = function(options) {
diff --git a/src/ol/browserfeature.js b/src/ol/browserfeature.js
index becda2e80a..b6ab5c1452 100644
--- a/src/ol/browserfeature.js
+++ b/src/ol/browserfeature.js
@@ -77,7 +77,6 @@ ol.IS_LEGACY_IE = goog.userAgent.IE &&
* (dips) on the device (`window.devicePixelRatio`).
* @const
* @type {number}
- * @todo stability experimental
* @todo api
*/
ol.BrowserFeature.DEVICE_PIXEL_RATIO = goog.global.devicePixelRatio || 1;
@@ -102,7 +101,6 @@ ol.BrowserFeature.HAS_CANVAS_LINE_DASH = false;
* True if browser supports Canvas.
* @const
* @type {boolean}
- * @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && (
@@ -133,7 +131,6 @@ ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && (
* Indicates if DeviceOrientation is supported in the user's browser.
* @const
* @type {boolean}
- * @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_DEVICE_ORIENTATION =
@@ -152,7 +149,6 @@ ol.BrowserFeature.HAS_DOM = ol.ENABLE_DOM;
* Is HTML5 geolocation supported in the current browser?
* @const
* @type {boolean}
- * @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_GEOLOCATION = 'geolocation' in goog.global.navigator;
@@ -170,7 +166,6 @@ ol.BrowserFeature.HAS_JSON_PARSE =
* True if browser supports touch events.
* @const
* @type {boolean}
- * @todo stability experimental
* @todo api
*/
ol.BrowserFeature.HAS_TOUCH = ol.ASSUME_TOUCH || 'ontouchstart' in goog.global;
diff --git a/src/ol/canvasfunction.js b/src/ol/canvasfunction.js
index 10caa4be88..a9e9e7dc80 100644
--- a/src/ol/canvasfunction.js
+++ b/src/ol/canvasfunction.js
@@ -12,6 +12,6 @@ goog.provide('ol.CanvasFunctionType');
*
* @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number,
* number, ol.Size, ol.proj.Projection): HTMLCanvasElement}
- * @todo stability experimental
+ * @todo api
*/
ol.CanvasFunctionType;
diff --git a/src/ol/centerconstraint.js b/src/ol/centerconstraint.js
index 790e53237f..0a7b5ed830 100644
--- a/src/ol/centerconstraint.js
+++ b/src/ol/centerconstraint.js
@@ -6,7 +6,7 @@ goog.require('goog.math');
/**
* @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)}
- * @todo stability experimental
+ * @todo api
*/
ol.CenterConstraintType;
diff --git a/src/ol/collection.js b/src/ol/collection.js
index 6c44ac50c5..667c6fa0a0 100644
--- a/src/ol/collection.js
+++ b/src/ol/collection.js
@@ -19,13 +19,13 @@ ol.CollectionEventType = {
/**
* Triggered when an item is added to the collection.
* @event ol.CollectionEvent#add
- * @todo stability experimental
+ * @todo api
*/
ADD: 'add',
/**
* Triggered when an item is removed from the collection.
* @event ol.CollectionEvent#remove
- * @todo stability experimental
+ * @todo api
*/
REMOVE: 'remove'
};
@@ -47,7 +47,6 @@ ol.CollectionEvent = function(type, opt_element, opt_target) {
/**
* The element that is added to or removed from the collection.
* @type {*}
- * @todo stability experimental
*/
this.element = opt_element;
@@ -70,7 +69,6 @@ ol.CollectionProperty = {
* @extends {ol.Object}
* @fires {@link ol.CollectionEvent} ol.CollectionEvent
* @param {Array=} opt_array Array.
- * @todo stability experimental
* @todo observable length {number} readonly the length of the array
* @todo api
*/
@@ -92,7 +90,6 @@ goog.inherits(ol.Collection, ol.Object);
/**
* Remove all elements from the collection.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.clear = function() {
@@ -105,7 +102,6 @@ ol.Collection.prototype.clear = function() {
/**
* @param {Array} arr Array.
* @return {ol.Collection} This collection.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.extend = function(arr) {
@@ -124,7 +120,6 @@ ol.Collection.prototype.extend = function(arr) {
* index and the array). The return value is ignored.
* @param {S=} opt_this The object to use as `this` in `f`.
* @template T,S
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.forEach = function(f, opt_this) {
@@ -138,7 +133,6 @@ ol.Collection.prototype.forEach = function(f, opt_this) {
* collection's "length" property won't be in sync with the actual length
* of the array.
* @return {Array} Array.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.getArray = function() {
@@ -150,7 +144,6 @@ ol.Collection.prototype.getArray = function() {
* Get the element at the provided index.
* @param {number} index Index.
* @return {*} Element.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.getAt = function(index) {
@@ -161,7 +154,6 @@ ol.Collection.prototype.getAt = function(index) {
/**
* Get the length of this collection.
* @return {number} Length.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.getLength = function() {
@@ -173,7 +165,6 @@ ol.Collection.prototype.getLength = function() {
* Insert an element at the provided index.
* @param {number} index Index.
* @param {*} elem Element.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.insertAt = function(index, elem) {
@@ -187,7 +178,6 @@ ol.Collection.prototype.insertAt = function(index, elem) {
/**
* Remove the last element of the collection.
* @return {*} Element.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.pop = function() {
@@ -199,7 +189,6 @@ ol.Collection.prototype.pop = function() {
* Insert the provided element at the end of the collection.
* @param {*} elem Element.
* @return {number} Length.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.push = function(elem) {
@@ -213,7 +202,6 @@ ol.Collection.prototype.push = function(elem) {
* Removes the first occurence of elem from the collection.
* @param {*} elem Element.
* @return {*} The removed element or undefined if elem was not found.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.remove = function(elem) {
@@ -232,7 +220,6 @@ ol.Collection.prototype.remove = function(elem) {
* Remove the element at the provided index.
* @param {number} index Index.
* @return {*} Value.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.removeAt = function(index) {
@@ -249,7 +236,6 @@ ol.Collection.prototype.removeAt = function(index) {
* Set the element at the provided index.
* @param {number} index Index.
* @param {*} elem Element.
- * @todo stability experimental
* @todo api
*/
ol.Collection.prototype.setAt = function(index, elem) {
diff --git a/src/ol/color/color.js b/src/ol/color/color.js
index 987e776e0c..b33768ca52 100644
--- a/src/ol/color/color.js
+++ b/src/ol/color/color.js
@@ -103,7 +103,6 @@ ol.color.blend = function(dst, src, opt_color) {
/**
* @param {ol.Color|string} color Color.
* @return {ol.Color} Color.
- * @todo stability experimental
* @todo api
*/
ol.color.asArray = function(color) {
@@ -119,7 +118,6 @@ ol.color.asArray = function(color) {
/**
* @param {ol.Color|string} color Color.
* @return {string} String.
- * @todo stability experimental
* @todo api
*/
ol.color.asString = function(color) {
diff --git a/src/ol/control/attributioncontrol.js b/src/ol/control/attributioncontrol.js
index 7992201ed9..8790894c95 100644
--- a/src/ol/control/attributioncontrol.js
+++ b/src/ol/control/attributioncontrol.js
@@ -21,7 +21,6 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.AttributionOptions=} opt_options Attribution options.
- * @todo stability experimental
* @todo api
*/
ol.control.Attribution = function(opt_options) {
diff --git a/src/ol/control/control.js b/src/ol/control/control.js
index 2fa119057a..a26cfc1f0f 100644
--- a/src/ol/control/control.js
+++ b/src/ol/control/control.js
@@ -16,8 +16,7 @@ goog.require('ol.Object');
* @extends {ol.Object}
* @implements {oli.control.Control}
* @param {olx.control.ControlOptions} options Control options.
- * @todo stability stable
- * @todo api
+ * @todo api stable
*/
ol.control.Control = function(options) {
@@ -64,7 +63,6 @@ ol.control.Control.prototype.disposeInternal = function() {
/**
* Get the map associated with this control.
* @return {ol.Map} Map.
- * @todo stability experimental
* @todo api
*/
ol.control.Control.prototype.getMap = function() {
@@ -86,8 +84,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction;
* Subclasses may set up event handlers to get notified about changes to
* the map here.
* @param {ol.Map} map Map.
- * @todo stability stable
- * @todo api
+ * @todo api stable
*/
ol.control.Control.prototype.setMap = function(map) {
if (!goog.isNull(this.map_)) {
diff --git a/src/ol/control/controldefaults.js b/src/ol/control/controldefaults.js
index 89360eb0c9..667d63eee3 100644
--- a/src/ol/control/controldefaults.js
+++ b/src/ol/control/controldefaults.js
@@ -9,7 +9,6 @@ goog.require('ol.control.Zoom');
/**
* @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls.
- * @todo stability experimental
* @todo api
*/
ol.control.defaults = function(opt_options) {
diff --git a/src/ol/control/fullscreencontrol.js b/src/ol/control/fullscreencontrol.js
index 50e473e1c7..0eec49e02d 100644
--- a/src/ol/control/fullscreencontrol.js
+++ b/src/ol/control/fullscreencontrol.js
@@ -24,7 +24,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.FullScreenOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.control.FullScreen = function(opt_options) {
diff --git a/src/ol/control/logocontrol.js b/src/ol/control/logocontrol.js
index 42f82b33c0..def0bb0453 100644
--- a/src/ol/control/logocontrol.js
+++ b/src/ol/control/logocontrol.js
@@ -17,7 +17,6 @@ goog.require('ol.css');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.LogoOptions=} opt_options Logo options.
- * @todo stability experimental
* @todo api
*/
ol.control.Logo = function(opt_options) {
diff --git a/src/ol/control/mousepositioncontrol.js b/src/ol/control/mousepositioncontrol.js
index 0b559c716d..6649c1434b 100644
--- a/src/ol/control/mousepositioncontrol.js
+++ b/src/ol/control/mousepositioncontrol.js
@@ -42,7 +42,6 @@ ol.control.MousePositionProperty = {
* mouse position in
* @todo observable coordinateFormat {ol.CoordinateFormatType} the format to
* render the current position in
- * @todo stability experimental
* @todo api
*/
ol.control.MousePosition = function(opt_options) {
@@ -133,8 +132,8 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
/**
- * @return {ol.CoordinateFormatType|undefined} projection.
- * @todo stability experimental
+ * @return {ol.CoordinateFormatType|undefined} Coordinate format.
+ * @todo api
*/
ol.control.MousePosition.prototype.getCoordinateFormat = function() {
return /** @type {ol.CoordinateFormatType|undefined} */ (
@@ -147,8 +146,8 @@ goog.exportProperty(
/**
- * @return {ol.proj.Projection|undefined} projection.
- * @todo stability experimental
+ * @return {ol.proj.Projection|undefined} Projection.
+ * @todo api
*/
ol.control.MousePosition.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -203,7 +202,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
/**
* @param {ol.CoordinateFormatType} format Coordinate format.
- * @todo stability experimental
+ * @todo api
*/
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
@@ -216,7 +215,7 @@ goog.exportProperty(
/**
* @param {ol.proj.Projection} projection Projection.
- * @todo stability experimental
+ * @todo api
*/
ol.control.MousePosition.prototype.setProjection = function(projection) {
this.set(ol.control.MousePositionProperty.PROJECTION, projection);
diff --git a/src/ol/control/scalelinecontrol.js b/src/ol/control/scalelinecontrol.js
index efd8604aa4..93f43edd63 100644
--- a/src/ol/control/scalelinecontrol.js
+++ b/src/ol/control/scalelinecontrol.js
@@ -20,7 +20,6 @@ goog.require('ol.sphere.NORMAL');
/**
* @enum {string}
- * @todo stability experimental
*/
ol.control.ScaleLineProperty = {
UNITS: 'units'
@@ -28,8 +27,10 @@ ol.control.ScaleLineProperty = {
/**
+ * Units for the scale line. Supported values are `'degrees'`, `'imperial'`,
+ * `'nautical'`, `'metric'`, `'us'`.
* @enum {string}
- * @todo stability experimental
+ * @todo api
*/
ol.control.ScaleLineUnits = {
DEGREES: 'degrees',
@@ -51,7 +52,6 @@ ol.control.ScaleLineUnits = {
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @todo observable units {ol.control.ScaleLineUnits} the units to use in the
* scale line
- * @todo stability experimental
* @todo api
*/
ol.control.ScaleLine = function(opt_options) {
@@ -132,14 +132,13 @@ goog.inherits(ol.control.ScaleLine, ol.control.Control);
/**
* @const
* @type {Array.}
- * @todo stability experimental
*/
ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
/**
* @return {ol.control.ScaleLineUnits|undefined} units.
- * @todo stability experimental
+ * @todo api
*/
ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -175,7 +174,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/**
* @param {ol.control.ScaleLineUnits} units Units.
- * @todo stability experimental
+ * @todo api
*/
ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units);
diff --git a/src/ol/control/zoomcontrol.js b/src/ol/control/zoomcontrol.js
index d77f6d222a..f36794036c 100644
--- a/src/ol/control/zoomcontrol.js
+++ b/src/ol/control/zoomcontrol.js
@@ -23,7 +23,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomOptions=} opt_options Zoom options.
- * @todo stability experimental
* @todo api
*/
ol.control.Zoom = function(opt_options) {
diff --git a/src/ol/control/zoomslidercontrol.js b/src/ol/control/zoomslidercontrol.js
index 6714321150..d10b8d2825 100644
--- a/src/ol/control/zoomslidercontrol.js
+++ b/src/ol/control/zoomslidercontrol.js
@@ -38,7 +38,6 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
- * @todo stability experimental
* @todo api
*/
ol.control.ZoomSlider = function(opt_options) {
diff --git a/src/ol/control/zoomtoextentcontrol.js b/src/ol/control/zoomtoextentcontrol.js
index f1942df12c..d87a050d7b 100644
--- a/src/ol/control/zoomtoextentcontrol.js
+++ b/src/ol/control/zoomtoextentcontrol.js
@@ -20,7 +20,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ZoomToExtentOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.control.ZoomToExtent = function(opt_options) {
diff --git a/src/ol/coordinate.js b/src/ol/coordinate.js
index 3132a7dd47..bcddadc1fb 100644
--- a/src/ol/coordinate.js
+++ b/src/ol/coordinate.js
@@ -11,7 +11,7 @@ goog.require('goog.math');
* `{string}`.
*
* @typedef {function((ol.Coordinate|undefined)): string}
- * @todo stability experimental
+ * @todo api
*/
ol.CoordinateFormatType;
@@ -19,7 +19,7 @@ ol.CoordinateFormatType;
/**
* An array of numbers representing a coordinate.
* @typedef {Array.} ol.Coordinate
- * @todo stability experimental
+ * @todo api
*/
ol.Coordinate;
@@ -27,7 +27,7 @@ ol.Coordinate;
/**
* An array of coordinate arrays.
* @typedef {Array.}
- * @todo stability experimental
+ * @todo api
*/
ol.CoordinateArray;
@@ -36,7 +36,6 @@ ol.CoordinateArray;
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate.
- * @todo stability experimental
* @todo api
*/
ol.coordinate.add = function(coordinate, delta) {
@@ -89,7 +88,6 @@ ol.coordinate.closestOnSegment = function(coordinate, segment) {
* @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`.
* @return {ol.CoordinateFormatType} Coordinate format.
- * @todo stability experimental
* @todo api
*/
ol.coordinate.createStringXY = function(opt_fractionDigits) {
@@ -127,7 +125,6 @@ ol.coordinate.degreesToStringHDMS_ = function(degrees, hemispheres) {
* @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`.
* @return {string} Formated coordinate.
- * @todo stability experimental
* @todo api
*/
ol.coordinate.format = function(coordinate, template, opt_fractionDigits) {
@@ -162,7 +159,6 @@ ol.coordinate.equals = function(coordinate1, coordinate2) {
* @param {ol.Coordinate} coordinate Coordinate.
* @param {number} angle Angle.
* @return {ol.Coordinate} Coordinate.
- * @todo stability experimental
* @todo api
*/
ol.coordinate.rotate = function(coordinate, angle) {
@@ -228,7 +224,6 @@ ol.coordinate.squaredDistanceToSegment = function(coordinate, segment) {
/**
* @param {ol.Coordinate|undefined} coordinate Coordinate.
* @return {string} Hemisphere, degrees, minutes and seconds.
- * @todo stability experimental
* @todo api
*/
ol.coordinate.toStringHDMS = function(coordinate) {
@@ -246,7 +241,6 @@ ol.coordinate.toStringHDMS = function(coordinate) {
* @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`.
* @return {string} XY.
- * @todo stability experimental
* @todo api
*/
ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
@@ -259,7 +253,6 @@ ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
* @param {Array} array The array with coordinates.
* @param {string} axis the axis info.
* @return {ol.Coordinate} The coordinate created.
- * @todo stability experimental
* @todo api
*/
ol.coordinate.fromProjectedArray = function(array, axis) {
diff --git a/src/ol/deviceorientation.js b/src/ol/deviceorientation.js
index 03dd0299c3..33915b7ac1 100644
--- a/src/ol/deviceorientation.js
+++ b/src/ol/deviceorientation.js
@@ -79,7 +79,6 @@ ol.DeviceOrientationProperty = {
* device from the planar Y axis
* @todo observable tracking {boolean} the status of tracking changes to alpha,
* beta and gamma. If true, changes are tracked and reported immediately.
- * @todo stability experimental
* @todo api
*/
ol.DeviceOrientation = function(opt_options) {
@@ -148,7 +147,7 @@ ol.DeviceOrientation.prototype.orientationChange_ = function(browserEvent) {
/**
* @return {number|undefined} The alpha value of the DeviceOrientation,
* in radians.
- * @todo stability experimental
+ * @todo api
*/
ol.DeviceOrientation.prototype.getAlpha = function() {
return /** @type {number|undefined} */ (
@@ -163,7 +162,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The beta value of the DeviceOrientation,
* in radians.
- * @todo stability experimental
+ * @todo api
*/
ol.DeviceOrientation.prototype.getBeta = function() {
return /** @type {number|undefined} */ (
@@ -178,7 +177,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The gamma value of the DeviceOrientation,
* in radians.
- * @todo stability experimental
+ * @todo api
*/
ol.DeviceOrientation.prototype.getGamma = function() {
return /** @type {number|undefined} */ (
@@ -193,7 +192,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The heading of the device relative to
* north, in radians, normalizing for different browser behavior.
- * @todo stability experimental
+ * @todo api
*/
ol.DeviceOrientation.prototype.getHeading = function() {
return /** @type {number|undefined} */ (
@@ -208,7 +207,7 @@ goog.exportProperty(
/**
* Are we tracking the device's orientation?
* @return {boolean} The current tracking state, true if tracking is on.
- * @todo stability experimental
+ * @todo api
*/
ol.DeviceOrientation.prototype.getTracking = function() {
return /** @type {boolean} */ (
@@ -240,7 +239,7 @@ ol.DeviceOrientation.prototype.handleTrackingChanged_ = function() {
/**
* Enable or disable tracking of DeviceOrientation events.
* @param {boolean} tracking True to enable and false to disable tracking.
- * @todo stability experimental
+ * @todo api
*/
ol.DeviceOrientation.prototype.setTracking = function(tracking) {
this.set(ol.DeviceOrientationProperty.TRACKING, tracking);
diff --git a/src/ol/dom/input.js b/src/ol/dom/input.js
index 64d776d4b0..07c8483f6f 100644
--- a/src/ol/dom/input.js
+++ b/src/ol/dom/input.js
@@ -31,7 +31,6 @@ ol.dom.InputProperty = {
* @param {Element} target Target element.
* @todo observable value {string} the value of the Input
* @todo observable checked {boolean} the checked state of the Input
- * @todo stability experimental
* @todo api
*/
ol.dom.Input = function(target) {
@@ -60,7 +59,7 @@ goog.inherits(ol.dom.Input, ol.Object);
/**
* If the input is a checkbox, return whether or not the checbox is checked.
* @return {boolean|undefined} checked.
- * @todo stability experimental
+ * @todo api
*/
ol.dom.Input.prototype.getChecked = function() {
return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED));
@@ -74,7 +73,7 @@ goog.exportProperty(
/**
* Get the value of the input.
* @return {string|undefined} input value.
- * @todo stability experimental
+ * @todo api
*/
ol.dom.Input.prototype.getValue = function() {
return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE));
@@ -88,7 +87,7 @@ goog.exportProperty(
/**
* Sets the value of the input.
* @param {string} value Value.
- * @todo stability experimental
+ * @todo api
*/
ol.dom.Input.prototype.setValue = function(value) {
this.set(ol.dom.InputProperty.VALUE, value);
@@ -102,7 +101,7 @@ goog.exportProperty(
/**
* Set whether or not a checkbox is checked.
* @param {boolean} checked Checked.
- * @todo stability experimental
+ * @todo api
*/
ol.dom.Input.prototype.setChecked = function(checked) {
this.set(ol.dom.InputProperty.CHECKED, checked);
diff --git a/src/ol/easing.js b/src/ol/easing.js
index 5bcba9aeb0..179f948805 100644
--- a/src/ol/easing.js
+++ b/src/ol/easing.js
@@ -7,7 +7,6 @@ goog.require('goog.fx.easing');
* from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
- * @todo stability experimental
* @todo api
*/
ol.easing.bounce = function(t) {
@@ -35,7 +34,6 @@ ol.easing.bounce = function(t) {
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
- * @todo stability experimental
* @todo api
*/
ol.easing.easeIn = goog.fx.easing.easeIn;
@@ -44,7 +42,6 @@ ol.easing.easeIn = goog.fx.easing.easeIn;
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
- * @todo stability experimental
* @todo api
*/
ol.easing.easeOut = goog.fx.easing.easeOut;
@@ -54,7 +51,6 @@ ol.easing.easeOut = goog.fx.easing.easeOut;
* from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
- * @todo stability experimental
* @todo api
*/
ol.easing.elastic = function(t) {
@@ -65,7 +61,6 @@ ol.easing.elastic = function(t) {
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
- * @todo stability experimental
* @todo api
*/
ol.easing.inAndOut = goog.fx.easing.inAndOut;
@@ -74,7 +69,6 @@ ol.easing.inAndOut = goog.fx.easing.inAndOut;
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
- * @todo stability experimental
* @todo api
*/
ol.easing.linear = function(t) {
@@ -85,7 +79,6 @@ ol.easing.linear = function(t) {
/**
* @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1.
- * @todo stability experimental
* @todo api
*/
ol.easing.upAndDown = function(t) {
diff --git a/src/ol/events/condition.js b/src/ol/events/condition.js
index 77d6e7ef51..8a77526919 100644
--- a/src/ol/events/condition.js
+++ b/src/ol/events/condition.js
@@ -13,7 +13,7 @@ goog.require('ol.MapBrowserPointerEvent');
* `{boolean}`. If the condition is met, true should be returned.
*
* @typedef {function(ol.MapBrowserEvent): boolean}
- * @todo stability experimental
+ * @todo api
*/
ol.events.ConditionType;
@@ -21,7 +21,6 @@ ol.events.ConditionType;
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt key is pressed.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
@@ -36,7 +35,6 @@ ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt and shift keys are pressed.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
@@ -52,7 +50,6 @@ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
* Always true.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.always = goog.functions.TRUE;
@@ -62,7 +59,6 @@ ol.events.condition.always = goog.functions.TRUE;
* Always false.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} False.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.never = goog.functions.FALSE;
@@ -80,7 +76,6 @@ ol.events.condition.singleClick = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if there no modifier keys are pressed.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
@@ -95,7 +90,6 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the platform modifier key is pressed.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
@@ -110,7 +104,6 @@ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the shift key is pressed.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
@@ -125,7 +118,6 @@ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
/**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if the target element is not editable.
- * @todo stability experimental
* @todo api
*/
ol.events.condition.targetNotEditable = function(mapBrowserEvent) {
diff --git a/src/ol/extent.js b/src/ol/extent.js
index 6da5104737..3e85f5a04e 100644
--- a/src/ol/extent.js
+++ b/src/ol/extent.js
@@ -12,7 +12,7 @@ goog.require('ol.TransformFunction');
/**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.}
- * @todo stability experimental
+ * @todo api
*/
ol.Extent;
@@ -36,7 +36,6 @@ ol.extent.Relationship = {
*
* @param {Array.} coordinates Coordinates.
* @return {ol.Extent} Bounding extent.
- * @todo stability experimental
* @todo api
*/
ol.extent.boundingExtent = function(coordinates) {
@@ -72,7 +71,6 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
* @param {number} value The amount by wich the extent should be buffered.
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} Extent.
- * @todo stability experimental
* @todo api
*/
ol.extent.buffer = function(extent, value, opt_extent) {
@@ -145,7 +143,6 @@ ol.extent.closestSquaredDistanceXY = function(extent, x, y) {
* @param {ol.Extent} extent Extent.
* @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains.
- * @todo stability experimental
* @todo api
*/
ol.extent.containsCoordinate = function(extent, coordinate) {
@@ -160,7 +157,6 @@ ol.extent.containsCoordinate = function(extent, coordinate) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Contains.
- * @todo stability experimental
* @todo api
*/
ol.extent.containsExtent = function(extent1, extent2) {
@@ -203,7 +199,6 @@ ol.extent.coordinateRelationship = function(extent, coordinate) {
/**
* @return {ol.Extent} Empty extent.
- * @todo stability experimental
* @todo api
*/
ol.extent.createEmpty = function() {
@@ -308,7 +303,6 @@ ol.extent.empty = function(extent) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Equals.
- * @todo stability experimental
* @todo api
*/
ol.extent.equals = function(extent1, extent2) {
@@ -321,7 +315,6 @@ ol.extent.equals = function(extent1, extent2) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2.
* @return {ol.Extent} Extent.
- * @todo stability experimental
* @todo api
*/
ol.extent.extend = function(extent1, extent2) {
@@ -432,7 +425,6 @@ ol.extent.getArea = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom left coordinate.
- * @todo stability experimental
* @todo api
*/
ol.extent.getBottomLeft = function(extent) {
@@ -443,7 +435,6 @@ ol.extent.getBottomLeft = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom right coordinate.
- * @todo stability experimental
* @todo api
*/
ol.extent.getBottomRight = function(extent) {
@@ -454,7 +445,6 @@ ol.extent.getBottomRight = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Center.
- * @todo stability experimental
* @todo api
*/
ol.extent.getCenter = function(extent) {
@@ -508,7 +498,6 @@ ol.extent.getForView2DAndSize =
/**
* @param {ol.Extent} extent Extent.
* @return {number} Height.
- * @todo stability experimental
* @todo api
*/
ol.extent.getHeight = function(extent) {
@@ -542,7 +531,6 @@ ol.extent.getMargin = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Size} Size.
- * @todo stability experimental
* @todo api
*/
ol.extent.getSize = function(extent) {
@@ -553,7 +541,6 @@ ol.extent.getSize = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top left coordinate.
- * @todo stability experimental
* @todo api
*/
ol.extent.getTopLeft = function(extent) {
@@ -564,7 +551,6 @@ ol.extent.getTopLeft = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top right coordinate.
- * @todo stability experimental
* @todo api
*/
ol.extent.getTopRight = function(extent) {
@@ -575,7 +561,6 @@ ol.extent.getTopRight = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {number} Width.
- * @todo stability experimental
* @todo api
*/
ol.extent.getWidth = function(extent) {
@@ -587,7 +572,6 @@ ol.extent.getWidth = function(extent) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent.
* @return {boolean} Intersects.
- * @todo stability experimental
* @todo api
*/
ol.extent.intersects = function(extent1, extent2) {
@@ -601,7 +585,6 @@ ol.extent.intersects = function(extent1, extent2) {
/**
* @param {ol.Extent} extent Extent.
* @return {boolean} Is empty.
- * @todo stability experimental
* @todo api
*/
ol.extent.isEmpty = function(extent) {
@@ -735,7 +718,6 @@ ol.extent.touches = function(extent1, extent2) {
* @param {ol.TransformFunction} transformFn Transform function.
* @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent.
- * @todo stability experimental
* @todo api
*/
ol.extent.transform = function(extent, transformFn, opt_extent) {
diff --git a/src/ol/feature.js b/src/ol/feature.js
index b806bad424..10d5f87b9d 100644
--- a/src/ol/feature.js
+++ b/src/ol/feature.js
@@ -20,7 +20,6 @@ goog.require('ol.style.Style');
* @extends {ol.Object}
* @param {ol.geom.Geometry|Object.=} opt_geometryOrValues
* Values or geometry.
- * @todo stability experimental
* @todo api
*/
ol.Feature = function(opt_geometryOrValues) {
@@ -81,7 +80,6 @@ goog.inherits(ol.Feature, ol.Object);
/**
* @return {ol.geom.Geometry|undefined} Geometry.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getGeometry = function() {
@@ -96,7 +94,6 @@ goog.exportProperty(
/**
* @return {number|string|undefined} Id.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getId = function() {
@@ -106,7 +103,6 @@ ol.Feature.prototype.getId = function() {
/**
* @return {string} Geometry property name.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getGeometryName = function() {
@@ -117,7 +113,6 @@ ol.Feature.prototype.getGeometryName = function() {
/**
* @return {ol.style.Style|Array.|
* ol.feature.FeatureStyleFunction} User provided style.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getStyle = function() {
@@ -127,7 +122,6 @@ ol.Feature.prototype.getStyle = function() {
/**
* @return {ol.feature.FeatureStyleFunction|undefined} Style function.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.getStyleFunction = function() {
@@ -162,7 +156,6 @@ ol.Feature.prototype.handleGeometryChanged_ = function() {
/**
* @param {ol.geom.Geometry|undefined} geometry Geometry.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setGeometry = function(geometry) {
@@ -177,7 +170,6 @@ goog.exportProperty(
/**
* @param {ol.style.Style|Array.|
* ol.feature.FeatureStyleFunction} style Feature style.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setStyle = function(style) {
@@ -189,7 +181,6 @@ ol.Feature.prototype.setStyle = function(style) {
/**
* @param {number|string|undefined} id Id.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setId = function(id) {
@@ -199,7 +190,6 @@ ol.Feature.prototype.setId = function(id) {
/**
* @param {string} name Geometry property name.
- * @todo stability experimental
* @todo api
*/
ol.Feature.prototype.setGeometryName = function(name) {
@@ -221,7 +211,7 @@ ol.Feature.prototype.setGeometryName = function(name) {
* {@link ol.Feature} to be styled.
*
* @typedef {function(this: ol.Feature, number): Array.}
- * @todo stability experimental
+ * @todo api
*/
ol.feature.FeatureStyleFunction;
@@ -270,7 +260,7 @@ ol.feature.defaultFeatureStyleFunction = function(resolution) {
* {@link ol.style.Style}. This way e.g. a vector layer can be styled.
*
* @typedef {function(ol.Feature, number): Array.}
- * @todo stability experimental
+ * @todo api
*/
ol.feature.StyleFunction;
diff --git a/src/ol/featureoverlay.js b/src/ol/featureoverlay.js
index c4b78aeb7f..5c45f45c78 100644
--- a/src/ol/featureoverlay.js
+++ b/src/ol/featureoverlay.js
@@ -16,7 +16,6 @@ goog.require('ol.render.EventType');
/**
* @constructor
* @param {olx.FeatureOverlayOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay = function(opt_options) {
@@ -86,7 +85,6 @@ ol.FeatureOverlay = function(opt_options) {
/**
* @param {ol.Feature} feature Feature.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.addFeature = function(feature) {
@@ -96,7 +94,6 @@ ol.FeatureOverlay.prototype.addFeature = function(feature) {
/**
* @return {ol.Collection} Features collection.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.getFeatures = function() {
@@ -170,7 +167,6 @@ ol.FeatureOverlay.prototype.handleMapPostCompose_ = function(event) {
/**
* @param {ol.Feature} feature Feature.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.removeFeature = function(feature) {
@@ -190,7 +186,6 @@ ol.FeatureOverlay.prototype.render_ = function() {
/**
* @param {ol.Collection} features Features collection.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.setFeatures = function(features) {
@@ -225,7 +220,6 @@ ol.FeatureOverlay.prototype.setFeatures = function(features) {
/**
* @param {ol.Map} map Map.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.setMap = function(map) {
@@ -250,7 +244,6 @@ ol.FeatureOverlay.prototype.setMap = function(map) {
* an array of styles.
* @param {ol.style.Style|Array.|ol.feature.StyleFunction} style
* Overlay style.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.setStyle = function(style) {
@@ -265,7 +258,6 @@ ol.FeatureOverlay.prototype.setStyle = function(style) {
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.|ol.feature.StyleFunction}
* Overlay style.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.getStyle = function() {
@@ -276,7 +268,6 @@ ol.FeatureOverlay.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction|undefined} Style function.
- * @todo stability experimental
* @todo api
*/
ol.FeatureOverlay.prototype.getStyleFunction = function() {
diff --git a/src/ol/format/geojsonformat.js b/src/ol/format/geojsonformat.js
index 232a4964a7..66ca9075cb 100644
--- a/src/ol/format/geojsonformat.js
+++ b/src/ol/format/geojsonformat.js
@@ -26,7 +26,6 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSONFeature}
* @param {olx.format.GeoJSONOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.format.GeoJSON = function(opt_options) {
@@ -323,7 +322,6 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
- * @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readFeature;
@@ -336,7 +334,6 @@ ol.format.GeoJSON.prototype.readFeature;
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.} Features.
- * @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readFeatures;
@@ -391,7 +388,6 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry.
- * @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readGeometry;
@@ -411,7 +407,6 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) {
*
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
- * @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.readProjection = function(object) {
@@ -442,7 +437,6 @@ ol.format.GeoJSON.prototype.readProjection = function(object) {
* @function
* @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} Result.
- * @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeature;
@@ -479,7 +473,6 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* @function
* @param {Array.} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
- * @todo stability experimental
* @todo api
*/
ol.format.GeoJSON.prototype.writeFeatures;
diff --git a/src/ol/format/gpxformat.js b/src/ol/format/gpxformat.js
index dbb04e2304..478d6b9a60 100644
--- a/src/ol/format/gpxformat.js
+++ b/src/ol/format/gpxformat.js
@@ -19,7 +19,6 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XMLFeature}
- * @todo stability experimental
* @todo api
*/
ol.format.GPX = function() {
@@ -370,7 +369,6 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS(
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
- * @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.readFeature;
@@ -402,7 +400,6 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.} Features.
- * @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.readFeatures;
@@ -435,7 +432,6 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) {
*
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
- * @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.readProjection;
@@ -811,7 +807,6 @@ goog.inherits(ol.format.GPX.V1_1, ol.format.GPX);
* @function
* @param {Array.} features Features.
* @return {ArrayBuffer|Node|Object|string} Result.
- * @todo stability experimental
* @todo api
*/
ol.format.GPX.prototype.writeFeatures;
diff --git a/src/ol/format/igcformat.js b/src/ol/format/igcformat.js
index 903f7ab9f2..57d9aa4c62 100644
--- a/src/ol/format/igcformat.js
+++ b/src/ol/format/igcformat.js
@@ -25,7 +25,6 @@ ol.format.IGCZ = {
* @constructor
* @extends {ol.format.TextFeature}
* @param {olx.format.IGCOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.format.IGC = function(opt_options) {
@@ -92,7 +91,6 @@ ol.format.IGC.prototype.getExtensions = function() {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
- * @todo stability experimental
* @todo api
*/
ol.format.IGC.prototype.readFeature;
@@ -179,7 +177,6 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.} Features.
- * @todo stability experimental
* @todo api
*/
ol.format.IGC.prototype.readFeatures;
@@ -204,7 +201,6 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
- * @todo stability experimental
* @todo api
*/
ol.format.IGC.prototype.readProjection;
diff --git a/src/ol/format/kmlformat.js b/src/ol/format/kmlformat.js
index d9905e327c..af9351e789 100644
--- a/src/ol/format/kmlformat.js
+++ b/src/ol/format/kmlformat.js
@@ -54,7 +54,6 @@ ol.format.KMLGxTrackObject_;
* @constructor
* @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.format.KML = function(opt_options) {
@@ -1451,7 +1450,6 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature.
- * @todo stability experimental
* @todo api
*/
ol.format.KML.prototype.readFeature;
@@ -1481,7 +1479,6 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.} Features.
- * @todo stability experimental
* @todo api
*/
ol.format.KML.prototype.readFeatures;
@@ -1600,7 +1597,6 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection.
- * @todo stability experimental
* @todo api
*/
ol.format.KML.prototype.readProjection;
diff --git a/src/ol/format/osmxmlformat.js b/src/ol/format/osmxmlformat.js
index 2043140f90..987401104e 100644
--- a/src/ol/format/osmxmlformat.js
+++ b/src/ol/format/osmxmlformat.js
@@ -18,7 +18,6 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XMLFeature}
- * @todo stability experimental
* @todo api
*/
ol.format.OSMXML = function() {
diff --git a/src/ol/format/topojsonformat.js b/src/ol/format/topojsonformat.js
index 3b9cd391ba..ee3e347486 100644
--- a/src/ol/format/topojsonformat.js
+++ b/src/ol/format/topojsonformat.js
@@ -19,7 +19,6 @@ goog.require('ol.proj');
* @constructor
* @extends {ol.format.JSONFeature}
* @param {olx.format.TopoJSONOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.format.TopoJSON = function(opt_options) {
@@ -272,7 +271,6 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.} Features.
- * @todo stability experimental
* @todo api
*/
ol.format.TopoJSON.prototype.readFeatures;
@@ -383,7 +381,6 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
* @function
* @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection.
- * @todo stability experimental
* @todo api
*/
ol.format.TopoJSON.prototype.readProjection = function(object) {
diff --git a/src/ol/format/wfsformat.js b/src/ol/format/wfsformat.js
index b74c9bdc84..6969ae31f8 100644
--- a/src/ol/format/wfsformat.js
+++ b/src/ol/format/wfsformat.js
@@ -17,7 +17,6 @@ goog.require('ol.xml');
* @param {olx.format.WFSOptions=} opt_options
* Optional configuration object.
* @extends {ol.format.XMLFeature}
- * @todo stability experimental
* @todo api
*/
ol.format.WFS = function(opt_options) {
@@ -93,7 +92,6 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node) {
/**
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.TransactionResponse|undefined} Transaction response.
- * @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.readTransactionResponse = function(source) {
@@ -116,7 +114,6 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) {
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.FeatureCollectionMetadata|undefined}
* FeatureCollection metadata.
- * @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) {
@@ -554,7 +551,6 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) {
/**
* @param {olx.format.WFSWriteGetFeatureOptions} options Options.
* @return {Node} Result.
- * @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.writeGetFeature = function(options) {
@@ -607,7 +603,6 @@ ol.format.WFS.prototype.writeGetFeature = function(options) {
* @param {Array.} deletes The features to delete.
* @param {olx.format.WFSWriteTransactionOptions} options Write options.
* @return {Node} Result.
- * @todo stability experimental
* @todo api
*/
ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,
diff --git a/src/ol/format/wmscapabilitiesformat.js b/src/ol/format/wmscapabilitiesformat.js
index c94ff69780..2f0aaf44d6 100644
--- a/src/ol/format/wmscapabilitiesformat.js
+++ b/src/ol/format/wmscapabilitiesformat.js
@@ -15,7 +15,6 @@ goog.require('ol.xml');
/**
* @constructor
* @extends {ol.format.XML}
- * @todo stability experimental
* @todo api
*/
ol.format.WMSCapabilities = function() {
@@ -36,7 +35,6 @@ goog.inherits(ol.format.WMSCapabilities, ol.format.XML);
* @function
* @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities.
- * @todo stability experimental
* @todo api
*/
ol.format.WMSCapabilities.prototype.read;
diff --git a/src/ol/framestate.js b/src/ol/framestate.js
index 4e65c53f23..8eccdbb9c4 100644
--- a/src/ol/framestate.js
+++ b/src/ol/framestate.js
@@ -12,6 +12,11 @@ ol.PostRenderFunction;
/**
+ * Function to perform manipulations before rendering. This function is called
+ * with the {@link ol.Map} as first and an optional {@link oli.FrameState} as
+ * second argument. Return `true` to keep this function for the next frame,
+ * `false` to remove it.
* @typedef {function(ol.Map, ?oli.FrameState): boolean}
+ * @todo api
*/
ol.PreRenderFunction;
diff --git a/src/ol/geolocation.js b/src/ol/geolocation.js
index eb22276923..ecbf7e6669 100644
--- a/src/ol/geolocation.js
+++ b/src/ol/geolocation.js
@@ -71,7 +71,6 @@ ol.GeolocationProperty = {
* @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions
* as defined by the HTML5 Geolocation spec at
* http://www.w3.org/TR/geolocation-API/#position_options_interface
- * @todo stability experimental
* @todo api
*/
ol.Geolocation = function(opt_options) {
@@ -207,7 +206,7 @@ ol.Geolocation.prototype.positionError_ = function(error) {
/**
* Get the accuracy of the position in meters.
* @return {number|undefined} Position accuracy in meters.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getAccuracy = function() {
return /** @type {number|undefined} */ (
@@ -222,7 +221,7 @@ goog.exportProperty(
/**
* Get a geometry of the position accuracy.
* @return {?ol.geom.Geometry} Accuracy geometry.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getAccuracyGeometry = function() {
return /** @type {?ol.geom.Geometry} */ (
@@ -237,7 +236,7 @@ goog.exportProperty(
/**
* Get the altitude associated with the position.
* @return {number|undefined} The altitude in meters above the mean sea level.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getAltitude = function() {
return /** @type {number|undefined} */ (
@@ -252,7 +251,7 @@ goog.exportProperty(
/**
* Get the altitude accuracy of the position.
* @return {number|undefined} Altitude accuracy in meters.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getAltitudeAccuracy = function() {
return /** @type {number|undefined} */ (
@@ -267,7 +266,7 @@ goog.exportProperty(
/**
* Get the heading as radians clockwise from North.
* @return {number|undefined} Heading.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getHeading = function() {
return /** @type {number|undefined} */ (
@@ -282,7 +281,7 @@ goog.exportProperty(
/**
* Get the position of the device.
* @return {ol.Coordinate|undefined} position.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ (
@@ -297,7 +296,7 @@ goog.exportProperty(
/**
* Get the projection associated with the position.
* @return {ol.proj.Projection|undefined} projection.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -312,7 +311,7 @@ goog.exportProperty(
/**
* Get the speed in meters per second.
* @return {number|undefined} Speed.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getSpeed = function() {
return /** @type {number|undefined} */ (
@@ -327,7 +326,7 @@ goog.exportProperty(
/**
* Are we tracking the user's position?
* @return {boolean} tracking.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getTracking = function() {
return /** @type {boolean} */ (
@@ -344,7 +343,7 @@ goog.exportProperty(
* @see http://www.w3.org/TR/geolocation-API/#position-options
* @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation
* tracking options.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.getTrackingOptions = function() {
return /** @type {GeolocationPositionOptions|undefined} */ (
@@ -359,7 +358,7 @@ goog.exportProperty(
/**
* Set the projection to use for transforming the coordinates.
* @param {ol.proj.Projection} projection Projection.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.setProjection = function(projection) {
this.set(ol.GeolocationProperty.PROJECTION, projection);
@@ -373,7 +372,7 @@ goog.exportProperty(
/**
* Enable/disable tracking.
* @param {boolean} tracking Enable or disable tracking.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.setTracking = function(tracking) {
this.set(ol.GeolocationProperty.TRACKING, tracking);
@@ -389,7 +388,7 @@ goog.exportProperty(
* @see http://www.w3.org/TR/geolocation-API/#position-options
* @param {GeolocationPositionOptions} options HTML 5 Geolocation
* tracking options.
- * @todo stability experimental
+ * @todo api
*/
ol.Geolocation.prototype.setTrackingOptions = function(options) {
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);
diff --git a/src/ol/geom/circle.js b/src/ol/geom/circle.js
index 166607ac96..10efe0cefb 100644
--- a/src/ol/geom/circle.js
+++ b/src/ol/geom/circle.js
@@ -14,7 +14,6 @@ goog.require('ol.geom.flat.deflate');
* @param {ol.geom.RawPoint} center Center.
* @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.Circle = function(center, opt_radius, opt_layout) {
@@ -81,7 +80,6 @@ ol.geom.Circle.prototype.containsXY = function(x, y) {
/**
* @return {ol.geom.RawPoint} Center.
- * @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.getCenter = function() {
@@ -110,7 +108,6 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/**
* @return {number} Radius.
- * @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.getRadius = function() {
@@ -149,7 +146,6 @@ ol.geom.Circle.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} center Center.
- * @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setCenter = function(center) {
@@ -170,7 +166,6 @@ ol.geom.Circle.prototype.setCenter = function(center) {
* @param {ol.geom.RawPoint} center Center.
* @param {number} radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setCenterAndRadius =
@@ -210,7 +205,6 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/**
* @param {number} radius Radius.
- * @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setRadius = function(radius) {
diff --git a/src/ol/geom/geometry.js b/src/ol/geom/geometry.js
index 0a2ea4a0d1..613de8949d 100644
--- a/src/ol/geom/geometry.js
+++ b/src/ol/geom/geometry.js
@@ -7,8 +7,11 @@ goog.require('ol.Observable');
/**
+ * The geometry type. One of `'Point'`, `'LineString'`, `'LinearRing'`,
+ * `'Polygon'`, `'MultiPoint'`, `'MultiLineString'`, `'MultiPolygon'`,
+ * `'GeometryCollection'`, `'Circle'`.
* @enum {string}
- * @todo stability experimental
+ * @todo api
*/
ol.geom.GeometryType = {
POINT: 'Point',
@@ -24,8 +27,11 @@ ol.geom.GeometryType = {
/**
+ * The coordinate layout for geometries, indicating whether a 3rd or 4th z ('Z')
+ * or measure ('M') coordinate is available. Supported values are `'XY'`,
+ * `'XYZ'`, `'XYM'`, `'XYZM'`.
* @enum {string}
- * @todo stability experimental
+ * @todo api
*/
ol.geom.GeometryLayout = {
XY: 'XY',
@@ -39,7 +45,6 @@ ol.geom.GeometryLayout = {
/**
* @constructor
* @extends {ol.Observable}
- * @todo stability experimental
* @todo api
*/
ol.geom.Geometry = function() {
@@ -83,7 +88,6 @@ goog.inherits(ol.geom.Geometry, ol.Observable);
/**
* @function
* @return {ol.geom.Geometry} Clone.
- * @todo stability experimental
*/
ol.geom.Geometry.prototype.clone = goog.abstractMethod;
@@ -102,7 +106,6 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod;
* @param {ol.Coordinate} point Point.
* @param {ol.Coordinate=} opt_closestPoint Closest point.
* @return {ol.Coordinate} Closest point.
- * @todo stability experimental
* @todo api
*/
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
@@ -131,10 +134,11 @@ ol.geom.Geometry.prototype.containsXY = goog.functions.FALSE;
/**
+ * Get the extent of the geometry.
* @function
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent.
- * @todo stability experimental
+ * @todo api
*/
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -143,7 +147,6 @@ ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
* @function
* @param {number} squaredTolerance Squared tolerance.
* @return {ol.geom.Geometry} Simplified geometry.
- * @todo stability experimental
*/
ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
@@ -151,7 +154,6 @@ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
/**
* @function
* @return {ol.geom.GeometryType} Geometry type.
- * @todo stability experimental
*/
ol.geom.Geometry.prototype.getType = goog.abstractMethod;
@@ -159,7 +161,6 @@ ol.geom.Geometry.prototype.getType = goog.abstractMethod;
/**
* @function
* @param {ol.TransformFunction} transformFn Transform.
- * @todo stability experimental
*/
ol.geom.Geometry.prototype.transform = goog.abstractMethod;
diff --git a/src/ol/geom/geometrycollection.js b/src/ol/geom/geometrycollection.js
index 6fc368e713..f64ebf396a 100644
--- a/src/ol/geom/geometrycollection.js
+++ b/src/ol/geom/geometrycollection.js
@@ -15,7 +15,6 @@ goog.require('ol.geom.GeometryType');
* @constructor
* @extends {ol.geom.Geometry}
* @param {Array.=} opt_geometries Geometries.
- * @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection = function(opt_geometries) {
@@ -147,7 +146,6 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/**
* @return {Array.} Geometries.
- * @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection.prototype.getGeometries = function() {
@@ -227,7 +225,6 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/**
* @param {Array.} geometries Geometries.
- * @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {
diff --git a/src/ol/geom/linearring.js b/src/ol/geom/linearring.js
index aa512db31c..c2cd1b8dfa 100644
--- a/src/ol/geom/linearring.js
+++ b/src/ol/geom/linearring.js
@@ -16,7 +16,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -75,7 +74,6 @@ ol.geom.LinearRing.prototype.closestPointXY =
/**
* @return {number} Area.
- * @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.getArea = function() {
@@ -86,7 +84,6 @@ ol.geom.LinearRing.prototype.getArea = function() {
/**
* @return {ol.geom.RawLinearRing} Coordinates.
- * @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.getCoordinates = function() {
@@ -123,7 +120,6 @@ ol.geom.LinearRing.prototype.getType = function() {
/**
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.setCoordinates =
diff --git a/src/ol/geom/linestring.js b/src/ol/geom/linestring.js
index 36bf290b5c..0dcd57df7d 100644
--- a/src/ol/geom/linestring.js
+++ b/src/ol/geom/linestring.js
@@ -20,7 +20,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.LineString = function(coordinates, opt_layout) {
@@ -60,7 +59,6 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry);
/**
* @param {ol.Coordinate} coordinate Coordinate.
- * @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
@@ -117,7 +115,6 @@ ol.geom.LineString.prototype.closestPointXY =
* @param {number} m M.
* @param {boolean=} opt_extrapolate Extrapolate.
* @return {ol.Coordinate} Coordinate.
- * @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
@@ -133,7 +130,6 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
/**
* @return {ol.geom.RawLineString} Coordinates.
- * @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getCoordinates = function() {
@@ -144,7 +140,6 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/**
* @return {number} Length.
- * @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getLength = function() {
@@ -195,7 +190,6 @@ ol.geom.LineString.prototype.getType = function() {
/**
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.setCoordinates =
diff --git a/src/ol/geom/multilinestring.js b/src/ol/geom/multilinestring.js
index 83ed48d9a1..842d41d1a1 100644
--- a/src/ol/geom/multilinestring.js
+++ b/src/ol/geom/multilinestring.js
@@ -20,7 +20,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString = function(coordinates, opt_layout) {
@@ -54,7 +53,6 @@ goog.inherits(ol.geom.MultiLineString, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LineString} lineString LineString.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
@@ -122,7 +120,6 @@ ol.geom.MultiLineString.prototype.closestPointXY =
* @param {boolean=} opt_extrapolate Extrapolate.
* @param {boolean=} opt_interpolate Interpolate.
* @return {ol.Coordinate} Coordinate.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getCoordinateAtM =
@@ -141,7 +138,6 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM =
/**
* @return {ol.geom.RawMultiLineString} Coordinates.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getCoordinates = function() {
@@ -161,7 +157,6 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LineString} LineString.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getLineString = function(index) {
@@ -178,7 +173,6 @@ ol.geom.MultiLineString.prototype.getLineString = function(index) {
/**
* @return {Array.} LineStrings.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getLineStrings = function() {
@@ -250,7 +244,6 @@ ol.geom.MultiLineString.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.setCoordinates =
diff --git a/src/ol/geom/multipoint.js b/src/ol/geom/multipoint.js
index ef3ca30557..badab06dd9 100644
--- a/src/ol/geom/multipoint.js
+++ b/src/ol/geom/multipoint.js
@@ -18,7 +18,6 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint = function(coordinates, opt_layout) {
@@ -31,7 +30,6 @@ goog.inherits(ol.geom.MultiPoint, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Point} point Point.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.appendPoint = function(point) {
@@ -85,7 +83,6 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiPoint} Coordinates.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getCoordinates = function() {
@@ -97,7 +94,6 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/**
* @param {number} index Index.
* @return {ol.geom.Point} Point.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getPoint = function(index) {
@@ -116,7 +112,6 @@ ol.geom.MultiPoint.prototype.getPoint = function(index) {
/**
* @return {Array.} Points.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getPoints = function() {
@@ -147,7 +142,6 @@ ol.geom.MultiPoint.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.setCoordinates =
diff --git a/src/ol/geom/multipolygon.js b/src/ol/geom/multipolygon.js
index b207ada040..4379765c03 100644
--- a/src/ol/geom/multipolygon.js
+++ b/src/ol/geom/multipolygon.js
@@ -25,7 +25,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon = function(coordinates, opt_layout) {
@@ -83,7 +82,6 @@ goog.inherits(ol.geom.MultiPolygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Polygon} polygon Polygon.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
@@ -151,7 +149,6 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getArea = function() {
@@ -162,7 +159,6 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawMultiPolygon} Coordinates.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getCoordinates = function() {
@@ -197,7 +193,6 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() {
/**
* @return {ol.geom.MultiPoint} Interior points.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getInteriorPoints = function() {
@@ -250,7 +245,6 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/**
* @param {number} index Index.
* @return {ol.geom.Polygon} Polygon.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
@@ -282,7 +276,6 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
/**
* @return {Array.} Polygons.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygons = function() {
@@ -322,7 +315,6 @@ ol.geom.MultiPolygon.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.setCoordinates =
diff --git a/src/ol/geom/point.js b/src/ol/geom/point.js
index 56417176e5..90c2d40f84 100644
--- a/src/ol/geom/point.js
+++ b/src/ol/geom/point.js
@@ -14,7 +14,6 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.Point = function(coordinates, opt_layout) {
@@ -60,7 +59,6 @@ ol.geom.Point.prototype.closestPointXY =
/**
* @return {ol.geom.RawPoint} Coordinates.
- * @todo stability experimental
* @todo api
*/
ol.geom.Point.prototype.getCoordinates = function() {
@@ -94,7 +92,6 @@ ol.geom.Point.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {
diff --git a/src/ol/geom/polygon.js b/src/ol/geom/polygon.js
index b6486dd6a1..0d7bfd605e 100644
--- a/src/ol/geom/polygon.js
+++ b/src/ol/geom/polygon.js
@@ -24,7 +24,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -82,7 +81,6 @@ goog.inherits(ol.geom.Polygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LinearRing} linearRing Linear ring.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
@@ -140,7 +138,6 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getArea = function() {
@@ -151,7 +148,6 @@ ol.geom.Polygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawPolygon} Coordinates.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getCoordinates = function() {
@@ -185,7 +181,6 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() {
/**
* @return {ol.geom.Point} Interior point.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getInteriorPoint = function() {
@@ -196,7 +191,6 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LinearRing} Linear ring.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getLinearRing = function(index) {
@@ -213,7 +207,6 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) {
/**
* @return {Array.} Linear rings.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getLinearRings = function() {
@@ -285,7 +278,6 @@ ol.geom.Polygon.prototype.getType = function() {
/**
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
diff --git a/src/ol/geom/simplegeometry.js b/src/ol/geom/simplegeometry.js
index 40be07f912..24adb6b983 100644
--- a/src/ol/geom/simplegeometry.js
+++ b/src/ol/geom/simplegeometry.js
@@ -12,7 +12,6 @@ goog.require('ol.geom.flat.transform');
/**
* @constructor
* @extends {ol.geom.Geometry}
- * @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry = function() {
@@ -103,7 +102,6 @@ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
/**
* @return {ol.Coordinate} First coordinate.
- * @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() {
@@ -121,7 +119,6 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/**
* @return {ol.Coordinate} Last point.
- * @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
@@ -131,7 +128,6 @@ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
/**
* @return {ol.geom.GeometryLayout} Layout.
- * @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getLayout = function() {
diff --git a/src/ol/imagetile.js b/src/ol/imagetile.js
index 2038058ded..637c2eda22 100644
--- a/src/ol/imagetile.js
+++ b/src/ol/imagetile.js
@@ -67,7 +67,6 @@ goog.inherits(ol.ImageTile, ol.Tile);
/**
* @inheritDoc
- * @todo stability experimental
* @todo api
*/
ol.ImageTile.prototype.getImage = function(opt_context) {
diff --git a/src/ol/interaction/doubleclickzoominteraction.js b/src/ol/interaction/doubleclickzoominteraction.js
index 4cdd19522c..d109f64994 100644
--- 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) {
diff --git a/src/ol/interaction/draganddropinteraction.js b/src/ol/interaction/draganddropinteraction.js
index 6233e5a9dc..a1a31bc010 100644
--- 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.|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;
diff --git a/src/ol/interaction/dragboxinteraction.js b/src/ol/interaction/dragboxinteraction.js
index aa4e841bb0..3cefb74049 100644
--- 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() {
diff --git a/src/ol/interaction/dragpaninteraction.js b/src/ol/interaction/dragpaninteraction.js
index f370ea9613..666ed0e4cd 100644
--- 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) {
diff --git a/src/ol/interaction/dragrotateandzoominteraction.js b/src/ol/interaction/dragrotateandzoominteraction.js
index 0ef4123137..658b4d99a4 100644
--- 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) {
diff --git a/src/ol/interaction/dragrotateinteraction.js b/src/ol/interaction/dragrotateinteraction.js
index 047d7eb006..1f383c41f0 100644
--- 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) {
diff --git a/src/ol/interaction/dragzoominteraction.js b/src/ol/interaction/dragzoominteraction.js
index 1c14abb952..5723f1e6b0 100644
--- 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) {
diff --git a/src/ol/interaction/drawinteraction.js b/src/ol/interaction/drawinteraction.js
index 734a90f0cb..c58c005445 100644
--- 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) {
diff --git a/src/ol/interaction/interactiondefaults.js b/src/ol/interaction/interactiondefaults.js
index 4fbe399d77..d724dfc6ee 100644
--- 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) {
diff --git a/src/ol/interaction/keyboardpaninteraction.js b/src/ol/interaction/keyboardpaninteraction.js
index dc95b29ba0..1b9125c0fb 100644
--- 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) {
diff --git a/src/ol/interaction/keyboardzoominteraction.js b/src/ol/interaction/keyboardzoominteraction.js
index 7fac86d7ad..4087619fb8 100644
--- 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) {
diff --git a/src/ol/interaction/modifyinteraction.js b/src/ol/interaction/modifyinteraction.js
index 7c7e3b6815..2aff57d691 100644
--- 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) {
diff --git a/src/ol/interaction/mousewheelzoominteraction.js b/src/ol/interaction/mousewheelzoominteraction.js
index ebd2e0ee1c..cb7db3a2ab 100644
--- 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) {
diff --git a/src/ol/interaction/pinchrotateinteraction.js b/src/ol/interaction/pinchrotateinteraction.js
index e6838e49bd..76c2d5355e 100644
--- 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) {
diff --git a/src/ol/interaction/pinchzoominteraction.js b/src/ol/interaction/pinchzoominteraction.js
index 6d5a380b04..fc828b6ba6 100644
--- 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) {
diff --git a/src/ol/interaction/selectinteraction.js b/src/ol/interaction/selectinteraction.js
index 9d8f0afe82..8c4f669f45 100644
--- 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() {
diff --git a/src/ol/iview.js b/src/ol/iview.js
index 952f0f2332..94d50132eb 100644
--- a/src/ol/iview.js
+++ b/src/ol/iview.js
@@ -8,7 +8,6 @@ goog.require('ol.IView3D');
/**
* Interface for views. Currently {@link ol.View2D} is implemented.
* @interface
- * @todo stability experimental
*/
ol.IView = function() {
};
diff --git a/src/ol/iview2d.js b/src/ol/iview2d.js
index dcdf0c9f22..4e1a4e6d2d 100644
--- a/src/ol/iview2d.js
+++ b/src/ol/iview2d.js
@@ -14,7 +14,6 @@ ol.IView2D = function() {
/**
* @return {ol.Coordinate|undefined} Map center.
- * @todo stability experimental
*/
ol.IView2D.prototype.getCenter = function() {
};
@@ -22,7 +21,6 @@ ol.IView2D.prototype.getCenter = function() {
/**
* @return {ol.proj.Projection|undefined} Map projection.
- * @todo stability experimental
*/
ol.IView2D.prototype.getProjection = function() {
};
@@ -30,7 +28,6 @@ ol.IView2D.prototype.getProjection = function() {
/**
* @return {number|undefined} Map resolution.
- * @todo stability experimental
*/
ol.IView2D.prototype.getResolution = function() {
};
@@ -38,7 +35,6 @@ ol.IView2D.prototype.getResolution = function() {
/**
* @return {number|undefined} Map rotation.
- * @todo stability experimental
*/
ol.IView2D.prototype.getRotation = function() {
};
diff --git a/src/ol/kinetic.js b/src/ol/kinetic.js
index 840a809fb0..d8e704391a 100644
--- a/src/ol/kinetic.js
+++ b/src/ol/kinetic.js
@@ -13,7 +13,6 @@ goog.require('ol.animation');
* @param {number} delay Delay to consider to calculate the kinetic
* initial values (milliseconds).
* @struct
- * @todo stability experimental
* @todo api
*/
ol.Kinetic = function(decay, minVelocity, delay) {
diff --git a/src/ol/layer/heatmaplayer.js b/src/ol/layer/heatmaplayer.js
index 82d31f72b6..ff756312f6 100644
--- a/src/ol/layer/heatmaplayer.js
+++ b/src/ol/layer/heatmaplayer.js
@@ -25,7 +25,6 @@ ol.layer.HeatmapLayerProperty = {
* @extends {ol.layer.Vector}
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.HeatmapOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.layer.Heatmap = function(opt_options) {
diff --git a/src/ol/layer/imagelayer.js b/src/ol/layer/imagelayer.js
index 4f3b1730db..22414b83b5 100644
--- a/src/ol/layer/imagelayer.js
+++ b/src/ol/layer/imagelayer.js
@@ -9,7 +9,6 @@ goog.require('ol.layer.Layer');
* @extends {ol.layer.Layer}
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.LayerOptions} options Layer options.
- * @todo stability experimental
* @todo api
*/
ol.layer.Image = function(options) {
diff --git a/src/ol/layer/layer.js b/src/ol/layer/layer.js
index d37d226669..26bffd25cd 100644
--- a/src/ol/layer/layer.js
+++ b/src/ol/layer/layer.js
@@ -22,7 +22,6 @@ goog.require('ol.source.Source');
* @todo observable visible {boolean} the visiblity of the layer
* @todo observable maxResolution {number} the maximum resolution of the layer
* @todo observable minResolution {number} the minimum resolution of the layer
- * @todo stability experimental
* @todo api
*/
ol.layer.Layer = function(options) {
@@ -67,7 +66,6 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) {
/**
* @return {ol.source.Source} Source.
- * @todo stability experimental
* @todo api
*/
ol.layer.Layer.prototype.getSource = function() {
diff --git a/src/ol/layer/layerbase.js b/src/ol/layer/layerbase.js
index 4ccd4f9ad4..1ba6792803 100644
--- a/src/ol/layer/layerbase.js
+++ b/src/ol/layer/layerbase.js
@@ -79,7 +79,7 @@ goog.inherits(ol.layer.Base, ol.Object);
/**
* @return {number|undefined} Brightness.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getBrightness = function() {
return /** @type {number|undefined} */ (
@@ -93,7 +93,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Contrast.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getContrast = function() {
return /** @type {number|undefined} */ (
@@ -107,7 +107,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Hue.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getHue = function() {
return /** @type {number|undefined} */ (this.get(ol.layer.LayerProperty.HUE));
@@ -164,7 +164,7 @@ ol.layer.Base.prototype.getLayerStatesArray = goog.abstractMethod;
/**
* @return {number|undefined} MaxResolution.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getMaxResolution = function() {
return /** @type {number|undefined} */ (
@@ -178,7 +178,7 @@ goog.exportProperty(
/**
* @return {number|undefined} MinResolution.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getMinResolution = function() {
return /** @type {number|undefined} */ (
@@ -192,7 +192,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Opacity.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getOpacity = function() {
return /** @type {number|undefined} */ (
@@ -206,7 +206,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Saturation.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getSaturation = function() {
return /** @type {number|undefined} */ (
@@ -226,7 +226,7 @@ ol.layer.Base.prototype.getSourceState = goog.abstractMethod;
/**
* @return {boolean|undefined} Visible.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.getVisible = function() {
return /** @type {boolean|undefined} */ (
@@ -257,7 +257,7 @@ goog.exportProperty(
* [3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
*
* @param {number|undefined} brightness Brightness.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setBrightness = function(brightness) {
this.set(ol.layer.LayerProperty.BRIGHTNESS, brightness);
@@ -274,7 +274,7 @@ goog.exportProperty(
* linear multipliers on the effect (and values over 1 are permitted).
*
* @param {number|undefined} contrast Contrast.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setContrast = function(contrast) {
this.set(ol.layer.LayerProperty.CONTRAST, contrast);
@@ -289,7 +289,7 @@ goog.exportProperty(
* Apply a hue-rotation to the layer. A value of 0 will leave the hue
* unchanged. Other values are radians around the color circle.
* @param {number|undefined} hue Hue.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setHue = function(hue) {
this.set(ol.layer.LayerProperty.HUE, hue);
@@ -302,7 +302,7 @@ goog.exportProperty(
/**
* @param {number|undefined} maxResolution MaxResolution.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution);
@@ -315,7 +315,7 @@ goog.exportProperty(
/**
* @param {number|undefined} minResolution MinResolution.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setMinResolution = function(minResolution) {
this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution);
@@ -328,7 +328,7 @@ goog.exportProperty(
/**
* @param {number|undefined} opacity Opacity.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setOpacity = function(opacity) {
this.set(ol.layer.LayerProperty.OPACITY, opacity);
@@ -346,7 +346,7 @@ goog.exportProperty(
* permitted).
*
* @param {number|undefined} saturation Saturation.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setSaturation = function(saturation) {
this.set(ol.layer.LayerProperty.SATURATION, saturation);
@@ -359,7 +359,7 @@ goog.exportProperty(
/**
* @param {boolean|undefined} visible Visible.
- * @todo stability experimental
+ * @todo api
*/
ol.layer.Base.prototype.setVisible = function(visible) {
this.set(ol.layer.LayerProperty.VISIBLE, visible);
diff --git a/src/ol/layer/layergroup.js b/src/ol/layer/layergroup.js
index 2132896a17..bc793ae5ea 100644
--- a/src/ol/layer/layergroup.js
+++ b/src/ol/layer/layergroup.js
@@ -30,7 +30,6 @@ ol.layer.GroupProperty = {
* @param {olx.layer.GroupOptions=} opt_options Layer options.
* @todo observable layers {ol.Collection} collection of {@link ol.layer} layers
* that are part of this group
- * @todo stability experimental
* @todo api
*/
ol.layer.Group = function(opt_options) {
@@ -144,7 +143,6 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) {
/**
* @return {ol.Collection|undefined} Collection of layers.
- * @todo stability experimental
*/
ol.layer.Group.prototype.getLayers = function() {
return /** @type {ol.Collection|undefined} */ (this.get(
@@ -158,7 +156,6 @@ goog.exportProperty(
/**
* @param {ol.Collection|undefined} layers Collection of layers.
- * @todo stability experimental
*/
ol.layer.Group.prototype.setLayers = function(layers) {
this.set(ol.layer.GroupProperty.LAYERS, layers);
diff --git a/src/ol/layer/tilelayer.js b/src/ol/layer/tilelayer.js
index fa7b50d4c5..502f8aefaf 100644
--- a/src/ol/layer/tilelayer.js
+++ b/src/ol/layer/tilelayer.js
@@ -19,7 +19,6 @@ ol.layer.TileProperty = {
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.TileOptions} options Tile layer options.
* @todo observable preload {number} the level to preload tiles up to
- * @todo stability experimental
* @todo api
*/
ol.layer.Tile = function(options) {
diff --git a/src/ol/layer/vectorlayer.js b/src/ol/layer/vectorlayer.js
index 00f61b9cba..5252255461 100644
--- a/src/ol/layer/vectorlayer.js
+++ b/src/ol/layer/vectorlayer.js
@@ -21,7 +21,6 @@ ol.layer.VectorProperty = {
* @extends {ol.layer.Layer}
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.VectorOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.layer.Vector = function(opt_options) {
@@ -71,7 +70,6 @@ ol.layer.Vector.prototype.getRenderOrder = function() {
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.|ol.feature.StyleFunction}
* Layer style.
- * @todo stability experimental
* @todo api
*/
ol.layer.Vector.prototype.getStyle = function() {
@@ -82,7 +80,6 @@ ol.layer.Vector.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction|undefined} Layer style function.
- * @todo stability experimental
* @todo api
*/
ol.layer.Vector.prototype.getStyleFunction = function() {
@@ -105,7 +102,6 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {
* an array of styles.
* @param {ol.style.Style|Array.|ol.feature.StyleFunction} style
* Layer style.
- * @todo stability experimental
* @todo api
*/
ol.layer.Vector.prototype.setStyle = function(style) {
diff --git a/src/ol/loadingstrategy.js b/src/ol/loadingstrategy.js
index d1ab5cd03a..a6af39a671 100644
--- a/src/ol/loadingstrategy.js
+++ b/src/ol/loadingstrategy.js
@@ -7,7 +7,6 @@ goog.require('ol.TileCoord');
* @param {ol.Extent} extent Extent.
* @param {number} resolution Resolution.
* @return {Array.} Extents.
- * @todo stability experimental
* @todo api
*/
ol.loadingstrategy.all = function(extent, resolution) {
@@ -19,7 +18,6 @@ ol.loadingstrategy.all = function(extent, resolution) {
* @param {ol.Extent} extent Extent.
* @param {number} resolution Resolution.
* @return {Array.} Extents.
- * @todo stability experimental
* @todo api
*/
ol.loadingstrategy.bbox = function(extent, resolution) {
@@ -30,7 +28,6 @@ ol.loadingstrategy.bbox = function(extent, resolution) {
/**
* @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
* @return {function(ol.Extent, number): Array.} Loading strategy.
- * @todo stability experimental
* @todo api
*/
ol.loadingstrategy.createTile = function(tileGrid) {
diff --git a/src/ol/map.js b/src/ol/map.js
index 6430219168..05f180dc17 100644
--- a/src/ol/map.js
+++ b/src/ol/map.js
@@ -99,8 +99,9 @@ ol.OL3_LOGO_URL = 'data:image/png;base64,' +
/**
+ * Available renderers: `'canvas'`, `'dom'` or `'webgl'`.
* @enum {string}
- * @todo stability experimental
+ * @todo api
*/
ol.RendererHint = {
CANVAS: 'canvas',
@@ -164,7 +165,6 @@ ol.MapProperty = {
* @todo observable target {string|Element} the Element or id of the Element
* that the map is rendered in.
* @todo observable view {ol.IView} the view that controls this map
- * @todo stability experimental
* @todo api
*/
ol.Map = function(options) {
@@ -466,7 +466,6 @@ goog.inherits(ol.Map, ol.Object);
/**
* Add the given control to the map.
* @param {ol.control.Control} control Control.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.addControl = function(control) {
@@ -491,7 +490,6 @@ ol.Map.prototype.addInteraction = function(interaction) {
/**
* Adds the given layer to the top of this map.
* @param {ol.layer.Base} layer Layer.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.addLayer = function(layer) {
@@ -504,7 +502,6 @@ ol.Map.prototype.addLayer = function(layer) {
/**
* Add the given overlay to the map.
* @param {ol.Overlay} overlay Overlay.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.addOverlay = function(overlay) {
@@ -519,7 +516,6 @@ ol.Map.prototype.addOverlay = function(overlay) {
* animations before updating the map's view. The {@link ol.animation}
* namespace provides several static methods for creating prerender functions.
* @param {...ol.PreRenderFunction} var_args Any number of pre-render functions.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.beforeRender = function(var_args) {
@@ -581,7 +577,6 @@ ol.Map.prototype.forEachFeatureAtPixel =
* Returns the geographical coordinate for a browser event.
* @param {Event} event Event.
* @return {ol.Coordinate} Coordinate.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.getEventCoordinate = function(event) {
@@ -593,7 +588,6 @@ ol.Map.prototype.getEventCoordinate = function(event) {
* Returns the map pixel position for a browser event.
* @param {Event} event Event.
* @return {ol.Pixel} Pixel.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.getEventPixel = function(event) {
@@ -621,7 +615,7 @@ ol.Map.prototype.getEventPixel = function(event) {
* Note that this returns what is entered as an option or in setTarget:
* if that was an element, it returns an element; if a string, it returns that.
* @return {Element|string|undefined} Target.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.getTarget = function() {
return /** @type {Element|string|undefined} */ (
@@ -651,7 +645,6 @@ ol.Map.prototype.getCoordinateFromPixel = function(pixel) {
/**
* @return {ol.Collection} Controls.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.getControls = function() {
@@ -661,7 +654,6 @@ ol.Map.prototype.getControls = function() {
/**
* @return {ol.Collection} Overlays.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.getOverlays = function() {
@@ -677,7 +669,6 @@ ol.Map.prototype.getOverlays = function() {
*
* Interactions are used for e.g. pan, zoom and rotate.
* @return {ol.Collection} Interactions.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.getInteractions = function() {
@@ -688,7 +679,7 @@ ol.Map.prototype.getInteractions = function() {
/**
* Get the layergroup associated with this map.
* @return {ol.layer.Group} LayerGroup.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.getLayerGroup = function() {
return /** @type {ol.layer.Group} */ (
@@ -703,7 +694,6 @@ goog.exportProperty(
/**
* Get the collection of layers associated with this map.
* @return {ol.Collection|undefined} Layers.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.getLayers = function() {
@@ -735,7 +725,7 @@ ol.Map.prototype.getPixelFromCoordinate = function(coordinate) {
/**
* Get the size of this map.
* @return {ol.Size|undefined} Size.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.getSize = function() {
return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE));
@@ -750,7 +740,7 @@ goog.exportProperty(
* Get the view associated with this map. This can be a 2D or 3D view. A 2D
* view manages properties such as center and resolution.
* @return {ol.View|undefined} View.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.getView = function() {
return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW));
@@ -763,7 +753,6 @@ goog.exportProperty(
/**
* @return {Element} Viewport.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.getViewport = function() {
@@ -1097,7 +1086,6 @@ ol.Map.prototype.render = function() {
* @param {ol.control.Control} control Control.
* @return {ol.control.Control|undefined} The removed control of undefined
* if the control was not found.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.removeControl = function(control) {
@@ -1133,7 +1121,6 @@ ol.Map.prototype.removeInteraction = function(interaction) {
* @param {ol.layer.Base} layer Layer.
* @return {ol.layer.Base|undefined} The removed layer or undefined if the
* layer was not found.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.removeLayer = function(layer) {
@@ -1148,7 +1135,6 @@ ol.Map.prototype.removeLayer = function(layer) {
* @param {ol.Overlay} overlay Overlay.
* @return {ol.Overlay|undefined} The removed overlay of undefined
* if the overlay was not found.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.removeOverlay = function(overlay) {
@@ -1271,7 +1257,7 @@ ol.Map.prototype.renderFrame_ = function(time) {
/**
* Sets the layergroup of this map.
* @param {ol.layer.Group} layerGroup Layergroup.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.setLayerGroup = function(layerGroup) {
this.set(ol.MapProperty.LAYERGROUP, layerGroup);
@@ -1285,7 +1271,7 @@ goog.exportProperty(
/**
* Set the size of this map.
* @param {ol.Size|undefined} size Size.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.setSize = function(size) {
this.set(ol.MapProperty.SIZE, size);
@@ -1299,7 +1285,7 @@ goog.exportProperty(
/**
* Set the target element to render this map into.
* @param {Element|string|undefined} target Target.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.setTarget = function(target) {
this.set(ol.MapProperty.TARGET, target);
@@ -1311,9 +1297,9 @@ goog.exportProperty(
/**
- * Set the view for this map.
+ * Set the view for this map. Currently {@link ol.View2D} is implememnted.
* @param {ol.IView} view View.
- * @todo stability experimental
+ * @todo api
*/
ol.Map.prototype.setView = function(view) {
this.set(ol.MapProperty.VIEW, view);
@@ -1337,7 +1323,6 @@ ol.Map.prototype.skipFeature = function(feature) {
/**
* Force a recalculation of the map viewport size. This should be called when
* third-party code changes the size of the map viewport.
- * @todo stability experimental
* @todo api
*/
ol.Map.prototype.updateSize = function() {
diff --git a/src/ol/mapbrowserevent.js b/src/ol/mapbrowserevent.js
index 206dde9576..ed2fbb4322 100644
--- a/src/ol/mapbrowserevent.js
+++ b/src/ol/mapbrowserevent.js
@@ -40,19 +40,16 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
/**
* @const
* @type {Event}
- * @todo stability experimental
*/
this.originalEvent = browserEvent.getBrowserEvent();
/**
* @type {ol.Coordinate}
- * @todo stability experimental
*/
this.coordinate = map.getEventCoordinate(this.originalEvent);
/**
* @type {ol.Pixel}
- * @todo stability experimental
*/
this.pixel = map.getEventPixel(this.originalEvent);
@@ -64,7 +61,6 @@ goog.inherits(ol.MapBrowserEvent, ol.MapEvent);
* Prevents the default browser action.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault
* @override
- * @todo stability experimental
* @todo api
*/
ol.MapBrowserEvent.prototype.preventDefault = function() {
@@ -77,7 +73,6 @@ ol.MapBrowserEvent.prototype.preventDefault = function() {
* Prevents further propagation of the current event.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation
* @override
- * @todo stability experimental
* @todo api
*/
ol.MapBrowserEvent.prototype.stopPropagation = function() {
@@ -471,25 +466,25 @@ ol.MapBrowserEvent.EventType = {
* A true single click with no dragging and no double click. Note that this
* event is delayed by 250 ms to ensure that it is not a double click.
* @event ol.MapBrowserEvent#singleclick
- * @todo stability experimental
+ * @todo api
*/
SINGLECLICK: 'singleclick',
/**
* A click with no dragging. A double click will fire two of this.
* @event ol.MapBrowserEvent#click
- * @todo stability experimental
+ * @todo api
*/
CLICK: goog.events.EventType.CLICK,
/**
* A true double click, with no dragging.
* @event ol.MapBrowserEvent#dblclick
- * @todo stability experimental
+ * @todo api
*/
DBLCLICK: goog.events.EventType.DBLCLICK,
/**
* Triggered when a pointer is dragged.
* @event ol.MapBrowserEvent#pointerdrag
- * @todo stability experimental
+ * @todo api
*/
POINTERDRAG: 'pointerdrag',
@@ -497,7 +492,7 @@ ol.MapBrowserEvent.EventType = {
/**
* Triggered when a pointer is moved.
* @event ol.MapBrowserEvent#pointermove
- * @todo stability experimental
+ * @todo api
*/
POINTERMOVE: 'pointermove',
POINTERDOWN: 'pointerdown',
diff --git a/src/ol/mapevent.js b/src/ol/mapevent.js
index db97c66063..f6279cce22 100644
--- a/src/ol/mapevent.js
+++ b/src/ol/mapevent.js
@@ -11,13 +11,13 @@ ol.MapEventType = {
/**
* Triggered after a map frame is rendered.
* @event ol.MapEvent#postrender
- * @todo stability experimental
+ * @todo api
*/
POSTRENDER: 'postrender',
/**
* Triggered after the map is moved.
* @event ol.MapEvent#moveend
- * @todo stability experimental
+ * @todo api
*/
MOVEEND: 'moveend'
};
diff --git a/src/ol/object.js b/src/ol/object.js
index 10bc6981fa..ecab3f413e 100644
--- a/src/ol/object.js
+++ b/src/ol/object.js
@@ -23,13 +23,13 @@ ol.ObjectEventType = {
/**
* Triggered before a property is changed.
* @event ol.ObjectEvent#beforepropertychange
- * @todo stability experimental
+ * @todo api
*/
BEFOREPROPERTYCHANGE: 'beforepropertychange',
/**
* Triggered when a property is changed.
* @event ol.ObjectEvent#propertychange
- * @todo stability experimental
+ * @todo api
*/
PROPERTYCHANGE: 'propertychange'
};
@@ -63,7 +63,6 @@ goog.inherits(ol.ObjectEvent, goog.events.Event);
* @constructor
* @param {ol.Object} target
* @param {string} key
- * @todo stability experimental
*/
ol.ObjectAccessor = function(target, key) {
@@ -110,7 +109,6 @@ ol.ObjectAccessor.prototype.transform = function(from, to) {
* @extends {ol.Observable}
* @param {Object.=} opt_values Values.
* @fires {@link ol.ObjectEvent} ol.ObjectEvent
- * @todo stability experimental
* @todo api
*/
ol.Object = function(opt_values) {
@@ -244,7 +242,6 @@ ol.Object.getSetterName = function(key) {
* @param {ol.Object} target Target.
* @param {string=} opt_targetKey Target key.
* @return {ol.ObjectAccessor}
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.bindTo = function(key, target, opt_targetKey) {
@@ -302,7 +299,6 @@ ol.Object.prototype.createBeforeChangeListener_ = function(key, targetKey) {
* Gets a value.
* @param {string} key Key name.
* @return {*} Value.
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.get = function(key) {
@@ -363,7 +359,6 @@ ol.Object.prototype.getKeys = function() {
/**
* Get an object of all property names and values.
* @return {Object.} Object.
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.getProperties = function() {
@@ -384,7 +379,6 @@ ol.Object.prototype.getProperties = function() {
* objects that are bound to the object's property as well as the object
* that it is bound to.
* @param {string} key Key name.
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.notify = function(key) {
@@ -416,7 +410,6 @@ ol.Object.prototype.notifyInternal_ = function(key) {
* Sets a value.
* @param {string} key Key name.
* @param {*} value Value.
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.set = function(key, value) {
@@ -446,7 +439,6 @@ ol.Object.prototype.set = function(key, value) {
/**
* Sets a collection of key-value pairs.
* @param {Object.} values Values.
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.setValues = function(values) {
@@ -461,7 +453,6 @@ ol.Object.prototype.setValues = function(values) {
* Removes a binding. Unbinding will set the unbound property to the current
* value. The object will not be notified, as the value has not changed.
* @param {string} key Key name.
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.unbind = function(key) {
@@ -486,7 +477,6 @@ ol.Object.prototype.unbind = function(key) {
/**
* Removes all bindings.
- * @todo stability experimental
* @todo api
*/
ol.Object.prototype.unbindAll = function() {
diff --git a/src/ol/observable.js b/src/ol/observable.js
index 12c55d3166..379a372058 100644
--- a/src/ol/observable.js
+++ b/src/ol/observable.js
@@ -14,7 +14,6 @@ goog.require('goog.events.EventType');
* @extends {goog.events.EventTarget}
* @suppress {checkStructDictInheritance}
* @struct
- * @todo stability experimental
* @todo api
*/
ol.Observable = function() {
@@ -35,7 +34,6 @@ goog.inherits(ol.Observable, goog.events.EventTarget);
* Dispatches a `change` event. Register a listener for this event to get
* notified of changes.
* @fires change
- * @todo stability experimental
* @todo api
*/
ol.Observable.prototype.dispatchChangeEvent = function() {
@@ -58,7 +56,6 @@ ol.Observable.prototype.getRevision = function() {
* @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener.
- * @todo stability experimental
* @todo api
*/
ol.Observable.prototype.on = function(type, listener, opt_this) {
@@ -72,7 +69,6 @@ ol.Observable.prototype.on = function(type, listener, opt_this) {
* @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener.
- * @todo stability experimental
* @todo api
*/
ol.Observable.prototype.once = function(type, listener, opt_this) {
@@ -85,7 +81,6 @@ ol.Observable.prototype.once = function(type, listener, opt_this) {
* @param {string|Array.} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`.
- * @todo stability experimental
* @todo api
*/
ol.Observable.prototype.un = function(type, listener, opt_this) {
@@ -96,7 +91,6 @@ ol.Observable.prototype.un = function(type, listener, opt_this) {
/**
* Removes an event listener using the key returned by `on()` or `once()`.
* @param {goog.events.Key} key Key.
- * @todo stability experimental
* @todo api
*/
ol.Observable.prototype.unByKey = function(key) {
diff --git a/src/ol/ol.js b/src/ol/ol.js
index 98bc7d09b7..e22bd02a73 100644
--- a/src/ol/ol.js
+++ b/src/ol/ol.js
@@ -9,7 +9,6 @@ goog.provide('ol');
* linter complains with:
*
* "Missing newline between constructor and goog.inherits"
- * @todo stability experimental
* @todo api
*/
ol.inherits =
diff --git a/src/ol/overlay.js b/src/ol/overlay.js
index ed343e600d..f749fa1449 100644
--- a/src/ol/overlay.js
+++ b/src/ol/overlay.js
@@ -25,8 +25,11 @@ ol.OverlayProperty = {
/**
+ * Overlay position: `'bottom-left'`, `'bottom-center'`, `'bottom-right'`,
+ * `'center-left'`, `'center-center'`, `'center-right'`, `'top-left'`,
+ * `'top-center'`, `'top-right'`
* @enum {string}
- * @todo stability experimental
+ * @todo api
*/
ol.OverlayPositioning = {
BOTTOM_LEFT: 'bottom-left',
@@ -62,8 +65,7 @@ ol.OverlayPositioning = {
* is anchored at
* @todo observable positioning {ol.OverlayPositioning} how the overlay is
* positioned relative to its point on the map
- * @todo stability stable
- * @todo api
+ * @todo api stable
*/
ol.Overlay = function(options) {
@@ -158,7 +160,7 @@ goog.inherits(ol.Overlay, ol.Object);
/**
* Get the DOM element of this overlay.
* @return {Element|undefined} Element.
- * @todo stability experimental
+ * @todo api
*/
ol.Overlay.prototype.getElement = function() {
return /** @type {Element|undefined} */ (
@@ -173,7 +175,7 @@ goog.exportProperty(
/**
* Get the map associated with this overlay.
* @return {ol.Map|undefined} Map.
- * @todo stability experimental
+ * @todo api
*/
ol.Overlay.prototype.getMap = function() {
return /** @type {ol.Map|undefined} */ (
@@ -188,7 +190,7 @@ goog.exportProperty(
/**
* Get the current position of this overlay.
* @return {ol.Coordinate|undefined} Position.
- * @todo stability experimental
+ * @todo api
*/
ol.Overlay.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ (
@@ -203,7 +205,7 @@ goog.exportProperty(
/**
* Get the current positioning of this overlay.
* @return {ol.OverlayPositioning|undefined} Positioning.
- * @todo stability experimental
+ * @todo api
*/
ol.Overlay.prototype.getPositioning = function() {
return /** @type {ol.OverlayPositioning|undefined} */ (
@@ -280,7 +282,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() {
/**
* Set the DOM element to be associated with this overlay.
* @param {Element|undefined} element Element.
- * @todo stability experimental
+ * @todo api
*/
ol.Overlay.prototype.setElement = function(element) {
this.set(ol.OverlayProperty.ELEMENT, element);
@@ -294,7 +296,7 @@ goog.exportProperty(
/**
* Set the map to be associated with this overlay.
* @param {ol.Map|undefined} map Map.
- * @todo stability experimental
+ * @todo api
*/
ol.Overlay.prototype.setMap = function(map) {
this.set(ol.OverlayProperty.MAP, map);
@@ -308,7 +310,7 @@ goog.exportProperty(
/**
* Set the position for this overlay.
* @param {ol.Coordinate|undefined} position Position.
- * @todo stability stable
+ * @todo api stable
*/
ol.Overlay.prototype.setPosition = function(position) {
this.set(ol.OverlayProperty.POSITION, position);
@@ -322,7 +324,7 @@ goog.exportProperty(
/**
* Set the positioning for this overlay.
* @param {ol.OverlayPositioning|undefined} positioning Positioning.
- * @todo stability experimental
+ * @todo api
*/
ol.Overlay.prototype.setPositioning = function(positioning) {
this.set(ol.OverlayProperty.POSITIONING, positioning);
diff --git a/src/ol/proj/common.js b/src/ol/proj/common.js
index 9965295582..d249485cce 100644
--- a/src/ol/proj/common.js
+++ b/src/ol/proj/common.js
@@ -7,7 +7,6 @@ goog.require('ol.proj.EPSG4326');
/**
* FIXME empty description for jsdoc
- * @todo stability experimental
* @todo api
*/
ol.proj.common.add = function() {
diff --git a/src/ol/proj/proj.js b/src/ol/proj/proj.js
index 64e6e16b89..71601e09e3 100644
--- a/src/ol/proj/proj.js
+++ b/src/ol/proj/proj.js
@@ -30,14 +30,15 @@ ol.HAVE_PROJ4JS = ol.ENABLE_PROJ4JS && typeof Proj4js == 'object';
* A projection as {@link ol.proj.Projection}, SRS identifier string or
* undefined.
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
- * @todo stability experimental
+ * @todo api
*/
ol.proj.ProjectionLike;
/**
+ * Projection units: `'degrees'`, `'ft'`, `'m'` or `'pixels'`.
* @enum {string}
- * @todo stability experimental
+ * @todo api
*/
ol.proj.Units = {
DEGREES: 'degrees',
@@ -51,7 +52,6 @@ ol.proj.Units = {
* Meters per unit lookup table.
* @const
* @type {Object.}
- * @todo stability experimental
* @todo api
*/
ol.proj.METERS_PER_UNIT[ol.proj.Units.DEGREES] =
@@ -65,7 +65,6 @@ ol.proj.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
* @constructor
* @param {olx.ProjectionOptions} options Projection options.
* @struct
- * @todo stability experimental
* @todo api
*/
ol.proj.Projection = function(options) {
@@ -113,7 +112,6 @@ ol.proj.Projection = function(options) {
/**
* Get the code for this projection, e.g. 'EPSG:4326'.
* @return {string} Code.
- * @todo stability experimental
* @todo api
*/
ol.proj.Projection.prototype.getCode = function() {
@@ -124,7 +122,6 @@ ol.proj.Projection.prototype.getCode = function() {
/**
* Get the validity extent for this projection.
* @return {ol.Extent} Extent.
- * @todo stability experimental
* @todo api
*/
ol.proj.Projection.prototype.getExtent = function() {
@@ -148,7 +145,6 @@ ol.proj.Projection.prototype.getPointResolution = goog.abstractMethod;
/**
* Get the units of this projection.
* @return {ol.proj.Units} Units.
- * @todo stability experimental
* @todo api
*/
ol.proj.Projection.prototype.getUnits = function() {
@@ -380,7 +376,6 @@ ol.proj.addProj4jsProjection_ = function(proj4jsProjection) {
/**
* @param {ol.proj.Projection} projection Projection.
- * @todo stability experimental
* @todo api
*/
ol.proj.addProjection = function(projection) {
@@ -479,7 +474,6 @@ ol.proj.removeTransform = function(source, destination) {
* a combination of authority and identifier such as "EPSG:4326", or an
* existing projection object, or undefined.
* @return {ol.proj.Projection} Projection.
- * @todo stability experimental
* @todo api
*/
ol.proj.get = function(projectionLike) {
@@ -562,7 +556,6 @@ ol.proj.equivalent = function(projection1, projection2) {
* @param {ol.proj.ProjectionLike} source Source.
* @param {ol.proj.ProjectionLike} destination Destination.
* @return {ol.TransformFunction} Transform.
- * @todo stability experimental
* @todo api
*/
ol.proj.getTransform = function(source, destination) {
@@ -580,7 +573,6 @@ ol.proj.getTransform = function(source, destination) {
* @param {ol.proj.Projection} sourceProjection Source projection.
* @param {ol.proj.Projection} destinationProjection Destination projection.
* @return {ol.TransformFunction} Transform.
- * @todo stability experimental
* @todo api
*/
ol.proj.getTransformFromProjections =
@@ -701,7 +693,6 @@ ol.proj.cloneTransform = function(input, opt_output, opt_dimension) {
* @param {ol.proj.ProjectionLike} source Source.
* @param {ol.proj.ProjectionLike} destination Destination.
* @return {ol.Coordinate} Point.
- * @todo stability experimental
* @todo api
*/
ol.proj.transform = function(point, source, destination) {
@@ -717,7 +708,6 @@ ol.proj.transform = function(point, source, destination) {
* @param {ol.proj.Projection} sourceProjection Source projection.
* @param {ol.proj.Projection} destinationProjection Destination projection.
* @return {ol.Coordinate} Point.
- * @todo stability experimental
* @todo api
*/
ol.proj.transformWithProjections =
@@ -731,7 +721,6 @@ ol.proj.transformWithProjections =
/**
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @return {ol.proj.Projection} Proj4js projection.
- * @todo stability experimental
* @todo api
*/
ol.proj.configureProj4jsProjection = function(options) {
diff --git a/src/ol/render/canvas/canvasimmediate.js b/src/ol/render/canvas/canvasimmediate.js
index 98c6d1e782..1968b406d7 100644
--- a/src/ol/render/canvas/canvasimmediate.js
+++ b/src/ol/render/canvas/canvasimmediate.js
@@ -380,7 +380,6 @@ ol.render.canvas.Immediate.prototype.drawRings_ =
*
* @param {number} zIndex Z index.
* @param {function(ol.render.canvas.Immediate)} callback Callback.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) {
@@ -400,7 +399,6 @@ ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) {
*
* @param {ol.geom.Circle} circleGeometry Circle geometry.
* @param {Object} data Opaque data object,
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawCircleGeometry =
@@ -446,7 +444,6 @@ ol.render.canvas.Immediate.prototype.drawCircleGeometry =
*
* @param {ol.Feature} feature Feature.
* @param {ol.style.Style} style Style.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) {
@@ -499,7 +496,6 @@ ol.render.canvas.Immediate.prototype.drawGeometryCollectionGeometry =
*
* @param {ol.geom.Point} pointGeometry Point geometry.
* @param {Object} data Opaque data object.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawPointGeometry =
@@ -521,7 +517,6 @@ ol.render.canvas.Immediate.prototype.drawPointGeometry =
*
* @param {ol.geom.MultiPoint} multiPointGeometry MultiPoint geometry.
* @param {Object} data Opaque data object.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawMultiPointGeometry =
@@ -543,7 +538,6 @@ ol.render.canvas.Immediate.prototype.drawMultiPointGeometry =
*
* @param {ol.geom.LineString} lineStringGeometry Line string geometry.
* @param {Object} data Opaque data object.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawLineStringGeometry =
@@ -574,7 +568,6 @@ ol.render.canvas.Immediate.prototype.drawLineStringGeometry =
* @param {ol.geom.MultiLineString} multiLineStringGeometry
* MultiLineString geometry.
* @param {Object} data Opaque data object.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry =
@@ -611,7 +604,6 @@ ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry =
*
* @param {ol.geom.Polygon} polygonGeometry Polygon geometry.
* @param {Object} data Opaque data object.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawPolygonGeometry =
@@ -651,7 +643,6 @@ ol.render.canvas.Immediate.prototype.drawPolygonGeometry =
* uses the current style.
* @param {ol.geom.MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
* @param {Object} data Opaque data object.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawMultiPolygonGeometry =
@@ -827,7 +818,6 @@ ol.render.canvas.Immediate.prototype.setContextTextState_ =
*
* @param {ol.style.Fill} fillStyle Fill style.
* @param {ol.style.Stroke} strokeStyle Stroke style.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.setFillStrokeStyle =
@@ -873,7 +863,6 @@ ol.render.canvas.Immediate.prototype.setFillStrokeStyle =
* the image style.
*
* @param {ol.style.Image} imageStyle Image style.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
@@ -913,7 +902,6 @@ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
* remove the text style.
*
* @param {ol.style.Text} textStyle Text style.
- * @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) {
diff --git a/src/ol/render/ivectorcontext.js b/src/ol/render/ivectorcontext.js
index 0bae74cdd0..22ba124831 100644
--- a/src/ol/render/ivectorcontext.js
+++ b/src/ol/render/ivectorcontext.js
@@ -8,7 +8,6 @@ goog.provide('ol.render.IVectorContext');
* VectorContext interface. Currently implemented by
* {@link ol.render.canvas.Immediate}
* @interface
- * @todo stability experimental
*/
ol.render.IVectorContext = function() {
};
diff --git a/src/ol/render/renderevent.js b/src/ol/render/renderevent.js
index 017b20c276..7fdc3e513a 100644
--- a/src/ol/render/renderevent.js
+++ b/src/ol/render/renderevent.js
@@ -11,17 +11,17 @@ goog.require('ol.render.IVectorContext');
ol.render.EventType = {
/**
* @event ol.render.Event#postcompose
- * @todo stability experimental
+ * @todo api
*/
POSTCOMPOSE: 'postcompose',
/**
* @event ol.render.Event#precompose
- * @todo stability experimental
+ * @todo api
*/
PRECOMPOSE: 'precompose',
/**
* @event ol.render.Event#render
- * @todo stability experimental
+ * @todo api
*/
RENDER: 'render'
};
@@ -47,13 +47,11 @@ ol.render.Event = function(
/**
* @type {ol.render.IVectorContext|undefined}
- * @todo stability experimental
*/
this.vectorContext = opt_vectorContext;
/**
* @type {oli.FrameState|undefined}
- * @todo stability experimental
*/
this.frameState = opt_frameState;
@@ -61,7 +59,6 @@ ol.render.Event = function(
* Canvas context. Only available when a Canvas renderer is used,
* null otherwise.
* @type {CanvasRenderingContext2D|null|undefined}
- * @todo stability experimental
*/
this.context = opt_context;
@@ -69,7 +66,6 @@ ol.render.Event = function(
* WebGL context. Only available when a WebGL renderer is used, null
* otherwise.
* @type {ol.webgl.Context|null|undefined}
- * @todo stability experimental
*/
this.glContext = opt_glContext;
diff --git a/src/ol/size.js b/src/ol/size.js
index f4305b8046..2f0e572da8 100644
--- a/src/ol/size.js
+++ b/src/ol/size.js
@@ -4,8 +4,8 @@ goog.provide('ol.size');
/**
* An array of numbers representing a size: `[width, height]`.
- * @typedef {Array.} ol.Size
- * @todo stability experimental
+ * @typedef {Array.}
+ * @todo api
*/
ol.Size;
diff --git a/src/ol/source/bingmapssource.js b/src/ol/source/bingmapssource.js
index 72860362a1..0562241565 100644
--- 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({
diff --git a/src/ol/source/debugtilesource.js b/src/ol/source/debugtilesource.js
index 2e177dbeb9..6468f2ea7c 100644
--- 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) {
diff --git a/src/ol/source/geojsonsource.js b/src/ol/source/geojsonsource.js
index 2c4604b9de..49cbde0918 100644
--- 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) {
diff --git a/src/ol/source/gpxsource.js b/src/ol/source/gpxsource.js
index 6dd1139f39..4e6f8b1a69 100644
--- 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) {
diff --git a/src/ol/source/igcsource.js b/src/ol/source/igcsource.js
index 76a29eadec..a909088327 100644
--- 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) {
diff --git a/src/ol/source/imagecanvassource.js b/src/ol/source/imagecanvassource.js
index a62949d3d7..1104323d76 100644
--- 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) {
diff --git a/src/ol/source/imagestaticsource.js b/src/ol/source/imagestaticsource.js
index bebdb03d9b..2023f54683 100644
--- 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) {
diff --git a/src/ol/source/imagevectorsource.js b/src/ol/source/imagevectorsource.js
index bca77e0693..a0e8f13fb4 100644
--- 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) {
diff --git a/src/ol/source/imagewmssource.js b/src/ol/source/imagewmssource.js
index d172c8242e..cdbc7d995a 100644
--- 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) {
diff --git a/src/ol/source/kmlsource.js b/src/ol/source/kmlsource.js
index 40b6bb0ba4..949e25f2d6 100644
--- 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) {
diff --git a/src/ol/source/mapguidesource.js b/src/ol/source/mapguidesource.js
index d90d224dff..b843fbe1e9 100644
--- 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) {
diff --git a/src/ol/source/mapquestsource.js b/src/ol/source/mapquestsource.js
index 3e1fa03656..8d9287dc11 100644
--- 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) {
diff --git a/src/ol/source/osmsource.js b/src/ol/source/osmsource.js
index 8215cc9b55..ba07e01629 100644
--- 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({
diff --git a/src/ol/source/osmxmlsource.js b/src/ol/source/osmxmlsource.js
index a096865f7d..b6d80c20fc 100644
--- 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) {
diff --git a/src/ol/source/servervectorsource.js b/src/ol/source/servervectorsource.js
index 43c51ead99..3b6a361c92 100644
--- 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.} Features.
- * @todo stability experimental
* @todo api
*/
ol.source.ServerVector.prototype.readFeatures;
diff --git a/src/ol/source/source.js b/src/ol/source/source.js
index 929ec8e2c8..6a65fcd105 100644
--- 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() {
diff --git a/src/ol/source/stamensource.js b/src/ol/source/stamensource.js
index 55904b04b3..0d4c5c36a0 100644
--- 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) {
diff --git a/src/ol/source/staticvectorsource.js b/src/ol/source/staticvectorsource.js
index 05bb37d1ac..9133cd25b8 100644
--- 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) {
diff --git a/src/ol/source/tileimagesource.js b/src/ol/source/tileimagesource.js
index 237d99cb82..94107ddd0b 100644
--- 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) {
diff --git a/src/ol/source/tilejsonsource.js b/src/ol/source/tilejsonsource.js
index deb26bc886..0cfd14c546 100644
--- 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) {
diff --git a/src/ol/source/tilesource.js b/src/ol/source/tilesource.js
index a50df4a947..fdcbcef744 100644
--- 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() {
diff --git a/src/ol/source/tilevectorsource.js b/src/ol/source/tilevectorsource.js
index ef8183dee8..5e9d5c33c2 100644
--- 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) {
diff --git a/src/ol/source/tilewmssource.js b/src/ol/source/tilewmssource.js
index 8f819fc313..3bdf0dd4cf 100644
--- 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.|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) {
diff --git a/src/ol/source/topojsonsource.js b/src/ol/source/topojsonsource.js
index ac3c0dbb5f..5e68221b4d 100644
--- 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) {
diff --git a/src/ol/source/vectorsource.js b/src/ol/source/vectorsource.js
index 406a88298a..f7a5d6239e 100644
--- 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.} 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.} 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.} 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;
diff --git a/src/ol/source/wmtssource.js b/src/ol/source/wmtssource.js
index c385706d8e..37684a67a0 100644
--- 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) {
diff --git a/src/ol/source/xyzsource.js b/src/ol/source/xyzsource.js
index 9c6c3a6d0f..6e365e0662 100644
--- 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) {
diff --git a/src/ol/source/zoomifysource.js b/src/ol/source/zoomifysource.js
index d0a6628f7c..ae87d64aae 100644
--- 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) {
diff --git a/src/ol/style/circlestyle.js b/src/ol/style/circlestyle.js
index 770fc172d4..34e4e4c71a 100644
--- a/src/ol/style/circlestyle.js
+++ b/src/ol/style/circlestyle.js
@@ -17,7 +17,6 @@ goog.require('ol.style.Stroke');
* @constructor
* @param {olx.style.CircleOptions=} opt_options Options.
* @extends {ol.style.Image}
- * @todo stability experimental
* @todo api
*/
ol.style.Circle = function(opt_options) {
@@ -92,7 +91,6 @@ ol.style.Circle.prototype.getAnchor = function() {
/**
* @return {ol.style.Fill} Fill style.
- * @todo stability experimental
* @todo api
*/
ol.style.Circle.prototype.getFill = function() {
@@ -127,7 +125,6 @@ ol.style.Circle.prototype.getImageState = function() {
/**
* @return {number} Radius.
- * @todo stability experimental
* @todo api
*/
ol.style.Circle.prototype.getRadius = function() {
@@ -146,7 +143,6 @@ ol.style.Circle.prototype.getSize = function() {
/**
* @return {ol.style.Stroke} Stroke style.
- * @todo stability experimental
* @todo api
*/
ol.style.Circle.prototype.getStroke = function() {
diff --git a/src/ol/style/fillstyle.js b/src/ol/style/fillstyle.js
index 2c1f774a5c..f480d17893 100644
--- a/src/ol/style/fillstyle.js
+++ b/src/ol/style/fillstyle.js
@@ -7,7 +7,6 @@ goog.require('ol.color');
/**
* @constructor
* @param {olx.style.FillOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.style.Fill = function(opt_options) {
@@ -24,7 +23,6 @@ ol.style.Fill = function(opt_options) {
/**
* @return {ol.Color|string} Color.
- * @todo stability experimental
* @todo api
*/
ol.style.Fill.prototype.getColor = function() {
diff --git a/src/ol/style/iconstyle.js b/src/ol/style/iconstyle.js
index 6038670071..d5b29b76c1 100644
--- a/src/ol/style/iconstyle.js
+++ b/src/ol/style/iconstyle.js
@@ -40,7 +40,6 @@ ol.style.IconAnchorUnits = {
* @constructor
* @param {olx.style.IconOptions=} opt_options Options.
* @extends {ol.style.Image}
- * @todo stability experimental
* @todo api
*/
ol.style.Icon = function(opt_options) {
@@ -193,7 +192,6 @@ ol.style.Icon.prototype.getHitDetectionImage = function(pixelRatio) {
/**
* @return {string|undefined} Image src.
- * @todo stability experimental
* @todo api
*/
ol.style.Icon.prototype.getSrc = function() {
diff --git a/src/ol/style/imagestyle.js b/src/ol/style/imagestyle.js
index 853ab881b5..3928d92a5c 100644
--- a/src/ol/style/imagestyle.js
+++ b/src/ol/style/imagestyle.js
@@ -29,7 +29,6 @@ ol.style.ImageOptions;
/**
* @constructor
* @param {ol.style.ImageOptions} options Options.
- * @todo stability experimental
* @todo api
*/
ol.style.Image = function(options) {
@@ -85,7 +84,6 @@ ol.style.Image.prototype.getRotateWithView = function() {
/**
* @return {number} Rotation.
- * @todo stability experimental
* @todo api
*/
ol.style.Image.prototype.getRotation = function() {
@@ -95,7 +93,6 @@ ol.style.Image.prototype.getRotation = function() {
/**
* @return {number} Scale.
- * @todo stability experimental
* @todo api
*/
ol.style.Image.prototype.getScale = function() {
@@ -114,7 +111,6 @@ ol.style.Image.prototype.getSnapToPixel = function() {
/**
* @function
* @return {Array.} Anchor.
- * @todo stability experimental
*/
ol.style.Image.prototype.getAnchor = goog.abstractMethod;
@@ -123,7 +119,6 @@ ol.style.Image.prototype.getAnchor = goog.abstractMethod;
* @function
* @param {number} pixelRatio Pixel ratio.
* @return {HTMLCanvasElement|HTMLVideoElement|Image} Image element.
- * @todo stability experimental
*/
ol.style.Image.prototype.getImage = goog.abstractMethod;
@@ -144,7 +139,6 @@ ol.style.Image.prototype.getHitDetectionImage = goog.abstractMethod;
/**
* @function
* @return {ol.Size} Size.
- * @todo stability experimental
*/
ol.style.Image.prototype.getSize = goog.abstractMethod;
diff --git a/src/ol/style/strokestyle.js b/src/ol/style/strokestyle.js
index 9d9d7deb21..861a155c93 100644
--- a/src/ol/style/strokestyle.js
+++ b/src/ol/style/strokestyle.js
@@ -7,7 +7,6 @@ goog.require('ol.color');
/**
* @constructor
* @param {olx.style.StrokeOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.style.Stroke = function(opt_options) {
@@ -54,7 +53,6 @@ ol.style.Stroke = function(opt_options) {
/**
* @return {ol.Color|string} Color.
- * @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getColor = function() {
@@ -64,7 +62,6 @@ ol.style.Stroke.prototype.getColor = function() {
/**
* @return {string|undefined} Line cap.
- * @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getLineCap = function() {
@@ -74,7 +71,6 @@ ol.style.Stroke.prototype.getLineCap = function() {
/**
* @return {Array.} Line dash.
- * @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getLineDash = function() {
@@ -84,7 +80,6 @@ ol.style.Stroke.prototype.getLineDash = function() {
/**
* @return {string|undefined} Line join.
- * @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getLineJoin = function() {
@@ -94,7 +89,6 @@ ol.style.Stroke.prototype.getLineJoin = function() {
/**
* @return {number|undefined} Miter limit.
- * @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getMiterLimit = function() {
@@ -104,7 +98,6 @@ ol.style.Stroke.prototype.getMiterLimit = function() {
/**
* @return {number|undefined} Width.
- * @todo stability experimental
* @todo api
*/
ol.style.Stroke.prototype.getWidth = function() {
diff --git a/src/ol/style/style.js b/src/ol/style/style.js
index b77abd8866..c6bc585fcc 100644
--- a/src/ol/style/style.js
+++ b/src/ol/style/style.js
@@ -8,7 +8,6 @@ goog.require('ol.style.Image');
/**
* @constructor
* @param {olx.style.StyleOptions=} opt_options Style options.
- * @todo stability experimental
* @todo api
*/
ol.style.Style = function(opt_options) {
@@ -50,7 +49,6 @@ ol.style.Style = function(opt_options) {
/**
* @return {ol.style.Fill} Fill style.
- * @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getFill = function() {
@@ -60,7 +58,6 @@ ol.style.Style.prototype.getFill = function() {
/**
* @return {ol.style.Image} Image style.
- * @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getImage = function() {
@@ -70,7 +67,6 @@ ol.style.Style.prototype.getImage = function() {
/**
* @return {ol.style.Stroke} Stroke style.
- * @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getStroke = function() {
@@ -80,7 +76,6 @@ ol.style.Style.prototype.getStroke = function() {
/**
* @return {ol.style.Text} Text style.
- * @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getText = function() {
@@ -90,7 +85,6 @@ ol.style.Style.prototype.getText = function() {
/**
* @return {number|undefined} ZIndex.
- * @todo stability experimental
* @todo api
*/
ol.style.Style.prototype.getZIndex = function() {
diff --git a/src/ol/style/textstyle.js b/src/ol/style/textstyle.js
index ae4b3ca28e..2ff02394b3 100644
--- a/src/ol/style/textstyle.js
+++ b/src/ol/style/textstyle.js
@@ -5,7 +5,6 @@ goog.provide('ol.style.Text');
/**
* @constructor
* @param {olx.style.TextOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.style.Text = function(opt_options) {
@@ -76,7 +75,6 @@ ol.style.Text = function(opt_options) {
/**
* @return {string|undefined} Font.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getFont = function() {
@@ -102,7 +100,6 @@ ol.style.Text.prototype.getOffsetY = function() {
/**
* @return {ol.style.Fill} Fill style.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getFill = function() {
@@ -112,7 +109,6 @@ ol.style.Text.prototype.getFill = function() {
/**
* @return {number|undefined} Rotation.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getRotation = function() {
@@ -122,7 +118,6 @@ ol.style.Text.prototype.getRotation = function() {
/**
* @return {number|undefined} Scale.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getScale = function() {
@@ -132,7 +127,6 @@ ol.style.Text.prototype.getScale = function() {
/**
* @return {ol.style.Stroke} Stroke style.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getStroke = function() {
@@ -142,7 +136,6 @@ ol.style.Text.prototype.getStroke = function() {
/**
* @return {string|undefined} Text.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getText = function() {
@@ -152,7 +145,6 @@ ol.style.Text.prototype.getText = function() {
/**
* @return {string|undefined} Text align.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getTextAlign = function() {
@@ -162,7 +154,6 @@ ol.style.Text.prototype.getTextAlign = function() {
/**
* @return {string|undefined} Text baseline.
- * @todo stability experimental
* @todo api
*/
ol.style.Text.prototype.getTextBaseline = function() {
diff --git a/src/ol/tile.js b/src/ol/tile.js
index 59654a0a14..4d13e0658b 100644
--- a/src/ol/tile.js
+++ b/src/ol/tile.js
@@ -72,7 +72,6 @@ ol.Tile.prototype.getKey = function() {
/**
* @return {ol.TileCoord}
- * @todo stability experimental
* @todo api
*/
ol.Tile.prototype.getTileCoord = function() {
diff --git a/src/ol/tilecoord.js b/src/ol/tilecoord.js
index e8d374d5e5..8d90fd393f 100644
--- a/src/ol/tilecoord.js
+++ b/src/ol/tilecoord.js
@@ -118,7 +118,6 @@ ol.TileCoord.getKeyZXY = function(z, x, y) {
/**
* @param {Array.=} opt_result Optional array to reuse.
* @return {Array.} Array of z, x, y.
- * @todo stability experimental
* @todo api
*/
ol.TileCoord.prototype.getZXY = function(opt_result) {
diff --git a/src/ol/tilegrid/tilegrid.js b/src/ol/tilegrid/tilegrid.js
index 81483b38a1..beaf508869 100644
--- a/src/ol/tilegrid/tilegrid.js
+++ b/src/ol/tilegrid/tilegrid.js
@@ -29,7 +29,6 @@ ol.DEFAULT_MAX_ZOOM = 42;
* @constructor
* @param {olx.tilegrid.TileGridOptions} options Tile grid options.
* @struct
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.TileGrid = function(options) {
@@ -148,7 +147,6 @@ ol.tilegrid.TileGrid.prototype.getMaxZoom = function() {
/**
* @return {number} Min zoom.
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.TileGrid.prototype.getMinZoom = function() {
@@ -159,7 +157,6 @@ ol.tilegrid.TileGrid.prototype.getMinZoom = function() {
/**
* @param {number} z Z.
* @return {ol.Coordinate} Origin.
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.TileGrid.prototype.getOrigin = function(z) {
@@ -176,7 +173,6 @@ ol.tilegrid.TileGrid.prototype.getOrigin = function(z) {
/**
* @param {number} z Z.
* @return {number} Resolution.
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.TileGrid.prototype.getResolution = function(z) {
@@ -375,7 +371,6 @@ ol.tilegrid.TileGrid.prototype.getTileCoordResolution = function(tileCoord) {
/**
* @param {number} z Z.
* @return {number} Tile size.
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.TileGrid.prototype.getTileSize = function(z) {
diff --git a/src/ol/tilegrid/wmtstilegrid.js b/src/ol/tilegrid/wmtstilegrid.js
index ae1f1bc01e..903ba96483 100644
--- a/src/ol/tilegrid/wmtstilegrid.js
+++ b/src/ol/tilegrid/wmtstilegrid.js
@@ -12,7 +12,6 @@ goog.require('ol.tilegrid.TileGrid');
* @extends {ol.tilegrid.TileGrid}
* @param {olx.tilegrid.WMTSOptions} options WMTS options.
* @struct
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.WMTS = function(options) {
@@ -51,7 +50,6 @@ ol.tilegrid.WMTS.prototype.getMatrixId = function(z) {
/**
* @return {Array.} MatrixIds.
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.WMTS.prototype.getMatrixIds = function() {
diff --git a/src/ol/tilegrid/xyztilegrid.js b/src/ol/tilegrid/xyztilegrid.js
index 009ad751a6..75a63200b5 100644
--- a/src/ol/tilegrid/xyztilegrid.js
+++ b/src/ol/tilegrid/xyztilegrid.js
@@ -14,7 +14,6 @@ goog.require('ol.tilegrid.TileGrid');
* @extends {ol.tilegrid.TileGrid}
* @param {olx.tilegrid.XYZOptions} options XYZ options.
* @struct
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.XYZ = function(options) {
diff --git a/src/ol/tilegrid/zoomifytilegrid.js b/src/ol/tilegrid/zoomifytilegrid.js
index 81c27e3c8f..43e5469282 100644
--- a/src/ol/tilegrid/zoomifytilegrid.js
+++ b/src/ol/tilegrid/zoomifytilegrid.js
@@ -11,7 +11,6 @@ goog.require('ol.tilegrid.TileGrid');
* @constructor
* @extends {ol.tilegrid.TileGrid}
* @param {olx.tilegrid.ZoomifyOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.tilegrid.Zoomify = function(opt_options) {
diff --git a/src/ol/tileloadfunction.js b/src/ol/tileloadfunction.js
index 9524830044..8e3ffa05c4 100644
--- a/src/ol/tileloadfunction.js
+++ b/src/ol/tileloadfunction.js
@@ -6,6 +6,6 @@ goog.provide('ol.TileLoadFunctionType');
* `{string}` for the src as arguments.
*
* @typedef {function(ol.ImageTile, string)}
- * @todo stability experimental
+ * @todo api
*/
ol.TileLoadFunctionType;
diff --git a/src/ol/tileurlfunction.js b/src/ol/tileurlfunction.js
index 9cd028d1ef..23c0bf311c 100644
--- a/src/ol/tileurlfunction.js
+++ b/src/ol/tileurlfunction.js
@@ -14,7 +14,7 @@ goog.require('ol.TileCoord');
*
* @typedef {function(ol.TileCoord, number,
* ol.proj.Projection): (string|undefined)}
- * @todo stability experimental
+ * @todo api
*/
ol.TileUrlFunctionType;
diff --git a/src/ol/transformfunction.js b/src/ol/transformfunction.js
index 3bf13896ec..e37975ed93 100644
--- a/src/ol/transformfunction.js
+++ b/src/ol/transformfunction.js
@@ -8,6 +8,6 @@ goog.provide('ol.TransformFunction');
* returns the output array.
*
* @typedef {function(Array., Array.=, number=): Array.}
- * @todo stability experimental
+ * @todo api
*/
ol.TransformFunction;
diff --git a/src/ol/view2d.js b/src/ol/view2d.js
index 6c23063dc4..0a20d803c7 100644
--- a/src/ol/view2d.js
+++ b/src/ol/view2d.js
@@ -23,7 +23,6 @@ goog.require('ol.proj.Units');
/**
* @enum {string}
- * @todo stability experimental
*/
ol.View2DProperty = {
CENTER: 'center',
@@ -86,7 +85,6 @@ ol.View2DProperty = {
* @implements {ol.IView3D}
* @extends {ol.View}
* @param {olx.View2DOptions=} opt_options View2D options.
- * @todo stability experimental
* @todo observable center {ol.Coordinate} the center of the view
* @todo observable projection {ol.proj.Projection} the projection of the view
* @todo observable resolution {number} the resolution of the view
@@ -197,7 +195,6 @@ ol.View2D.prototype.constrainCenter = function(center) {
* @param {number=} opt_delta Delta. Default is `0`.
* @param {number=} opt_direction Direction. Default is `0`.
* @return {number|undefined} Constrained resolution.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.constrainResolution = function(
@@ -213,7 +210,6 @@ ol.View2D.prototype.constrainResolution = function(
* @param {number|undefined} rotation Rotation.
* @param {number=} opt_delta Delta. Default is `0`.
* @return {number|undefined} Constrained rotation.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.constrainRotation = function(rotation, opt_delta) {
@@ -224,6 +220,7 @@ ol.View2D.prototype.constrainRotation = function(rotation, opt_delta) {
/**
* @inheritDoc
+ * @todo api
*/
ol.View2D.prototype.getCenter = function() {
return /** @type {ol.Coordinate|undefined} */ (
@@ -240,7 +237,6 @@ goog.exportProperty(
* resolution and the current center.
* @param {ol.Size} size Box pixel size.
* @return {ol.Extent} Extent.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.calculateExtent = function(size) {
@@ -257,6 +253,7 @@ ol.View2D.prototype.calculateExtent = function(size) {
/**
* @inheritDoc
+ * @todo api
*/
ol.View2D.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ (
@@ -270,6 +267,7 @@ goog.exportProperty(
/**
* @inheritDoc
+ * @todo api
*/
ol.View2D.prototype.getResolution = function() {
return /** @type {number|undefined} */ (
@@ -320,6 +318,7 @@ ol.View2D.prototype.getResolutionForValueFunction = function(opt_power) {
/**
* @inheritDoc
+ * @todo api
*/
ol.View2D.prototype.getRotation = function() {
return /** @type {number|undefined} */ (this.get(ol.View2DProperty.ROTATION));
@@ -393,7 +392,6 @@ ol.View2D.prototype.getView3D = function() {
* Get the current zoom level. Return undefined if the current
* resolution is undefined or not a "constrained resolution".
* @return {number|undefined} Zoom.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.getZoom = function() {
@@ -420,7 +418,6 @@ ol.View2D.prototype.getZoom = function() {
* Fit the given extent based on the given map size.
* @param {ol.Extent} extent Extent.
* @param {ol.Size} size Box pixel size.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.fitExtent = function(extent, size) {
@@ -443,7 +440,6 @@ ol.View2D.prototype.fitExtent = function(extent, size) {
* @param {ol.geom.SimpleGeometry} geometry Geometry.
* @param {ol.Size} size Box pixel size.
* @param {olx.View2D.fitGeometryOptions=} opt_options Options.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.fitGeometry = function(geometry, size, opt_options) {
@@ -511,7 +507,6 @@ ol.View2D.prototype.fitGeometry = function(geometry, size, opt_options) {
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Size} size Box pixel size.
* @param {ol.Pixel} position Position on the view to center on.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.centerOn = function(coordinate, size, position) {
@@ -561,7 +556,7 @@ ol.View2D.prototype.rotate = function(rotation, opt_anchor) {
/**
* Set the center of the current view.
* @param {ol.Coordinate|undefined} center Center.
- * @todo stability experimental
+ * @todo api
*/
ol.View2D.prototype.setCenter = function(center) {
this.set(ol.View2DProperty.CENTER, center);
@@ -576,7 +571,7 @@ goog.exportProperty(
* Set the projection of this view.
* Warning! This code is not yet implemented. Function should not be used.
* @param {ol.proj.Projection|undefined} projection Projection.
- * @todo stability experimental
+ * @todo api
*/
ol.View2D.prototype.setProjection = function(projection) {
this.set(ol.View2DProperty.PROJECTION, projection);
@@ -590,7 +585,7 @@ goog.exportProperty(
/**
* Set the resolution for this view.
* @param {number|undefined} resolution Resolution.
- * @todo stability experimental
+ * @todo api
*/
ol.View2D.prototype.setResolution = function(resolution) {
this.set(ol.View2DProperty.RESOLUTION, resolution);
@@ -604,7 +599,7 @@ goog.exportProperty(
/**
* Set the rotation for this view.
* @param {number|undefined} rotation Rotation.
- * @todo stability experimental
+ * @todo api
*/
ol.View2D.prototype.setRotation = function(rotation) {
this.set(ol.View2DProperty.ROTATION, rotation);
@@ -618,7 +613,6 @@ goog.exportProperty(
/**
* Zoom to a specific zoom level.
* @param {number} zoom Zoom level.
- * @todo stability experimental
* @todo api
*/
ol.View2D.prototype.setZoom = function(zoom) {
diff --git a/src/ol/webgl/context.js b/src/ol/webgl/context.js
index 67d24a8bad..78b98534af 100644
--- a/src/ol/webgl/context.js
+++ b/src/ol/webgl/context.js
@@ -23,7 +23,6 @@ ol.webgl.BufferCacheEntry;
* @extends {goog.events.EventTarget}
* @param {HTMLCanvasElement} canvas Canvas.
* @param {WebGLRenderingContext} gl GL.
- * @todo stability experimental
* @todo api
*/
ol.webgl.Context = function(canvas, gl) {
@@ -161,7 +160,6 @@ ol.webgl.Context.prototype.getCanvas = function() {
/**
* @return {WebGLRenderingContext} GL.
- * @todo stability experimental
* @todo api
*/
ol.webgl.Context.prototype.getGL = function() {
@@ -250,7 +248,6 @@ ol.webgl.Context.prototype.handleWebGLContextRestored = function() {
/**
* @param {WebGLProgram} program Program.
* @return {boolean} Changed.
- * @todo stability experimental
* @todo api
*/
ol.webgl.Context.prototype.useProgram = function(program) {
diff --git a/src/olx.jsdoc b/src/olx.jsdoc
new file mode 100644
index 0000000000..ec70071412
--- /dev/null
+++ b/src/olx.jsdoc
@@ -0,0 +1,43 @@
+/**
+ * @namespace olx
+ */
+
+/**
+ * @namespace olx.animation
+ */
+
+/**
+ * @namespace olx.control
+ */
+
+/**
+ * @namespace olx.format
+ */
+
+/**
+ * @namespace olx.interaction
+ */
+
+/**
+ * @namespace olx.layer
+ */
+
+/**
+ * @namespace olx.parser
+ */
+
+/**
+ * @namespace olx.render
+ */
+
+/**
+ * @namespace olx.source
+ */
+
+/**
+ * @namespace olx.style
+ */
+
+/**
+ * @namespace olx.tilegrid
+ */