Get rid of stability annotations and document stability with api

This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
This commit is contained in:
Andreas Hocevar
2014-04-17 00:56:44 +02:00
committed by Tim Schaub
parent 29b643c7b0
commit fbdbbfb7a7
146 changed files with 506 additions and 764 deletions

View File

@@ -22,11 +22,11 @@
"node_modules/jsdoc/plugins/markdown", "node_modules/jsdoc/plugins/markdown",
"apidoc/plugins/inheritdoc", "apidoc/plugins/inheritdoc",
"apidoc/plugins/interface", "apidoc/plugins/interface",
"apidoc/plugins/typedefs",
"apidoc/plugins/inheritdoc",
"apidoc/plugins/api", "apidoc/plugins/api",
"apidoc/plugins/olx-typedefs",
"apidoc/plugins/todo", "apidoc/plugins/todo",
"apidoc/plugins/observable", "apidoc/plugins/observable"
"apidoc/plugins/stability"
], ],
"markdown": { "markdown": {
"parser": "gfm" "parser": "gfm"

View File

@@ -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 * Based on @stability annotations, and assuming that items with no @stability
* annotation should not be documented, this plugin removes undocumented symbols * annotation should not be documented, this plugin removes undocumented symbols

View File

@@ -5,11 +5,104 @@
* TODO: Remove this hack when https://github.com/jsdoc3/jsdoc/issues/53 * TODO: Remove this hack when https://github.com/jsdoc3/jsdoc/issues/53
* is addressed. * is addressed.
*/ */
exports.astNodeVisitor = {
visitNode: function(node, e, parser, currentSourceName) {
if (/@(inheritDoc)(\n|\r)/.test(e.comment)) { exports.defineTags = function(dictionary) {
e.preventDefault = true; 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];
}
}
}
}
}
}
}
}
}
} }
} }

View File

@@ -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) );
}
}
})
};

View File

@@ -6,8 +6,8 @@ exports.defineTags = function(dictionary) {
canHaveName: true, canHaveName: true,
onTagged: function(doclet, tag) { onTagged: function(doclet, tag) {
var parts = tag.text.split(' '); var parts = tag.text.split(' ');
if (parts[0] === 'stability') { if (parts[0] === 'api') {
doclet.stability = parts.slice(1).join(' '); doclet.stability = parts.slice(1).join(' ') || 'experimental';
} else if (parts[0] === 'observable') { } else if (parts[0] === 'observable') {
if (!doclet.observables) { if (!doclet.observables) {
doclet.observables = []; doclet.observables = [];

View File

@@ -1,5 +1,6 @@
/* /*
* Converts olx.js @type annotations into properties of the previous @typedef. * Converts olx.js @type annotations into properties of the previous @typedef.
* Changes @enum annotations into @typedef.
*/ */
var lastOlxTypedef = null; var lastOlxTypedef = null;
@@ -13,8 +14,9 @@ function addSubparams(params) {
var name = types[k]; var name = types[k];
if (name in olxTypes) { if (name in olxTypes) {
param.subparams = olxTypes[name]; param.subparams = olxTypes[name];
addSubparams(param.subparams); // TODO Change template before recursing here, because the table gets
types[k] = 'Object'; // too wide.
//addSubparams(param.subparams);
// TODO Do we need to support multiple object literal types per // TODO Do we need to support multiple object literal types per
// param? // param?
break; break;
@@ -38,6 +40,10 @@ exports.handlers = {
} else { } else {
lastOlxTypedef = null; lastOlxTypedef = null;
} }
} else if (doclet.isEnum) {
// We never export enums, so we document them like typedefs
doclet.kind = 'typedef';
delete doclet.isEnum;
} }
}, },

View File

@@ -11,7 +11,6 @@ In the simplest case, a JSDoc block can look like this:
/** /**
* Add the given control to the map. * Add the given control to the map.
* @param {ol.control.Control} control Control. * @param {ol.control.Control} control Control.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.addControl = function(control) { 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 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 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.
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.
### Events ### Events
@@ -73,25 +37,26 @@ ol.MapBrowserEvent.EventType = {
* A true single click with no dragging and no double click. Note that this * 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 is delayed by 250 ms to ensure that it is not a double click.
* @event ol.MapBrowserEvent#singleclick * @event ol.MapBrowserEvent#singleclick
* @todo stability experimental * @todo api
*/ */
SINGLECLICK: 'singleclick', 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 ```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.MapBrowserEvent} ol.MapBrowserEvent
* @fires {@link ol.MapEvent} ol.MapEvent * @fires {@link ol.MapEvent} ol.MapEvent
* @fires {@link ol.render.Event} ol.render.Event * @fires {@link ol.render.Event} ol.render.Event
* ...
*/ */
ol.Map = function(options) { 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. 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.

View File

@@ -142,7 +142,7 @@
<h3 class="subsection-title">TypeDefs</h3> <h3 class="subsection-title">TypeDefs</h3>
<dl><?js typedefs.forEach(function(e) { ?> <dl><?js typedefs.forEach(function(e) { ?>
<?js= self.partial('members.tmpl', e) ?> <?js= self.partial(e.params ? 'method.tmpl' : 'members.tmpl', e) ?>
<?js }); ?></dl> <?js }); ?></dl>
<?js } ?> <?js } ?>

View File

@@ -14,8 +14,13 @@ var path = require('path');
exports.publish = function(data, opts) { exports.publish = function(data, opts) {
var cwd = process.cwd(); var cwd = process.cwd();
// get all doclets with the "api" property. // get all doclets with the "api" property, but no enums, typedefs and events.
var docs = data({api: {isString: true}}).get(); 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 // get symbols data, filter out those that are members of private classes
var symbols = docs.filter(function(doc) { var symbols = docs.filter(function(doc) {

View File

@@ -14,7 +14,11 @@ var oli;
oli.CollectionEvent; oli.CollectionEvent;
/** @type {*} */ /**
* The element that is added to or removed from the collection.
* @type {*}
* @todo api
*/
oli.CollectionEvent.prototype.element; oli.CollectionEvent.prototype.element;
@@ -23,7 +27,10 @@ oli.CollectionEvent.prototype.element;
oli.DragBoxEvent; oli.DragBoxEvent;
/** @type {ol.Coordinate} */ /**
* @type {ol.Coordinate}
* @todo api
*/
oli.DragBoxEvent.prototype.coordinate; oli.DragBoxEvent.prototype.coordinate;
@@ -32,7 +39,11 @@ oli.DragBoxEvent.prototype.coordinate;
oli.DrawEvent; oli.DrawEvent;
/** @type {ol.Feature} */ /**
* The feature being drawn.
* @type {ol.Feature}
* @todo api
*/
oli.DrawEvent.prototype.feature; oli.DrawEvent.prototype.feature;
@@ -79,7 +90,7 @@ oli.FrameState.prototype.logos;
/** /**
* @type {number} * @type {number}
* @todo stability experimental * @todo api
*/ */
oli.FrameState.prototype.pixelRatio; oli.FrameState.prototype.pixelRatio;
@@ -106,7 +117,7 @@ oli.FrameState.prototype.tileQueue;
/** /**
* @type {number} * @type {number}
* @todo stability experimental * @todo api
*/ */
oli.FrameState.prototype.time; oli.FrameState.prototype.time;
@@ -117,7 +128,7 @@ oli.FrameState.prototype.usedTiles;
/** /**
* @type {oli.View2DState} * @type {oli.View2DState}
* @todo stability experimental * @todo api
*/ */
oli.FrameState.prototype.view2DState; oli.FrameState.prototype.view2DState;
@@ -144,15 +155,24 @@ oli.ObjectEvent.prototype.key;
oli.MapBrowserEvent; oli.MapBrowserEvent;
/** @type {ol.Coordinate} */ /**
* @type {ol.Coordinate}
* @todo api
*/
oli.MapBrowserEvent.prototype.coordinate; oli.MapBrowserEvent.prototype.coordinate;
/** @type {Event} */ /**
* @type {Event}
* @todo api
*/
oli.MapBrowserEvent.prototype.originalEvent; oli.MapBrowserEvent.prototype.originalEvent;
/** @type {ol.Pixel} */ /**
* @type {ol.Pixel}
* @todo api
*/
oli.MapBrowserEvent.prototype.pixel; oli.MapBrowserEvent.prototype.pixel;
@@ -196,15 +216,24 @@ oli.control.Control.prototype.setMap = function(map) {};
oli.interaction.DragAndDropEvent; oli.interaction.DragAndDropEvent;
/** @type {Array.<ol.Feature>} */ /**
* @type {Array.<ol.Feature>|undefined}
* @todo api
*/
oli.interaction.DragAndDropEvent.prototype.features; oli.interaction.DragAndDropEvent.prototype.features;
/** @type {ol.proj.Projection} */ /**
* @type {ol.proj.Projection|undefined}
* @todo api
*/
oli.interaction.DragAndDropEvent.prototype.projection; oli.interaction.DragAndDropEvent.prototype.projection;
/** @type {File} */ /**
* @type {File}
* @todo api
*/
oli.interaction.DragAndDropEvent.prototype.file; oli.interaction.DragAndDropEvent.prototype.file;
@@ -212,19 +241,35 @@ oli.interaction.DragAndDropEvent.prototype.file;
oli.render.Event; 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; oli.render.Event.prototype.context;
/** @type {oli.FrameState|undefined} */ /**
* @type {oli.FrameState|undefined}
* @todo api
*/
oli.render.Event.prototype.frameState; 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; 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; oli.render.Event.prototype.vectorContext;
@@ -233,5 +278,9 @@ oli.render.Event.prototype.vectorContext;
oli.source.VectorEvent; oli.source.VectorEvent;
/** @type {ol.Feature} */ /**
* The feature being added or removed.
* @type {ol.Feature}
* @todo api
*/
oli.source.VectorEvent.prototype.feature; oli.source.VectorEvent.prototype.feature;

View File

@@ -7,7 +7,7 @@ var olx;
/** /**
* @typedef {{html: string, * @typedef {{html: string,
* tileRanges: (Object.<string, Array.<ol.TileRange>>|undefined)}} * tileRanges: (Object.<string, Array.<ol.TileRange>>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.AttributionOptions; olx.AttributionOptions;
@@ -29,7 +29,7 @@ olx.AttributionOptions.prototype.tileRanges;
/** /**
* @typedef {{loadTilesWhileAnimating: (boolean|undefined), * @typedef {{loadTilesWhileAnimating: (boolean|undefined),
* loadTilesWhileInteracting: (boolean|undefined)}} * loadTilesWhileInteracting: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.DeviceOptions; olx.DeviceOptions;
@@ -52,7 +52,7 @@ olx.DeviceOptions.prototype.loadTilesWhileInteracting;
/** /**
* @typedef {{tracking: (boolean|undefined)}} * @typedef {{tracking: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.DeviceOrientationOptions; olx.DeviceOrientationOptions;
@@ -68,7 +68,7 @@ olx.DeviceOrientationOptions.prototype.tracking;
* @typedef {{tracking: (boolean|undefined), * @typedef {{tracking: (boolean|undefined),
* trackingOptions: (GeolocationPositionOptions|undefined), * trackingOptions: (GeolocationPositionOptions|undefined),
* projection: ol.proj.ProjectionLike}} * projection: ol.proj.ProjectionLike}}
* @todo stability experimental * @todo api
*/ */
olx.GeolocationOptions; olx.GeolocationOptions;
@@ -107,7 +107,7 @@ olx.GeolocationOptions.prototype.projection;
* renderer: (ol.RendererHint|Array.<ol.RendererHint|string>|string|undefined), * renderer: (ol.RendererHint|Array.<ol.RendererHint|string>|string|undefined),
* target: (Element|string|undefined), * target: (Element|string|undefined),
* view: (ol.IView|undefined)}} * view: (ol.IView|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.MapOptions; 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.layer.Base>|ol.Collection|undefined} * @type {Array.<ol.layer.Base>|ol.Collection|undefined}
*/ */
olx.MapOptions.prototype.layers; olx.MapOptions.prototype.layers;
@@ -205,7 +206,7 @@ olx.MapOptions.prototype.view;
* insertFirst: (boolean|undefined), * insertFirst: (boolean|undefined),
* offsetX: (number|undefined), * offsetX: (number|undefined),
* offsetY: (number|undefined)}} * offsetY: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.OverlayOptions; olx.OverlayOptions;
@@ -271,7 +272,7 @@ olx.OverlayOptions.prototype.offsetY;
* @typedef {{code: string, * @typedef {{code: string,
* extent: (ol.Extent|undefined), * extent: (ol.Extent|undefined),
* global: (boolean|undefined)}} * global: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.Proj4jsProjectionOptions; olx.Proj4jsProjectionOptions;
@@ -304,7 +305,7 @@ olx.Proj4jsProjectionOptions.prototype.global;
* extent: (ol.Extent|undefined), * extent: (ol.Extent|undefined),
* axisOrientation: (string|undefined), * axisOrientation: (string|undefined),
* global: (boolean|undefined)}} * global: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.ProjectionOptions; olx.ProjectionOptions;
@@ -358,7 +359,7 @@ olx.ProjectionOptions.prototype.global;
* rotation: (number|undefined), * rotation: (number|undefined),
* zoom: (number|undefined), * zoom: (number|undefined),
* zoomFactor: (number|undefined)}} * zoomFactor: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.View2DOptions; olx.View2DOptions;
@@ -471,7 +472,7 @@ olx.View2DOptions.prototype.zoomFactor;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.animation.BounceOptions; olx.animation.BounceOptions;
@@ -510,7 +511,7 @@ olx.animation.BounceOptions.prototype.easing;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.animation.PanOptions; olx.animation.PanOptions;
@@ -549,7 +550,7 @@ olx.animation.PanOptions.prototype.easing;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.animation.RotateOptions; olx.animation.RotateOptions;
@@ -596,7 +597,7 @@ olx.animation.RotateOptions.prototype.easing;
* start: (number|undefined), * start: (number|undefined),
* duration: (number|undefined), * duration: (number|undefined),
* easing: (function(number):number|undefined)}} * easing: (function(number):number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.animation.ZoomOptions; olx.animation.ZoomOptions;
@@ -633,7 +634,7 @@ olx.animation.ZoomOptions.prototype.easing;
/** /**
* @typedef {{className: (string|undefined), * @typedef {{className: (string|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.AttributionOptions; olx.control.AttributionOptions;
@@ -655,7 +656,7 @@ olx.control.AttributionOptions.prototype.target;
/** /**
* @typedef {{element: (Element|undefined), * @typedef {{element: (Element|undefined),
* target: (Element|string|undefined)}} * target: (Element|string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.ControlOptions; olx.control.ControlOptions;
@@ -683,7 +684,7 @@ olx.control.ControlOptions.prototype.target;
* logoOptions: (olx.control.LogoOptions|undefined), * logoOptions: (olx.control.LogoOptions|undefined),
* zoom: (boolean|undefined), * zoom: (boolean|undefined),
* zoomOptions: (olx.control.ZoomOptions|undefined)}} * zoomOptions: (olx.control.ZoomOptions|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.DefaultsOptions; olx.control.DefaultsOptions;
@@ -735,7 +736,7 @@ olx.control.DefaultsOptions.prototype.zoomOptions;
* tipLabel: (string|undefined), * tipLabel: (string|undefined),
* keys: (boolean|undefined), * keys: (boolean|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.FullScreenOptions; olx.control.FullScreenOptions;
@@ -771,7 +772,7 @@ olx.control.FullScreenOptions.prototype.target;
/** /**
* @typedef {{className: (string|undefined), * @typedef {{className: (string|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.LogoOptions; olx.control.LogoOptions;
@@ -796,7 +797,7 @@ olx.control.LogoOptions.prototype.target;
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* target: (Element|undefined), * target: (Element|undefined),
* undefinedHTML: (string|undefined)}} * undefinedHTML: (string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.MousePositionOptions; olx.control.MousePositionOptions;
@@ -841,7 +842,7 @@ olx.control.MousePositionOptions.prototype.undefinedHTML;
* minWidth: (number|undefined), * minWidth: (number|undefined),
* target: (Element|undefined), * target: (Element|undefined),
* units: (ol.control.ScaleLineUnits|string|undefined)}} * units: (ol.control.ScaleLineUnits|string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.ScaleLineOptions; olx.control.ScaleLineOptions;
@@ -883,7 +884,7 @@ olx.control.ScaleLineOptions.prototype.units;
* zoomOutTipLabel: (string|undefined), * zoomOutTipLabel: (string|undefined),
* delta: (number|undefined), * delta: (number|undefined),
* target: (Element|undefined)}} * target: (Element|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.ZoomOptions; olx.control.ZoomOptions;
@@ -948,7 +949,7 @@ olx.control.ZoomOptions.prototype.target;
* @typedef {{className: (string|undefined), * @typedef {{className: (string|undefined),
* maxResolution: (number|undefined), * maxResolution: (number|undefined),
* minResolution: (number|undefined)}} * minResolution: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.ZoomSliderOptions; olx.control.ZoomSliderOptions;
@@ -979,7 +980,7 @@ olx.control.ZoomSliderOptions.prototype.minResolution;
* target: (Element|undefined), * target: (Element|undefined),
* tipLabel: (string|undefined), * tipLabel: (string|undefined),
* extent: (ol.Extent|undefined)}} * extent: (ol.Extent|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.ZoomToExtentOptions; olx.control.ZoomToExtentOptions;
@@ -1015,7 +1016,7 @@ olx.control.ZoomToExtentOptions.prototype.extent;
/** /**
* @typedef {{defaultProjection: ol.proj.ProjectionLike}} * @typedef {{defaultProjection: ol.proj.ProjectionLike}}
* @todo stability experimental * @todo api
*/ */
olx.format.GeoJSONOptions; olx.format.GeoJSONOptions;
@@ -1029,7 +1030,7 @@ olx.format.GeoJSONOptions.prototype.defaultProjection;
/** /**
* @typedef {{defaultProjection: ol.proj.ProjectionLike}} * @typedef {{defaultProjection: ol.proj.ProjectionLike}}
* @todo stability experimental * @todo api
*/ */
olx.format.TopoJSONOptions; olx.format.TopoJSONOptions;
@@ -1043,7 +1044,7 @@ olx.format.TopoJSONOptions.prototype.defaultProjection;
/** /**
* @typedef {{altitudeMode: (ol.format.IGCZ|undefined)}} * @typedef {{altitudeMode: (ol.format.IGCZ|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.format.IGCOptions; olx.format.IGCOptions;
@@ -1058,7 +1059,7 @@ olx.format.IGCOptions.prototype.altitudeMode;
/** /**
* @typedef {{defaultStyle: (Array.<ol.style.Style>|undefined)}} * @typedef {{defaultStyle: (Array.<ol.style.Style>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.format.KMLOptions; olx.format.KMLOptions;
@@ -1079,7 +1080,7 @@ olx.format.KMLOptions.prototype.defaultStyle;
* multiCurve: (boolean|undefined), * multiCurve: (boolean|undefined),
* multiSurface: (boolean|undefined), * multiSurface: (boolean|undefined),
* schemaLocation: (string|undefined)}} * schemaLocation: (string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.format.GMLOptions; olx.format.GMLOptions;
@@ -1149,7 +1150,7 @@ olx.format.GMLOptions.prototype.schemaLocation;
* @typedef {{featureNS: string, * @typedef {{featureNS: string,
* featureType: string, * featureType: string,
* schemaLocation: (string|undefined)}} * schemaLocation: (string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.format.WFSOptions; olx.format.WFSOptions;
@@ -1186,7 +1187,7 @@ olx.format.WFSOptions.prototype.schemaLocation;
* maxFeatures: (number|undefined), * maxFeatures: (number|undefined),
* geometryName: (string|undefined), * geometryName: (string|undefined),
* bbox: (ol.Extent|undefined)}} * bbox: (ol.Extent|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.format.WFSWriteGetFeatureOptions; olx.format.WFSWriteGetFeatureOptions;
@@ -1262,7 +1263,7 @@ olx.format.WFSWriteGetFeatureOptions.prototype.bbox;
* srsName: (string|undefined), * srsName: (string|undefined),
* handle: (string|undefined), * handle: (string|undefined),
* nativeElements: Array.<Object>}} * nativeElements: Array.<Object>}}
* @todo stability experimental * @todo api
*/ */
olx.format.WFSWriteTransactionOptions; olx.format.WFSWriteTransactionOptions;
@@ -1322,7 +1323,7 @@ olx.format.WFSWriteTransactionOptions.prototype.nativeElements;
* pinchZoom: (boolean|undefined), * pinchZoom: (boolean|undefined),
* zoomDelta: (number|undefined), * zoomDelta: (number|undefined),
* zoomDuration: (number|undefined)}} * zoomDuration: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DefaultsOptions; olx.interaction.DefaultsOptions;
@@ -1400,7 +1401,7 @@ olx.interaction.DefaultsOptions.prototype.zoomDuration;
/** /**
* @typedef {{duration: (number|undefined), * @typedef {{duration: (number|undefined),
* delta: (number|undefined)}} * delta: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DoubleClickZoomOptions; olx.interaction.DoubleClickZoomOptions;
@@ -1422,7 +1423,7 @@ olx.interaction.DoubleClickZoomOptions.prototype.delta;
/** /**
* @typedef {{formatConstructors: (Array.<function(new: ol.format.Feature)>|undefined), * @typedef {{formatConstructors: (Array.<function(new: ol.format.Feature)>|undefined),
* reprojectTo: ol.proj.ProjectionLike}} * reprojectTo: ol.proj.ProjectionLike}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DragAndDropOptions; olx.interaction.DragAndDropOptions;
@@ -1444,7 +1445,7 @@ olx.interaction.DragAndDropOptions.prototype.reprojectTo;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined), * @typedef {{condition: (ol.events.ConditionType|undefined),
* style: ol.style.Style}} * style: ol.style.Style}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DragBoxOptions; olx.interaction.DragBoxOptions;
@@ -1466,7 +1467,7 @@ olx.interaction.DragBoxOptions.prototype.style;
/** /**
* @typedef {{kinetic: (ol.Kinetic|undefined)}} * @typedef {{kinetic: (ol.Kinetic|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DragPanOptions; olx.interaction.DragPanOptions;
@@ -1480,7 +1481,7 @@ olx.interaction.DragPanOptions.prototype.kinetic;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined)}} * @typedef {{condition: (ol.events.ConditionType|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DragRotateAndZoomOptions; olx.interaction.DragRotateAndZoomOptions;
@@ -1495,7 +1496,7 @@ olx.interaction.DragRotateAndZoomOptions.prototype.condition;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined)}} * @typedef {{condition: (ol.events.ConditionType|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DragRotateOptions; olx.interaction.DragRotateOptions;
@@ -1511,7 +1512,7 @@ olx.interaction.DragRotateOptions.prototype.condition;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined), * @typedef {{condition: (ol.events.ConditionType|undefined),
* style: ol.style.Style}} * style: ol.style.Style}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DragZoomOptions; olx.interaction.DragZoomOptions;
@@ -1538,7 +1539,7 @@ olx.interaction.DragZoomOptions.prototype.style;
* type: ol.geom.GeometryType, * type: ol.geom.GeometryType,
* minPointsPerRing: (number|undefined), * minPointsPerRing: (number|undefined),
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}} * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.DrawOptions; olx.interaction.DrawOptions;
@@ -1590,7 +1591,7 @@ olx.interaction.DrawOptions.prototype.style;
/** /**
* @typedef {{condition: (ol.events.ConditionType|undefined), * @typedef {{condition: (ol.events.ConditionType|undefined),
* pixelDelta: (number|undefined)}} * pixelDelta: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.KeyboardPanOptions; olx.interaction.KeyboardPanOptions;
@@ -1614,7 +1615,7 @@ olx.interaction.KeyboardPanOptions.prototype.pixelDelta;
* @typedef {{duration: (number|undefined), * @typedef {{duration: (number|undefined),
* condition: (ol.events.ConditionType|undefined), * condition: (ol.events.ConditionType|undefined),
* delta: (number|undefined)}} * delta: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.KeyboardZoomOptions; olx.interaction.KeyboardZoomOptions;
@@ -1646,7 +1647,7 @@ olx.interaction.KeyboardZoomOptions.prototype.delta;
* pixelTolerance: (number|undefined), * pixelTolerance: (number|undefined),
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined),
* features: ol.Collection}} * features: ol.Collection}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.ModifyOptions; olx.interaction.ModifyOptions;
@@ -1683,7 +1684,7 @@ olx.interaction.ModifyOptions.prototype.features;
/** /**
* @typedef {{duration: (number|undefined)}} * @typedef {{duration: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.MouseWheelZoomOptions; olx.interaction.MouseWheelZoomOptions;
@@ -1697,7 +1698,7 @@ olx.interaction.MouseWheelZoomOptions.prototype.duration;
/** /**
* @typedef {{threshold: (number|undefined)}} * @typedef {{threshold: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.PinchRotateOptions; olx.interaction.PinchRotateOptions;
@@ -1711,7 +1712,7 @@ olx.interaction.PinchRotateOptions.prototype.threshold;
/** /**
* @typedef {{duration: (number|undefined)}} * @typedef {{duration: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.PinchZoomOptions; olx.interaction.PinchZoomOptions;
@@ -1730,7 +1731,7 @@ olx.interaction.PinchZoomOptions.prototype.duration;
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined),
* removeCondition: (ol.events.ConditionType|undefined), * removeCondition: (ol.events.ConditionType|undefined),
* toggleCondition: (ol.events.ConditionType|undefined)}} * toggleCondition: (ol.events.ConditionType|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.interaction.SelectOptions; olx.interaction.SelectOptions;
@@ -1797,7 +1798,7 @@ olx.interaction.SelectOptions.prototype.toggleCondition;
* visible: (boolean|undefined), * visible: (boolean|undefined),
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined)}} * maxResolution: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.layer.BaseOptions; olx.layer.BaseOptions;
@@ -1868,7 +1869,7 @@ olx.layer.BaseOptions.prototype.maxResolution;
* visible: (boolean|undefined), * visible: (boolean|undefined),
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined)}} * maxResolution: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.layer.LayerOptions; olx.layer.LayerOptions;
@@ -1946,7 +1947,7 @@ olx.layer.LayerOptions.prototype.maxResolution;
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined), * maxResolution: (number|undefined),
* layers: (Array.<ol.layer.Base>|ol.Collection|undefined)}} * layers: (Array.<ol.layer.Base>|ol.Collection|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.layer.GroupOptions; olx.layer.GroupOptions;
@@ -2029,7 +2030,7 @@ olx.layer.GroupOptions.prototype.layers;
* saturation: (number|undefined), * saturation: (number|undefined),
* source: ol.source.Vector, * source: ol.source.Vector,
* visible: (boolean|undefined)}} * visible: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.layer.HeatmapOptions; olx.layer.HeatmapOptions;
@@ -2147,7 +2148,7 @@ olx.layer.HeatmapOptions.prototype.visible;
* minResolution: (number|undefined), * minResolution: (number|undefined),
* maxResolution: (number|undefined), * maxResolution: (number|undefined),
* useInterimTilesOnError: (boolean|undefined)}} * useInterimTilesOnError: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.layer.TileOptions; olx.layer.TileOptions;
@@ -2241,7 +2242,7 @@ olx.layer.TileOptions.prototype.useInterimTilesOnError;
* source: ol.source.Vector, * source: ol.source.Vector,
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined), * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined),
* visible: (boolean|undefined)}} * visible: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.layer.VectorOptions; olx.layer.VectorOptions;
@@ -2329,7 +2330,7 @@ olx.layer.VectorOptions.prototype.visible;
* @typedef {{features: (Array.<ol.Feature>|ol.Collection|undefined), * @typedef {{features: (Array.<ol.Feature>|ol.Collection|undefined),
* map: (ol.Map|undefined), * map: (ol.Map|undefined),
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}} * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.FeatureOverlayOptions; olx.FeatureOverlayOptions;
@@ -2360,7 +2361,7 @@ olx.FeatureOverlayOptions.prototype.style;
* key: string, * key: string,
* imagerySet: string, * imagerySet: string,
* tileLoadFunction: (ol.TileLoadFunctionType|undefined)}} * tileLoadFunction: (ol.TileLoadFunctionType|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.BingMapsOptions; olx.source.BingMapsOptions;
@@ -2399,7 +2400,7 @@ olx.source.BingMapsOptions.prototype.tileLoadFunction;
* format: ol.format.Feature, * format: ol.format.Feature,
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike}} * projection: ol.proj.ProjectionLike}}
* @todo stability experimental * @todo api
*/ */
olx.source.FormatVectorOptions; olx.source.FormatVectorOptions;
@@ -2449,7 +2450,7 @@ olx.source.FormatVectorOptions.prototype.projection;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.GeoJSONOptions; olx.source.GeoJSONOptions;
@@ -2528,7 +2529,7 @@ olx.source.GeoJSONOptions.prototype.urls;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.GPXOptions; olx.source.GPXOptions;
@@ -2610,7 +2611,7 @@ olx.source.GPXOptions.prototype.urls;
* tileGrid: (ol.tilegrid.TileGrid|undefined), * tileGrid: (ol.tilegrid.TileGrid|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* tileUrlFunction: (ol.TileUrlFunctionType|undefined)}} * tileUrlFunction: (ol.TileUrlFunctionType|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.TileImageOptions; olx.source.TileImageOptions;
@@ -2698,7 +2699,7 @@ olx.source.TileImageOptions.prototype.tileUrlFunction;
* tileUrlFunction: (ol.TileUrlFunctionType|undefined), * tileUrlFunction: (ol.TileUrlFunctionType|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.TileVectorOptions; olx.source.TileVectorOptions;
@@ -2784,7 +2785,7 @@ olx.source.TileVectorOptions.prototype.urls;
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.TopoJSONOptions; olx.source.TopoJSONOptions;
@@ -2852,7 +2853,7 @@ olx.source.TopoJSONOptions.prototype.url;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.IGCOptions; olx.source.IGCOptions;
@@ -2905,7 +2906,7 @@ olx.source.IGCOptions.prototype.urls;
* ratio: (number|undefined), * ratio: (number|undefined),
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* params: (Object|undefined)}} * params: (Object|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.MapGuideOptions; olx.source.MapGuideOptions;
@@ -2993,7 +2994,7 @@ olx.source.MapGuideOptions.prototype.params;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.KMLOptions; olx.source.KMLOptions;
@@ -3072,7 +3073,7 @@ olx.source.KMLOptions.prototype.urls;
/** /**
* @typedef {{layer: string, * @typedef {{layer: string,
* tileLoadFunction: (ol.TileLoadFunctionType|undefined)}} * tileLoadFunction: (ol.TileLoadFunctionType|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.MapQuestOptions; olx.source.MapQuestOptions;
@@ -3095,7 +3096,7 @@ olx.source.MapQuestOptions.prototype.tileLoadFunction;
* @typedef {{extent: (ol.Extent|undefined), * @typedef {{extent: (ol.Extent|undefined),
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* tileGrid: (ol.tilegrid.TileGrid|undefined)}} * tileGrid: (ol.tilegrid.TileGrid|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.TileDebugOptions; olx.source.TileDebugOptions;
@@ -3127,7 +3128,7 @@ olx.source.TileDebugOptions.prototype.tileGrid;
* maxZoom: (number|undefined), * maxZoom: (number|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.OSMOptions; olx.source.OSMOptions;
@@ -3180,7 +3181,7 @@ olx.source.OSMOptions.prototype.url;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.OSMXMLOptions; olx.source.OSMXMLOptions;
@@ -3271,7 +3272,7 @@ olx.source.OSMXMLOptions.prototype.urls;
* ratio: (number|undefined), * ratio: (number|undefined),
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* state: (ol.source.State|string|undefined)}} * state: (ol.source.State|string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.ImageCanvasOptions; olx.source.ImageCanvasOptions;
@@ -3350,7 +3351,7 @@ olx.source.ImageCanvasOptions.prototype.state;
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* source: ol.source.Vector, * source: ol.source.Vector,
* style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}} * style: (ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.ImageVectorOptions; olx.source.ImageVectorOptions;
@@ -3426,7 +3427,7 @@ olx.source.ImageVectorOptions.prototype.style;
* ratio: (number|undefined), * ratio: (number|undefined),
* resolutions: (Array.<number>|undefined), * resolutions: (Array.<number>|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.ImageWMSOptions; olx.source.ImageWMSOptions;
@@ -3520,7 +3521,7 @@ olx.source.ImageWMSOptions.prototype.url;
* opaque: (boolean|undefined), * opaque: (boolean|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined)}} * url: (string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.StamenOptions; olx.source.StamenOptions;
@@ -3576,7 +3577,7 @@ olx.source.StamenOptions.prototype.url;
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* url: string}} * url: string}}
* @todo stability experimental * @todo api
*/ */
olx.source.ImageStaticOptions; olx.source.ImageStaticOptions;
@@ -3645,7 +3646,7 @@ olx.source.ImageStaticOptions.prototype.url;
* strategy: (function(ol.Extent, number): Array.<ol.Extent>|undefined), * strategy: (function(ol.Extent, number): Array.<ol.Extent>|undefined),
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike}} * projection: ol.proj.ProjectionLike}}
* @todo stability experimental * @todo api
*/ */
olx.source.ServerVectorOptions; olx.source.ServerVectorOptions;
@@ -3703,7 +3704,7 @@ olx.source.ServerVectorOptions.prototype.projection;
* @typedef {{crossOrigin: (null|string|undefined), * @typedef {{crossOrigin: (null|string|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: string}} * url: string}}
* @todo stability experimental * @todo api
*/ */
olx.source.TileJSONOptions; olx.source.TileJSONOptions;
@@ -3744,7 +3745,7 @@ olx.source.TileJSONOptions.prototype.url;
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.TileWMSOptions; olx.source.TileWMSOptions;
@@ -3866,7 +3867,7 @@ olx.source.TileWMSOptions.prototype.urls;
* logo: (string|undefined), * logo: (string|undefined),
* projection: ol.proj.ProjectionLike, * projection: ol.proj.ProjectionLike,
* state: (ol.source.State|string|undefined)}} * state: (ol.source.State|string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.VectorOptions; olx.source.VectorOptions;
@@ -3926,7 +3927,7 @@ olx.source.VectorOptions.prototype.state;
* text: (string|undefined), * text: (string|undefined),
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.StaticVectorOptions; olx.source.StaticVectorOptions;
@@ -4033,7 +4034,7 @@ olx.source.StaticVectorOptions.prototype.urls;
* maxZoom: (number|undefined), * maxZoom: (number|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* urls: (Array.<string>|undefined)}} * urls: (Array.<string>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.WMTSOptions; olx.source.WMTSOptions;
@@ -4170,7 +4171,7 @@ olx.source.WMTSOptions.prototype.urls;
* url: (string|undefined), * url: (string|undefined),
* urls: (Array.<string>|undefined), * urls: (Array.<string>|undefined),
* wrapX: (boolean|undefined)}} * wrapX: (boolean|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.source.XYZOptions; olx.source.XYZOptions;
@@ -4267,7 +4268,7 @@ olx.source.XYZOptions.prototype.wrapX;
* url: !string, * url: !string,
* tierSizeCalculation: (string|undefined), * tierSizeCalculation: (string|undefined),
* size: ol.Size}} * size: ol.Size}}
* @todo stability experimental * @todo api
*/ */
olx.source.ZoomifyOptions; olx.source.ZoomifyOptions;
@@ -4318,7 +4319,7 @@ olx.source.ZoomifyOptions.prototype.size;
* @typedef {{fill: (ol.style.Fill|undefined), * @typedef {{fill: (ol.style.Fill|undefined),
* radius: number, * radius: number,
* stroke: (ol.style.Stroke|undefined)}} * stroke: (ol.style.Stroke|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.style.CircleOptions; olx.style.CircleOptions;
@@ -4346,7 +4347,7 @@ olx.style.CircleOptions.prototype.stroke;
/** /**
* @typedef {{color: (ol.Color|string|undefined)}} * @typedef {{color: (ol.Color|string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.style.FillOptions; olx.style.FillOptions;
@@ -4369,7 +4370,7 @@ olx.style.FillOptions.prototype.color;
* rotation: (number|undefined), * rotation: (number|undefined),
* size: (ol.Size|undefined), * size: (ol.Size|undefined),
* src: string}} * src: string}}
* @todo stability experimental * @todo api
*/ */
olx.style.IconOptions; olx.style.IconOptions;
@@ -4456,7 +4457,7 @@ olx.style.IconOptions.prototype.src;
* lineDash: (Array.<number>|undefined), * lineDash: (Array.<number>|undefined),
* miterLimit: (number|undefined), * miterLimit: (number|undefined),
* width: (number|undefined)}} * width: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.style.StrokeOptions; olx.style.StrokeOptions;
@@ -4514,7 +4515,7 @@ olx.style.StrokeOptions.prototype.width;
* textBaseline: (string|undefined), * textBaseline: (string|undefined),
* fill: (ol.style.Fill|undefined), * fill: (ol.style.Fill|undefined),
* stroke: (ol.style.Stroke|undefined)}} * stroke: (ol.style.Stroke|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.style.TextOptions; olx.style.TextOptions;
@@ -4597,7 +4598,7 @@ olx.style.TextOptions.prototype.stroke;
* stroke: (ol.style.Stroke|undefined), * stroke: (ol.style.Stroke|undefined),
* text: (ol.style.Text|undefined), * text: (ol.style.Text|undefined),
* zIndex: (number|undefined)}} * zIndex: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.style.StyleOptions; olx.style.StyleOptions;
@@ -4644,7 +4645,7 @@ olx.style.StyleOptions.prototype.zIndex;
* resolutions: !Array.<number>, * resolutions: !Array.<number>,
* tileSize: (number|undefined), * tileSize: (number|undefined),
* tileSizes: (Array.<number>|undefined)}} * tileSizes: (Array.<number>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.tilegrid.TileGridOptions; olx.tilegrid.TileGridOptions;
@@ -4698,7 +4699,7 @@ olx.tilegrid.TileGridOptions.prototype.tileSizes;
* matrixIds: !Array.<string>, * matrixIds: !Array.<string>,
* tileSize: (number|undefined), * tileSize: (number|undefined),
* tileSizes: (Array.<number>|undefined)}} * tileSizes: (Array.<number>|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.tilegrid.WMTSOptions; olx.tilegrid.WMTSOptions;
@@ -4747,7 +4748,7 @@ olx.tilegrid.WMTSOptions.prototype.tileSizes;
/** /**
* @typedef {{maxZoom: number}} * @typedef {{maxZoom: number}}
* @todo stability experimental * @todo api
*/ */
olx.tilegrid.XYZOptions; olx.tilegrid.XYZOptions;
@@ -4761,7 +4762,7 @@ olx.tilegrid.XYZOptions.prototype.maxZoom;
/** /**
* @typedef {{resolutions: !Array.<number>}} * @typedef {{resolutions: !Array.<number>}}
* @todo stability experimental * @todo api
*/ */
olx.tilegrid.ZoomifyOptions; olx.tilegrid.ZoomifyOptions;
@@ -4778,7 +4779,7 @@ olx.tilegrid.ZoomifyOptions.prototype.resolutions;
* constrainResolution: (boolean|undefined), * constrainResolution: (boolean|undefined),
* nearest: (boolean|undefined), * nearest: (boolean|undefined),
* minResolution: (number|undefined)}} * minResolution: (number|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.View2D.fitGeometryOptions; olx.View2D.fitGeometryOptions;

View File

@@ -13,7 +13,10 @@ For events, we make properties available to the application. Other than methods,
/** @interface */ /** @interface */
oli.MapBrowserEvent; oli.MapBrowserEvent;
/** @type {ol.Coordinate} */ /**
* @type {ol.Coordinate}
* @todo api
*/
oli.MapBrowserEvent.prototype.coordinate; oli.MapBrowserEvent.prototype.coordinate;
``` ```
In the source file (`src/ol/MapBrowserEvent.js`), the class needs to implement this interface: 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} * @type {ol.Coordinate}
* @todo stability experimental
*/ */
this.coordinate = map.getEventCoordinate(this.originalEvent); this.coordinate = map.getEventCoordinate(this.originalEvent);
// ... // ...
}; };
```
### Override methods in custom classes ### Override methods in custom classes
@@ -69,7 +72,7 @@ ol.control.Control = function(options) {
/** /**
* Application subclasses may override this. * Application subclasses may override this.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo stability experimental * @todo api
*/ */
ol.control.Control.prototype.setMap = function(map) { 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), * @typedef {{element: (Element|undefined),
* target: (Element|string|undefined)}} * target: (Element|string|undefined)}}
* @todo stability experimental * @todo api
*/ */
olx.control.ControlOptions; 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: In the source code, the name used for the typedef is used as type whenever this object literal is expected:
```js ```js
/**
* ... * ...
* @param {olx.control.ControlOptions} options Control options. * @param {olx.control.ControlOptions} options Control options.
*/ */

View File

@@ -11,7 +11,6 @@ goog.require('ol.easing');
/** /**
* @param {olx.animation.BounceOptions} options Bounce options. * @param {olx.animation.BounceOptions} options Bounce options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.animation.bounce = function(options) { ol.animation.bounce = function(options) {
@@ -47,7 +46,6 @@ ol.animation.bounce = function(options) {
/** /**
* @param {olx.animation.PanOptions} options Pan options. * @param {olx.animation.PanOptions} options Pan options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.animation.pan = function(options) { ol.animation.pan = function(options) {
@@ -87,7 +85,6 @@ ol.animation.pan = function(options) {
/** /**
* @param {olx.animation.RotateOptions} options Rotate options. * @param {olx.animation.RotateOptions} options Rotate options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.animation.rotate = function(options) { ol.animation.rotate = function(options) {
@@ -133,7 +130,6 @@ ol.animation.rotate = function(options) {
/** /**
* @param {olx.animation.ZoomOptions} options Zoom options. * @param {olx.animation.ZoomOptions} options Zoom options.
* @return {ol.PreRenderFunction} Pre-render function. * @return {ol.PreRenderFunction} Pre-render function.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.animation.zoom = function(options) { ol.animation.zoom = function(options) {

View File

@@ -22,7 +22,6 @@ goog.require('ol.TileRange');
* @constructor * @constructor
* @param {olx.AttributionOptions} options Attribution options. * @param {olx.AttributionOptions} options Attribution options.
* @struct * @struct
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Attribution = function(options) { ol.Attribution = function(options) {

View File

@@ -77,7 +77,6 @@ ol.IS_LEGACY_IE = goog.userAgent.IE &&
* (dips) on the device (`window.devicePixelRatio`). * (dips) on the device (`window.devicePixelRatio`).
* @const * @const
* @type {number} * @type {number}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.BrowserFeature.DEVICE_PIXEL_RATIO = goog.global.devicePixelRatio || 1; 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. * True if browser supports Canvas.
* @const * @const
* @type {boolean} * @type {boolean}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && ( 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. * Indicates if DeviceOrientation is supported in the user's browser.
* @const * @const
* @type {boolean} * @type {boolean}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.BrowserFeature.HAS_DEVICE_ORIENTATION = ol.BrowserFeature.HAS_DEVICE_ORIENTATION =
@@ -152,7 +149,6 @@ ol.BrowserFeature.HAS_DOM = ol.ENABLE_DOM;
* Is HTML5 geolocation supported in the current browser? * Is HTML5 geolocation supported in the current browser?
* @const * @const
* @type {boolean} * @type {boolean}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.BrowserFeature.HAS_GEOLOCATION = 'geolocation' in goog.global.navigator; ol.BrowserFeature.HAS_GEOLOCATION = 'geolocation' in goog.global.navigator;
@@ -170,7 +166,6 @@ ol.BrowserFeature.HAS_JSON_PARSE =
* True if browser supports touch events. * True if browser supports touch events.
* @const * @const
* @type {boolean} * @type {boolean}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.BrowserFeature.HAS_TOUCH = ol.ASSUME_TOUCH || 'ontouchstart' in goog.global; ol.BrowserFeature.HAS_TOUCH = ol.ASSUME_TOUCH || 'ontouchstart' in goog.global;

View File

@@ -12,6 +12,6 @@ goog.provide('ol.CanvasFunctionType');
* *
* @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number, * @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number,
* number, ol.Size, ol.proj.Projection): HTMLCanvasElement} * number, ol.Size, ol.proj.Projection): HTMLCanvasElement}
* @todo stability experimental * @todo api
*/ */
ol.CanvasFunctionType; ol.CanvasFunctionType;

View File

@@ -6,7 +6,7 @@ goog.require('goog.math');
/** /**
* @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)} * @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)}
* @todo stability experimental * @todo api
*/ */
ol.CenterConstraintType; ol.CenterConstraintType;

View File

@@ -19,13 +19,13 @@ ol.CollectionEventType = {
/** /**
* Triggered when an item is added to the collection. * Triggered when an item is added to the collection.
* @event ol.CollectionEvent#add * @event ol.CollectionEvent#add
* @todo stability experimental * @todo api
*/ */
ADD: 'add', ADD: 'add',
/** /**
* Triggered when an item is removed from the collection. * Triggered when an item is removed from the collection.
* @event ol.CollectionEvent#remove * @event ol.CollectionEvent#remove
* @todo stability experimental * @todo api
*/ */
REMOVE: 'remove' 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. * The element that is added to or removed from the collection.
* @type {*} * @type {*}
* @todo stability experimental
*/ */
this.element = opt_element; this.element = opt_element;
@@ -70,7 +69,6 @@ ol.CollectionProperty = {
* @extends {ol.Object} * @extends {ol.Object}
* @fires {@link ol.CollectionEvent} ol.CollectionEvent * @fires {@link ol.CollectionEvent} ol.CollectionEvent
* @param {Array=} opt_array Array. * @param {Array=} opt_array Array.
* @todo stability experimental
* @todo observable length {number} readonly the length of the array * @todo observable length {number} readonly the length of the array
* @todo api * @todo api
*/ */
@@ -92,7 +90,6 @@ goog.inherits(ol.Collection, ol.Object);
/** /**
* Remove all elements from the collection. * Remove all elements from the collection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.clear = function() { ol.Collection.prototype.clear = function() {
@@ -105,7 +102,6 @@ ol.Collection.prototype.clear = function() {
/** /**
* @param {Array} arr Array. * @param {Array} arr Array.
* @return {ol.Collection} This collection. * @return {ol.Collection} This collection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.extend = function(arr) { 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. * index and the array). The return value is ignored.
* @param {S=} opt_this The object to use as `this` in `f`. * @param {S=} opt_this The object to use as `this` in `f`.
* @template T,S * @template T,S
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.forEach = function(f, opt_this) { 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 * collection's "length" property won't be in sync with the actual length
* of the array. * of the array.
* @return {Array} Array. * @return {Array} Array.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.getArray = function() { ol.Collection.prototype.getArray = function() {
@@ -150,7 +144,6 @@ ol.Collection.prototype.getArray = function() {
* Get the element at the provided index. * Get the element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @return {*} Element. * @return {*} Element.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.getAt = function(index) { ol.Collection.prototype.getAt = function(index) {
@@ -161,7 +154,6 @@ ol.Collection.prototype.getAt = function(index) {
/** /**
* Get the length of this collection. * Get the length of this collection.
* @return {number} Length. * @return {number} Length.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.getLength = function() { ol.Collection.prototype.getLength = function() {
@@ -173,7 +165,6 @@ ol.Collection.prototype.getLength = function() {
* Insert an element at the provided index. * Insert an element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @param {*} elem Element. * @param {*} elem Element.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.insertAt = function(index, elem) { 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. * Remove the last element of the collection.
* @return {*} Element. * @return {*} Element.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.pop = function() { ol.Collection.prototype.pop = function() {
@@ -199,7 +189,6 @@ ol.Collection.prototype.pop = function() {
* Insert the provided element at the end of the collection. * Insert the provided element at the end of the collection.
* @param {*} elem Element. * @param {*} elem Element.
* @return {number} Length. * @return {number} Length.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.push = function(elem) { 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. * Removes the first occurence of elem from the collection.
* @param {*} elem Element. * @param {*} elem Element.
* @return {*} The removed element or undefined if elem was not found. * @return {*} The removed element or undefined if elem was not found.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.remove = function(elem) { ol.Collection.prototype.remove = function(elem) {
@@ -232,7 +220,6 @@ ol.Collection.prototype.remove = function(elem) {
* Remove the element at the provided index. * Remove the element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @return {*} Value. * @return {*} Value.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.removeAt = function(index) { ol.Collection.prototype.removeAt = function(index) {
@@ -249,7 +236,6 @@ ol.Collection.prototype.removeAt = function(index) {
* Set the element at the provided index. * Set the element at the provided index.
* @param {number} index Index. * @param {number} index Index.
* @param {*} elem Element. * @param {*} elem Element.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Collection.prototype.setAt = function(index, elem) { ol.Collection.prototype.setAt = function(index, elem) {

View File

@@ -103,7 +103,6 @@ ol.color.blend = function(dst, src, opt_color) {
/** /**
* @param {ol.Color|string} color Color. * @param {ol.Color|string} color Color.
* @return {ol.Color} Color. * @return {ol.Color} Color.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.color.asArray = function(color) { ol.color.asArray = function(color) {
@@ -119,7 +118,6 @@ ol.color.asArray = function(color) {
/** /**
* @param {ol.Color|string} color Color. * @param {ol.Color|string} color Color.
* @return {string} String. * @return {string} String.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.color.asString = function(color) { ol.color.asString = function(color) {

View File

@@ -21,7 +21,6 @@ goog.require('ol.css');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.AttributionOptions=} opt_options Attribution options. * @param {olx.control.AttributionOptions=} opt_options Attribution options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.Attribution = function(opt_options) { ol.control.Attribution = function(opt_options) {

View File

@@ -16,8 +16,7 @@ goog.require('ol.Object');
* @extends {ol.Object} * @extends {ol.Object}
* @implements {oli.control.Control} * @implements {oli.control.Control}
* @param {olx.control.ControlOptions} options Control options. * @param {olx.control.ControlOptions} options Control options.
* @todo stability stable * @todo api stable
* @todo api
*/ */
ol.control.Control = function(options) { ol.control.Control = function(options) {
@@ -64,7 +63,6 @@ ol.control.Control.prototype.disposeInternal = function() {
/** /**
* Get the map associated with this control. * Get the map associated with this control.
* @return {ol.Map} Map. * @return {ol.Map} Map.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.Control.prototype.getMap = function() { 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 * Subclasses may set up event handlers to get notified about changes to
* the map here. * the map here.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo stability stable * @todo api stable
* @todo api
*/ */
ol.control.Control.prototype.setMap = function(map) { ol.control.Control.prototype.setMap = function(map) {
if (!goog.isNull(this.map_)) { if (!goog.isNull(this.map_)) {

View File

@@ -9,7 +9,6 @@ goog.require('ol.control.Zoom');
/** /**
* @param {olx.control.DefaultsOptions=} opt_options Defaults options. * @param {olx.control.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} Controls. * @return {ol.Collection} Controls.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.defaults = function(opt_options) { ol.control.defaults = function(opt_options) {

View File

@@ -24,7 +24,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.FullScreenOptions=} opt_options Options. * @param {olx.control.FullScreenOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.FullScreen = function(opt_options) { ol.control.FullScreen = function(opt_options) {

View File

@@ -17,7 +17,6 @@ goog.require('ol.css');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.LogoOptions=} opt_options Logo options. * @param {olx.control.LogoOptions=} opt_options Logo options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.Logo = function(opt_options) { ol.control.Logo = function(opt_options) {

View File

@@ -42,7 +42,6 @@ ol.control.MousePositionProperty = {
* mouse position in * mouse position in
* @todo observable coordinateFormat {ol.CoordinateFormatType} the format to * @todo observable coordinateFormat {ol.CoordinateFormatType} the format to
* render the current position in * render the current position in
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.MousePosition = function(opt_options) { ol.control.MousePosition = function(opt_options) {
@@ -133,8 +132,8 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() {
/** /**
* @return {ol.CoordinateFormatType|undefined} projection. * @return {ol.CoordinateFormatType|undefined} Coordinate format.
* @todo stability experimental * @todo api
*/ */
ol.control.MousePosition.prototype.getCoordinateFormat = function() { ol.control.MousePosition.prototype.getCoordinateFormat = function() {
return /** @type {ol.CoordinateFormatType|undefined} */ ( return /** @type {ol.CoordinateFormatType|undefined} */ (
@@ -147,8 +146,8 @@ goog.exportProperty(
/** /**
* @return {ol.proj.Projection|undefined} projection. * @return {ol.proj.Projection|undefined} Projection.
* @todo stability experimental * @todo api
*/ */
ol.control.MousePosition.prototype.getProjection = function() { ol.control.MousePosition.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ ( return /** @type {ol.proj.Projection|undefined} */ (
@@ -203,7 +202,7 @@ ol.control.MousePosition.prototype.setMap = function(map) {
/** /**
* @param {ol.CoordinateFormatType} format Coordinate format. * @param {ol.CoordinateFormatType} format Coordinate format.
* @todo stability experimental * @todo api
*/ */
ol.control.MousePosition.prototype.setCoordinateFormat = function(format) { ol.control.MousePosition.prototype.setCoordinateFormat = function(format) {
this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format); this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format);
@@ -216,7 +215,7 @@ goog.exportProperty(
/** /**
* @param {ol.proj.Projection} projection Projection. * @param {ol.proj.Projection} projection Projection.
* @todo stability experimental * @todo api
*/ */
ol.control.MousePosition.prototype.setProjection = function(projection) { ol.control.MousePosition.prototype.setProjection = function(projection) {
this.set(ol.control.MousePositionProperty.PROJECTION, projection); this.set(ol.control.MousePositionProperty.PROJECTION, projection);

View File

@@ -20,7 +20,6 @@ goog.require('ol.sphere.NORMAL');
/** /**
* @enum {string} * @enum {string}
* @todo stability experimental
*/ */
ol.control.ScaleLineProperty = { ol.control.ScaleLineProperty = {
UNITS: 'units' UNITS: 'units'
@@ -28,8 +27,10 @@ ol.control.ScaleLineProperty = {
/** /**
* Units for the scale line. Supported values are `'degrees'`, `'imperial'`,
* `'nautical'`, `'metric'`, `'us'`.
* @enum {string} * @enum {string}
* @todo stability experimental * @todo api
*/ */
ol.control.ScaleLineUnits = { ol.control.ScaleLineUnits = {
DEGREES: 'degrees', DEGREES: 'degrees',
@@ -51,7 +52,6 @@ ol.control.ScaleLineUnits = {
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options. * @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @todo observable units {ol.control.ScaleLineUnits} the units to use in the * @todo observable units {ol.control.ScaleLineUnits} the units to use in the
* scale line * scale line
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.ScaleLine = function(opt_options) { ol.control.ScaleLine = function(opt_options) {
@@ -132,14 +132,13 @@ goog.inherits(ol.control.ScaleLine, ol.control.Control);
/** /**
* @const * @const
* @type {Array.<number>} * @type {Array.<number>}
* @todo stability experimental
*/ */
ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5]; ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
/** /**
* @return {ol.control.ScaleLineUnits|undefined} units. * @return {ol.control.ScaleLineUnits|undefined} units.
* @todo stability experimental * @todo api
*/ */
ol.control.ScaleLine.prototype.getUnits = function() { ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ ( return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -175,7 +174,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/** /**
* @param {ol.control.ScaleLineUnits} units Units. * @param {ol.control.ScaleLineUnits} units Units.
* @todo stability experimental * @todo api
*/ */
ol.control.ScaleLine.prototype.setUnits = function(units) { ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units); this.set(ol.control.ScaleLineProperty.UNITS, units);

View File

@@ -23,7 +23,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.ZoomOptions=} opt_options Zoom options. * @param {olx.control.ZoomOptions=} opt_options Zoom options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.Zoom = function(opt_options) { ol.control.Zoom = function(opt_options) {

View File

@@ -38,7 +38,6 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200;
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options. * @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.ZoomSlider = function(opt_options) { ol.control.ZoomSlider = function(opt_options) {

View File

@@ -20,7 +20,6 @@ goog.require('ol.pointer.PointerEventHandler');
* @constructor * @constructor
* @extends {ol.control.Control} * @extends {ol.control.Control}
* @param {olx.control.ZoomToExtentOptions=} opt_options Options. * @param {olx.control.ZoomToExtentOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.control.ZoomToExtent = function(opt_options) { ol.control.ZoomToExtent = function(opt_options) {

View File

@@ -11,7 +11,7 @@ goog.require('goog.math');
* `{string}`. * `{string}`.
* *
* @typedef {function((ol.Coordinate|undefined)): string} * @typedef {function((ol.Coordinate|undefined)): string}
* @todo stability experimental * @todo api
*/ */
ol.CoordinateFormatType; ol.CoordinateFormatType;
@@ -19,7 +19,7 @@ ol.CoordinateFormatType;
/** /**
* An array of numbers representing a coordinate. * An array of numbers representing a coordinate.
* @typedef {Array.<number>} ol.Coordinate * @typedef {Array.<number>} ol.Coordinate
* @todo stability experimental * @todo api
*/ */
ol.Coordinate; ol.Coordinate;
@@ -27,7 +27,7 @@ ol.Coordinate;
/** /**
* An array of coordinate arrays. * An array of coordinate arrays.
* @typedef {Array.<ol.Coordinate>} * @typedef {Array.<ol.Coordinate>}
* @todo stability experimental * @todo api
*/ */
ol.CoordinateArray; ol.CoordinateArray;
@@ -36,7 +36,6 @@ ol.CoordinateArray;
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta. * @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.coordinate.add = function(coordinate, delta) { 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 * @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`. * after the decimal point. Default is `0`.
* @return {ol.CoordinateFormatType} Coordinate format. * @return {ol.CoordinateFormatType} Coordinate format.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.coordinate.createStringXY = function(opt_fractionDigits) { 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 * @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`. * after the decimal point. Default is `0`.
* @return {string} Formated coordinate. * @return {string} Formated coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.coordinate.format = function(coordinate, template, opt_fractionDigits) { ol.coordinate.format = function(coordinate, template, opt_fractionDigits) {
@@ -162,7 +159,6 @@ ol.coordinate.equals = function(coordinate1, coordinate2) {
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @param {number} angle Angle. * @param {number} angle Angle.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.coordinate.rotate = function(coordinate, angle) { ol.coordinate.rotate = function(coordinate, angle) {
@@ -228,7 +224,6 @@ ol.coordinate.squaredDistanceToSegment = function(coordinate, segment) {
/** /**
* @param {ol.Coordinate|undefined} coordinate Coordinate. * @param {ol.Coordinate|undefined} coordinate Coordinate.
* @return {string} Hemisphere, degrees, minutes and seconds. * @return {string} Hemisphere, degrees, minutes and seconds.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.coordinate.toStringHDMS = function(coordinate) { ol.coordinate.toStringHDMS = function(coordinate) {
@@ -246,7 +241,6 @@ ol.coordinate.toStringHDMS = function(coordinate) {
* @param {number=} opt_fractionDigits The number of digits to include * @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`. * after the decimal point. Default is `0`.
* @return {string} XY. * @return {string} XY.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) { 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 {Array} array The array with coordinates.
* @param {string} axis the axis info. * @param {string} axis the axis info.
* @return {ol.Coordinate} The coordinate created. * @return {ol.Coordinate} The coordinate created.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.coordinate.fromProjectedArray = function(array, axis) { ol.coordinate.fromProjectedArray = function(array, axis) {

View File

@@ -79,7 +79,6 @@ ol.DeviceOrientationProperty = {
* device from the planar Y axis * device from the planar Y axis
* @todo observable tracking {boolean} the status of tracking changes to alpha, * @todo observable tracking {boolean} the status of tracking changes to alpha,
* beta and gamma. If true, changes are tracked and reported immediately. * beta and gamma. If true, changes are tracked and reported immediately.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.DeviceOrientation = function(opt_options) { ol.DeviceOrientation = function(opt_options) {
@@ -148,7 +147,7 @@ ol.DeviceOrientation.prototype.orientationChange_ = function(browserEvent) {
/** /**
* @return {number|undefined} The alpha value of the DeviceOrientation, * @return {number|undefined} The alpha value of the DeviceOrientation,
* in radians. * in radians.
* @todo stability experimental * @todo api
*/ */
ol.DeviceOrientation.prototype.getAlpha = function() { ol.DeviceOrientation.prototype.getAlpha = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -163,7 +162,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The beta value of the DeviceOrientation, * @return {number|undefined} The beta value of the DeviceOrientation,
* in radians. * in radians.
* @todo stability experimental * @todo api
*/ */
ol.DeviceOrientation.prototype.getBeta = function() { ol.DeviceOrientation.prototype.getBeta = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -178,7 +177,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The gamma value of the DeviceOrientation, * @return {number|undefined} The gamma value of the DeviceOrientation,
* in radians. * in radians.
* @todo stability experimental * @todo api
*/ */
ol.DeviceOrientation.prototype.getGamma = function() { ol.DeviceOrientation.prototype.getGamma = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -193,7 +192,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} The heading of the device relative to * @return {number|undefined} The heading of the device relative to
* north, in radians, normalizing for different browser behavior. * north, in radians, normalizing for different browser behavior.
* @todo stability experimental * @todo api
*/ */
ol.DeviceOrientation.prototype.getHeading = function() { ol.DeviceOrientation.prototype.getHeading = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -208,7 +207,7 @@ goog.exportProperty(
/** /**
* Are we tracking the device's orientation? * Are we tracking the device's orientation?
* @return {boolean} The current tracking state, true if tracking is on. * @return {boolean} The current tracking state, true if tracking is on.
* @todo stability experimental * @todo api
*/ */
ol.DeviceOrientation.prototype.getTracking = function() { ol.DeviceOrientation.prototype.getTracking = function() {
return /** @type {boolean} */ ( return /** @type {boolean} */ (
@@ -240,7 +239,7 @@ ol.DeviceOrientation.prototype.handleTrackingChanged_ = function() {
/** /**
* Enable or disable tracking of DeviceOrientation events. * Enable or disable tracking of DeviceOrientation events.
* @param {boolean} tracking True to enable and false to disable tracking. * @param {boolean} tracking True to enable and false to disable tracking.
* @todo stability experimental * @todo api
*/ */
ol.DeviceOrientation.prototype.setTracking = function(tracking) { ol.DeviceOrientation.prototype.setTracking = function(tracking) {
this.set(ol.DeviceOrientationProperty.TRACKING, tracking); this.set(ol.DeviceOrientationProperty.TRACKING, tracking);

View File

@@ -31,7 +31,6 @@ ol.dom.InputProperty = {
* @param {Element} target Target element. * @param {Element} target Target element.
* @todo observable value {string} the value of the Input * @todo observable value {string} the value of the Input
* @todo observable checked {boolean} the checked state of the Input * @todo observable checked {boolean} the checked state of the Input
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.dom.Input = function(target) { 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. * If the input is a checkbox, return whether or not the checbox is checked.
* @return {boolean|undefined} checked. * @return {boolean|undefined} checked.
* @todo stability experimental * @todo api
*/ */
ol.dom.Input.prototype.getChecked = function() { ol.dom.Input.prototype.getChecked = function() {
return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED)); return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED));
@@ -74,7 +73,7 @@ goog.exportProperty(
/** /**
* Get the value of the input. * Get the value of the input.
* @return {string|undefined} input value. * @return {string|undefined} input value.
* @todo stability experimental * @todo api
*/ */
ol.dom.Input.prototype.getValue = function() { ol.dom.Input.prototype.getValue = function() {
return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE)); return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE));
@@ -88,7 +87,7 @@ goog.exportProperty(
/** /**
* Sets the value of the input. * Sets the value of the input.
* @param {string} value Value. * @param {string} value Value.
* @todo stability experimental * @todo api
*/ */
ol.dom.Input.prototype.setValue = function(value) { ol.dom.Input.prototype.setValue = function(value) {
this.set(ol.dom.InputProperty.VALUE, value); this.set(ol.dom.InputProperty.VALUE, value);
@@ -102,7 +101,7 @@ goog.exportProperty(
/** /**
* Set whether or not a checkbox is checked. * Set whether or not a checkbox is checked.
* @param {boolean} checked Checked. * @param {boolean} checked Checked.
* @todo stability experimental * @todo api
*/ */
ol.dom.Input.prototype.setChecked = function(checked) { ol.dom.Input.prototype.setChecked = function(checked) {
this.set(ol.dom.InputProperty.CHECKED, checked); this.set(ol.dom.InputProperty.CHECKED, checked);

View File

@@ -7,7 +7,6 @@ goog.require('goog.fx.easing');
* from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js * from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.easing.bounce = function(t) { ol.easing.bounce = function(t) {
@@ -35,7 +34,6 @@ ol.easing.bounce = function(t) {
/** /**
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.easing.easeIn = goog.fx.easing.easeIn; 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. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.easing.easeOut = goog.fx.easing.easeOut; 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 * from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.easing.elastic = function(t) { ol.easing.elastic = function(t) {
@@ -65,7 +61,6 @@ ol.easing.elastic = function(t) {
/** /**
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.easing.inAndOut = goog.fx.easing.inAndOut; 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. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.easing.linear = function(t) { ol.easing.linear = function(t) {
@@ -85,7 +79,6 @@ ol.easing.linear = function(t) {
/** /**
* @param {number} t Input between 0 and 1. * @param {number} t Input between 0 and 1.
* @return {number} Output between 0 and 1. * @return {number} Output between 0 and 1.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.easing.upAndDown = function(t) { ol.easing.upAndDown = function(t) {

View File

@@ -13,7 +13,7 @@ goog.require('ol.MapBrowserPointerEvent');
* `{boolean}`. If the condition is met, true should be returned. * `{boolean}`. If the condition is met, true should be returned.
* *
* @typedef {function(ol.MapBrowserEvent): boolean} * @typedef {function(ol.MapBrowserEvent): boolean}
* @todo stability experimental * @todo api
*/ */
ol.events.ConditionType; ol.events.ConditionType;
@@ -21,7 +21,6 @@ ol.events.ConditionType;
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt key is pressed. * @return {boolean} True if only the alt key is pressed.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.altKeyOnly = function(mapBrowserEvent) { ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
@@ -36,7 +35,6 @@ ol.events.condition.altKeyOnly = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the alt and shift keys are pressed. * @return {boolean} True if only the alt and shift keys are pressed.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) { ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
@@ -52,7 +50,6 @@ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) {
* Always true. * Always true.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True. * @return {boolean} True.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.always = goog.functions.TRUE; ol.events.condition.always = goog.functions.TRUE;
@@ -62,7 +59,6 @@ ol.events.condition.always = goog.functions.TRUE;
* Always false. * Always false.
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} False. * @return {boolean} False.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.never = goog.functions.FALSE; ol.events.condition.never = goog.functions.FALSE;
@@ -80,7 +76,6 @@ ol.events.condition.singleClick = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if there no modifier keys are pressed. * @return {boolean} True only if there no modifier keys are pressed.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.noModifierKeys = function(mapBrowserEvent) { ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
@@ -95,7 +90,6 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the platform modifier key is pressed. * @return {boolean} True if only the platform modifier key is pressed.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) { ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
@@ -110,7 +104,6 @@ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True if only the shift key is pressed. * @return {boolean} True if only the shift key is pressed.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) { ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
@@ -125,7 +118,6 @@ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) {
/** /**
* @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
* @return {boolean} True only if the target element is not editable. * @return {boolean} True only if the target element is not editable.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.events.condition.targetNotEditable = function(mapBrowserEvent) { ol.events.condition.targetNotEditable = function(mapBrowserEvent) {

View File

@@ -12,7 +12,7 @@ goog.require('ol.TransformFunction');
/** /**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`. * An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>} * @typedef {Array.<number>}
* @todo stability experimental * @todo api
*/ */
ol.Extent; ol.Extent;
@@ -36,7 +36,6 @@ ol.extent.Relationship = {
* *
* @param {Array.<ol.Coordinate>} coordinates Coordinates. * @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @return {ol.Extent} Bounding extent. * @return {ol.Extent} Bounding extent.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.boundingExtent = function(coordinates) { 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 {number} value The amount by wich the extent should be buffered.
* @param {ol.Extent=} opt_extent Extent. * @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} Extent. * @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.buffer = function(extent, value, opt_extent) { 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.Extent} extent Extent.
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains. * @return {boolean} Contains.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.containsCoordinate = function(extent, coordinate) { 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} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2. * @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Contains. * @return {boolean} Contains.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.containsExtent = function(extent1, extent2) { ol.extent.containsExtent = function(extent1, extent2) {
@@ -203,7 +199,6 @@ ol.extent.coordinateRelationship = function(extent, coordinate) {
/** /**
* @return {ol.Extent} Empty extent. * @return {ol.Extent} Empty extent.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.createEmpty = function() { ol.extent.createEmpty = function() {
@@ -308,7 +303,6 @@ ol.extent.empty = function(extent) {
* @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2. * @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Equals. * @return {boolean} Equals.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.equals = function(extent1, extent2) { 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} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2. * @param {ol.Extent} extent2 Extent 2.
* @return {ol.Extent} Extent. * @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.extend = function(extent1, extent2) { ol.extent.extend = function(extent1, extent2) {
@@ -432,7 +425,6 @@ ol.extent.getArea = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom left coordinate. * @return {ol.Coordinate} Bottom left coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getBottomLeft = function(extent) { ol.extent.getBottomLeft = function(extent) {
@@ -443,7 +435,6 @@ ol.extent.getBottomLeft = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom right coordinate. * @return {ol.Coordinate} Bottom right coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getBottomRight = function(extent) { ol.extent.getBottomRight = function(extent) {
@@ -454,7 +445,6 @@ ol.extent.getBottomRight = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Center. * @return {ol.Coordinate} Center.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getCenter = function(extent) { ol.extent.getCenter = function(extent) {
@@ -508,7 +498,6 @@ ol.extent.getForView2DAndSize =
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {number} Height. * @return {number} Height.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getHeight = function(extent) { ol.extent.getHeight = function(extent) {
@@ -542,7 +531,6 @@ ol.extent.getMargin = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Size} Size. * @return {ol.Size} Size.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getSize = function(extent) { ol.extent.getSize = function(extent) {
@@ -553,7 +541,6 @@ ol.extent.getSize = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top left coordinate. * @return {ol.Coordinate} Top left coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getTopLeft = function(extent) { ol.extent.getTopLeft = function(extent) {
@@ -564,7 +551,6 @@ ol.extent.getTopLeft = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top right coordinate. * @return {ol.Coordinate} Top right coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getTopRight = function(extent) { ol.extent.getTopRight = function(extent) {
@@ -575,7 +561,6 @@ ol.extent.getTopRight = function(extent) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {number} Width. * @return {number} Width.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.getWidth = function(extent) { ol.extent.getWidth = function(extent) {
@@ -587,7 +572,6 @@ ol.extent.getWidth = function(extent) {
* @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent. * @param {ol.Extent} extent2 Extent.
* @return {boolean} Intersects. * @return {boolean} Intersects.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.intersects = function(extent1, extent2) { ol.extent.intersects = function(extent1, extent2) {
@@ -601,7 +585,6 @@ ol.extent.intersects = function(extent1, extent2) {
/** /**
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @return {boolean} Is empty. * @return {boolean} Is empty.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.isEmpty = function(extent) { ol.extent.isEmpty = function(extent) {
@@ -735,7 +718,6 @@ ol.extent.touches = function(extent1, extent2) {
* @param {ol.TransformFunction} transformFn Transform function. * @param {ol.TransformFunction} transformFn Transform function.
* @param {ol.Extent=} opt_extent Destination extent. * @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent. * @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.extent.transform = function(extent, transformFn, opt_extent) { ol.extent.transform = function(extent, transformFn, opt_extent) {

View File

@@ -20,7 +20,6 @@ goog.require('ol.style.Style');
* @extends {ol.Object} * @extends {ol.Object}
* @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrValues * @param {ol.geom.Geometry|Object.<string, *>=} opt_geometryOrValues
* Values or geometry. * Values or geometry.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature = function(opt_geometryOrValues) { ol.Feature = function(opt_geometryOrValues) {
@@ -81,7 +80,6 @@ goog.inherits(ol.Feature, ol.Object);
/** /**
* @return {ol.geom.Geometry|undefined} Geometry. * @return {ol.geom.Geometry|undefined} Geometry.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.getGeometry = function() { ol.Feature.prototype.getGeometry = function() {
@@ -96,7 +94,6 @@ goog.exportProperty(
/** /**
* @return {number|string|undefined} Id. * @return {number|string|undefined} Id.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.getId = function() { ol.Feature.prototype.getId = function() {
@@ -106,7 +103,6 @@ ol.Feature.prototype.getId = function() {
/** /**
* @return {string} Geometry property name. * @return {string} Geometry property name.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.getGeometryName = function() { ol.Feature.prototype.getGeometryName = function() {
@@ -117,7 +113,6 @@ ol.Feature.prototype.getGeometryName = function() {
/** /**
* @return {ol.style.Style|Array.<ol.style.Style>| * @return {ol.style.Style|Array.<ol.style.Style>|
* ol.feature.FeatureStyleFunction} User provided style. * ol.feature.FeatureStyleFunction} User provided style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.getStyle = function() { ol.Feature.prototype.getStyle = function() {
@@ -127,7 +122,6 @@ ol.Feature.prototype.getStyle = function() {
/** /**
* @return {ol.feature.FeatureStyleFunction|undefined} Style function. * @return {ol.feature.FeatureStyleFunction|undefined} Style function.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.getStyleFunction = function() { ol.Feature.prototype.getStyleFunction = function() {
@@ -162,7 +156,6 @@ ol.Feature.prototype.handleGeometryChanged_ = function() {
/** /**
* @param {ol.geom.Geometry|undefined} geometry Geometry. * @param {ol.geom.Geometry|undefined} geometry Geometry.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.setGeometry = function(geometry) { ol.Feature.prototype.setGeometry = function(geometry) {
@@ -177,7 +170,6 @@ goog.exportProperty(
/** /**
* @param {ol.style.Style|Array.<ol.style.Style>| * @param {ol.style.Style|Array.<ol.style.Style>|
* ol.feature.FeatureStyleFunction} style Feature style. * ol.feature.FeatureStyleFunction} style Feature style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.setStyle = function(style) { ol.Feature.prototype.setStyle = function(style) {
@@ -189,7 +181,6 @@ ol.Feature.prototype.setStyle = function(style) {
/** /**
* @param {number|string|undefined} id Id. * @param {number|string|undefined} id Id.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.setId = function(id) { ol.Feature.prototype.setId = function(id) {
@@ -199,7 +190,6 @@ ol.Feature.prototype.setId = function(id) {
/** /**
* @param {string} name Geometry property name. * @param {string} name Geometry property name.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Feature.prototype.setGeometryName = function(name) { ol.Feature.prototype.setGeometryName = function(name) {
@@ -221,7 +211,7 @@ ol.Feature.prototype.setGeometryName = function(name) {
* {@link ol.Feature} to be styled. * {@link ol.Feature} to be styled.
* *
* @typedef {function(this: ol.Feature, number): Array.<ol.style.Style>} * @typedef {function(this: ol.Feature, number): Array.<ol.style.Style>}
* @todo stability experimental * @todo api
*/ */
ol.feature.FeatureStyleFunction; 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. * {@link ol.style.Style}. This way e.g. a vector layer can be styled.
* *
* @typedef {function(ol.Feature, number): Array.<ol.style.Style>} * @typedef {function(ol.Feature, number): Array.<ol.style.Style>}
* @todo stability experimental * @todo api
*/ */
ol.feature.StyleFunction; ol.feature.StyleFunction;

View File

@@ -16,7 +16,6 @@ goog.require('ol.render.EventType');
/** /**
* @constructor * @constructor
* @param {olx.FeatureOverlayOptions=} opt_options Options. * @param {olx.FeatureOverlayOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay = function(opt_options) { ol.FeatureOverlay = function(opt_options) {
@@ -86,7 +85,6 @@ ol.FeatureOverlay = function(opt_options) {
/** /**
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.addFeature = function(feature) { ol.FeatureOverlay.prototype.addFeature = function(feature) {
@@ -96,7 +94,6 @@ ol.FeatureOverlay.prototype.addFeature = function(feature) {
/** /**
* @return {ol.Collection} Features collection. * @return {ol.Collection} Features collection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.getFeatures = function() { ol.FeatureOverlay.prototype.getFeatures = function() {
@@ -170,7 +167,6 @@ ol.FeatureOverlay.prototype.handleMapPostCompose_ = function(event) {
/** /**
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.removeFeature = function(feature) { ol.FeatureOverlay.prototype.removeFeature = function(feature) {
@@ -190,7 +186,6 @@ ol.FeatureOverlay.prototype.render_ = function() {
/** /**
* @param {ol.Collection} features Features collection. * @param {ol.Collection} features Features collection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.setFeatures = function(features) { ol.FeatureOverlay.prototype.setFeatures = function(features) {
@@ -225,7 +220,6 @@ ol.FeatureOverlay.prototype.setFeatures = function(features) {
/** /**
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.setMap = function(map) { ol.FeatureOverlay.prototype.setMap = function(map) {
@@ -250,7 +244,6 @@ ol.FeatureOverlay.prototype.setMap = function(map) {
* an array of styles. * an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style * @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Overlay style. * Overlay style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.setStyle = function(style) { ol.FeatureOverlay.prototype.setStyle = function(style) {
@@ -265,7 +258,6 @@ ol.FeatureOverlay.prototype.setStyle = function(style) {
* option at construction or to the `setStyle` method. * option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} * @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Overlay style. * Overlay style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.getStyle = function() { ol.FeatureOverlay.prototype.getStyle = function() {
@@ -276,7 +268,6 @@ ol.FeatureOverlay.prototype.getStyle = function() {
/** /**
* Get the style function. * Get the style function.
* @return {ol.feature.StyleFunction|undefined} Style function. * @return {ol.feature.StyleFunction|undefined} Style function.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.FeatureOverlay.prototype.getStyleFunction = function() { ol.FeatureOverlay.prototype.getStyleFunction = function() {

View File

@@ -26,7 +26,6 @@ goog.require('ol.proj');
* @constructor * @constructor
* @extends {ol.format.JSONFeature} * @extends {ol.format.JSONFeature}
* @param {olx.format.GeoJSONOptions=} opt_options Options. * @param {olx.format.GeoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GeoJSON = function(opt_options) { ol.format.GeoJSON = function(opt_options) {
@@ -323,7 +322,6 @@ ol.format.GeoJSON.prototype.getExtensions = function() {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GeoJSON.prototype.readFeature; ol.format.GeoJSON.prototype.readFeature;
@@ -336,7 +334,6 @@ ol.format.GeoJSON.prototype.readFeature;
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GeoJSON.prototype.readFeatures; ol.format.GeoJSON.prototype.readFeatures;
@@ -391,7 +388,6 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GeoJSON.prototype.readGeometry; ol.format.GeoJSON.prototype.readGeometry;
@@ -411,7 +407,6 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) {
* *
* @param {ArrayBuffer|Document|Node|Object|string} object Source. * @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GeoJSON.prototype.readProjection = function(object) { ol.format.GeoJSON.prototype.readProjection = function(object) {
@@ -442,7 +437,6 @@ ol.format.GeoJSON.prototype.readProjection = function(object) {
* @function * @function
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GeoJSON.prototype.writeFeature; ol.format.GeoJSON.prototype.writeFeature;
@@ -479,7 +473,6 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) {
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GeoJSON.prototype.writeFeatures; ol.format.GeoJSON.prototype.writeFeatures;

View File

@@ -19,7 +19,6 @@ goog.require('ol.xml');
/** /**
* @constructor * @constructor
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GPX = function() { ol.format.GPX = function() {
@@ -370,7 +369,6 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS(
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GPX.prototype.readFeature; ol.format.GPX.prototype.readFeature;
@@ -402,7 +400,6 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GPX.prototype.readFeatures; ol.format.GPX.prototype.readFeatures;
@@ -435,7 +432,6 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) {
* *
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GPX.prototype.readProjection; ol.format.GPX.prototype.readProjection;
@@ -811,7 +807,6 @@ goog.inherits(ol.format.GPX.V1_1, ol.format.GPX);
* @function * @function
* @param {Array.<ol.Feature>} features Features. * @param {Array.<ol.Feature>} features Features.
* @return {ArrayBuffer|Node|Object|string} Result. * @return {ArrayBuffer|Node|Object|string} Result.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.GPX.prototype.writeFeatures; ol.format.GPX.prototype.writeFeatures;

View File

@@ -25,7 +25,6 @@ ol.format.IGCZ = {
* @constructor * @constructor
* @extends {ol.format.TextFeature} * @extends {ol.format.TextFeature}
* @param {olx.format.IGCOptions=} opt_options Options. * @param {olx.format.IGCOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.IGC = function(opt_options) { ol.format.IGC = function(opt_options) {
@@ -92,7 +91,6 @@ ol.format.IGC.prototype.getExtensions = function() {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.IGC.prototype.readFeature; ol.format.IGC.prototype.readFeature;
@@ -179,7 +177,6 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.IGC.prototype.readFeatures; ol.format.IGC.prototype.readFeatures;
@@ -204,7 +201,6 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.IGC.prototype.readProjection; ol.format.IGC.prototype.readProjection;

View File

@@ -54,7 +54,6 @@ ol.format.KMLGxTrackObject_;
* @constructor * @constructor
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @param {olx.format.KMLOptions=} opt_options Options. * @param {olx.format.KMLOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.KML = function(opt_options) { ol.format.KML = function(opt_options) {
@@ -1451,7 +1450,6 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.Feature} Feature. * @return {ol.Feature} Feature.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.KML.prototype.readFeature; ol.format.KML.prototype.readFeature;
@@ -1481,7 +1479,6 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.KML.prototype.readFeatures; ol.format.KML.prototype.readFeatures;
@@ -1600,7 +1597,6 @@ ol.format.KML.prototype.readNameFromNode = function(node) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.KML.prototype.readProjection; ol.format.KML.prototype.readProjection;

View File

@@ -18,7 +18,6 @@ goog.require('ol.xml');
/** /**
* @constructor * @constructor
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.OSMXML = function() { ol.format.OSMXML = function() {

View File

@@ -19,7 +19,6 @@ goog.require('ol.proj');
* @constructor * @constructor
* @extends {ol.format.JSONFeature} * @extends {ol.format.JSONFeature}
* @param {olx.format.TopoJSONOptions=} opt_options Options. * @param {olx.format.TopoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.TopoJSON = function(opt_options) { ol.format.TopoJSON = function(opt_options) {
@@ -272,7 +271,6 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs,
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features. * @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.TopoJSON.prototype.readFeatures; ol.format.TopoJSON.prototype.readFeatures;
@@ -383,7 +381,6 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) {
* @function * @function
* @param {ArrayBuffer|Document|Node|Object|string} object Source. * @param {ArrayBuffer|Document|Node|Object|string} object Source.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.TopoJSON.prototype.readProjection = function(object) { ol.format.TopoJSON.prototype.readProjection = function(object) {

View File

@@ -17,7 +17,6 @@ goog.require('ol.xml');
* @param {olx.format.WFSOptions=} opt_options * @param {olx.format.WFSOptions=} opt_options
* Optional configuration object. * Optional configuration object.
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.WFS = function(opt_options) { 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. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.TransactionResponse|undefined} Transaction response. * @return {ol.format.WFS.TransactionResponse|undefined} Transaction response.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.WFS.prototype.readTransactionResponse = function(source) { 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. * @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {ol.format.WFS.FeatureCollectionMetadata|undefined} * @return {ol.format.WFS.FeatureCollectionMetadata|undefined}
* FeatureCollection metadata. * FeatureCollection metadata.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) { 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. * @param {olx.format.WFSWriteGetFeatureOptions} options Options.
* @return {Node} Result. * @return {Node} Result.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.WFS.prototype.writeGetFeature = function(options) { ol.format.WFS.prototype.writeGetFeature = function(options) {
@@ -607,7 +603,6 @@ ol.format.WFS.prototype.writeGetFeature = function(options) {
* @param {Array.<ol.Feature>} deletes The features to delete. * @param {Array.<ol.Feature>} deletes The features to delete.
* @param {olx.format.WFSWriteTransactionOptions} options Write options. * @param {olx.format.WFSWriteTransactionOptions} options Write options.
* @return {Node} Result. * @return {Node} Result.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes, ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes,

View File

@@ -15,7 +15,6 @@ goog.require('ol.xml');
/** /**
* @constructor * @constructor
* @extends {ol.format.XML} * @extends {ol.format.XML}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.WMSCapabilities = function() { ol.format.WMSCapabilities = function() {
@@ -36,7 +35,6 @@ goog.inherits(ol.format.WMSCapabilities, ol.format.XML);
* @function * @function
* @param {Document|Node|string} source The XML source. * @param {Document|Node|string} source The XML source.
* @return {Object} An object representing the WMS capabilities. * @return {Object} An object representing the WMS capabilities.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.format.WMSCapabilities.prototype.read; ol.format.WMSCapabilities.prototype.read;

View File

@@ -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} * @typedef {function(ol.Map, ?oli.FrameState): boolean}
* @todo api
*/ */
ol.PreRenderFunction; ol.PreRenderFunction;

View File

@@ -71,7 +71,6 @@ ol.GeolocationProperty = {
* @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions * @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions
* as defined by the HTML5 Geolocation spec at * as defined by the HTML5 Geolocation spec at
* http://www.w3.org/TR/geolocation-API/#position_options_interface * http://www.w3.org/TR/geolocation-API/#position_options_interface
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Geolocation = function(opt_options) { ol.Geolocation = function(opt_options) {
@@ -207,7 +206,7 @@ ol.Geolocation.prototype.positionError_ = function(error) {
/** /**
* Get the accuracy of the position in meters. * Get the accuracy of the position in meters.
* @return {number|undefined} Position accuracy in meters. * @return {number|undefined} Position accuracy in meters.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getAccuracy = function() { ol.Geolocation.prototype.getAccuracy = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -222,7 +221,7 @@ goog.exportProperty(
/** /**
* Get a geometry of the position accuracy. * Get a geometry of the position accuracy.
* @return {?ol.geom.Geometry} Accuracy geometry. * @return {?ol.geom.Geometry} Accuracy geometry.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getAccuracyGeometry = function() { ol.Geolocation.prototype.getAccuracyGeometry = function() {
return /** @type {?ol.geom.Geometry} */ ( return /** @type {?ol.geom.Geometry} */ (
@@ -237,7 +236,7 @@ goog.exportProperty(
/** /**
* Get the altitude associated with the position. * Get the altitude associated with the position.
* @return {number|undefined} The altitude in meters above the mean sea level. * @return {number|undefined} The altitude in meters above the mean sea level.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getAltitude = function() { ol.Geolocation.prototype.getAltitude = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -252,7 +251,7 @@ goog.exportProperty(
/** /**
* Get the altitude accuracy of the position. * Get the altitude accuracy of the position.
* @return {number|undefined} Altitude accuracy in meters. * @return {number|undefined} Altitude accuracy in meters.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getAltitudeAccuracy = function() { ol.Geolocation.prototype.getAltitudeAccuracy = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -267,7 +266,7 @@ goog.exportProperty(
/** /**
* Get the heading as radians clockwise from North. * Get the heading as radians clockwise from North.
* @return {number|undefined} Heading. * @return {number|undefined} Heading.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getHeading = function() { ol.Geolocation.prototype.getHeading = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -282,7 +281,7 @@ goog.exportProperty(
/** /**
* Get the position of the device. * Get the position of the device.
* @return {ol.Coordinate|undefined} position. * @return {ol.Coordinate|undefined} position.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getPosition = function() { ol.Geolocation.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ ( return /** @type {ol.Coordinate|undefined} */ (
@@ -297,7 +296,7 @@ goog.exportProperty(
/** /**
* Get the projection associated with the position. * Get the projection associated with the position.
* @return {ol.proj.Projection|undefined} projection. * @return {ol.proj.Projection|undefined} projection.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getProjection = function() { ol.Geolocation.prototype.getProjection = function() {
return /** @type {ol.proj.Projection|undefined} */ ( return /** @type {ol.proj.Projection|undefined} */ (
@@ -312,7 +311,7 @@ goog.exportProperty(
/** /**
* Get the speed in meters per second. * Get the speed in meters per second.
* @return {number|undefined} Speed. * @return {number|undefined} Speed.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getSpeed = function() { ol.Geolocation.prototype.getSpeed = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -327,7 +326,7 @@ goog.exportProperty(
/** /**
* Are we tracking the user's position? * Are we tracking the user's position?
* @return {boolean} tracking. * @return {boolean} tracking.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getTracking = function() { ol.Geolocation.prototype.getTracking = function() {
return /** @type {boolean} */ ( return /** @type {boolean} */ (
@@ -344,7 +343,7 @@ goog.exportProperty(
* @see http://www.w3.org/TR/geolocation-API/#position-options * @see http://www.w3.org/TR/geolocation-API/#position-options
* @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation * @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation
* tracking options. * tracking options.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.getTrackingOptions = function() { ol.Geolocation.prototype.getTrackingOptions = function() {
return /** @type {GeolocationPositionOptions|undefined} */ ( return /** @type {GeolocationPositionOptions|undefined} */ (
@@ -359,7 +358,7 @@ goog.exportProperty(
/** /**
* Set the projection to use for transforming the coordinates. * Set the projection to use for transforming the coordinates.
* @param {ol.proj.Projection} projection Projection. * @param {ol.proj.Projection} projection Projection.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.setProjection = function(projection) { ol.Geolocation.prototype.setProjection = function(projection) {
this.set(ol.GeolocationProperty.PROJECTION, projection); this.set(ol.GeolocationProperty.PROJECTION, projection);
@@ -373,7 +372,7 @@ goog.exportProperty(
/** /**
* Enable/disable tracking. * Enable/disable tracking.
* @param {boolean} tracking Enable or disable tracking. * @param {boolean} tracking Enable or disable tracking.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.setTracking = function(tracking) { ol.Geolocation.prototype.setTracking = function(tracking) {
this.set(ol.GeolocationProperty.TRACKING, tracking); this.set(ol.GeolocationProperty.TRACKING, tracking);
@@ -389,7 +388,7 @@ goog.exportProperty(
* @see http://www.w3.org/TR/geolocation-API/#position-options * @see http://www.w3.org/TR/geolocation-API/#position-options
* @param {GeolocationPositionOptions} options HTML 5 Geolocation * @param {GeolocationPositionOptions} options HTML 5 Geolocation
* tracking options. * tracking options.
* @todo stability experimental * @todo api
*/ */
ol.Geolocation.prototype.setTrackingOptions = function(options) { ol.Geolocation.prototype.setTrackingOptions = function(options) {
this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options); this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options);

View File

@@ -14,7 +14,6 @@ goog.require('ol.geom.flat.deflate');
* @param {ol.geom.RawPoint} center Center. * @param {ol.geom.RawPoint} center Center.
* @param {number=} opt_radius Radius. * @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Circle = function(center, opt_radius, opt_layout) { 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. * @return {ol.geom.RawPoint} Center.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Circle.prototype.getCenter = function() { ol.geom.Circle.prototype.getCenter = function() {
@@ -110,7 +108,6 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/** /**
* @return {number} Radius. * @return {number} Radius.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Circle.prototype.getRadius = function() { ol.geom.Circle.prototype.getRadius = function() {
@@ -149,7 +146,6 @@ ol.geom.Circle.prototype.getType = function() {
/** /**
* @param {ol.geom.RawPoint} center Center. * @param {ol.geom.RawPoint} center Center.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Circle.prototype.setCenter = function(center) { 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 {ol.geom.RawPoint} center Center.
* @param {number} radius Radius. * @param {number} radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Circle.prototype.setCenterAndRadius = ol.geom.Circle.prototype.setCenterAndRadius =
@@ -210,7 +205,6 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/** /**
* @param {number} radius Radius. * @param {number} radius Radius.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Circle.prototype.setRadius = function(radius) { ol.geom.Circle.prototype.setRadius = function(radius) {

View File

@@ -7,8 +7,11 @@ goog.require('ol.Observable');
/** /**
* The geometry type. One of `'Point'`, `'LineString'`, `'LinearRing'`,
* `'Polygon'`, `'MultiPoint'`, `'MultiLineString'`, `'MultiPolygon'`,
* `'GeometryCollection'`, `'Circle'`.
* @enum {string} * @enum {string}
* @todo stability experimental * @todo api
*/ */
ol.geom.GeometryType = { ol.geom.GeometryType = {
POINT: 'Point', 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} * @enum {string}
* @todo stability experimental * @todo api
*/ */
ol.geom.GeometryLayout = { ol.geom.GeometryLayout = {
XY: 'XY', XY: 'XY',
@@ -39,7 +45,6 @@ ol.geom.GeometryLayout = {
/** /**
* @constructor * @constructor
* @extends {ol.Observable} * @extends {ol.Observable}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Geometry = function() { ol.geom.Geometry = function() {
@@ -83,7 +88,6 @@ goog.inherits(ol.geom.Geometry, ol.Observable);
/** /**
* @function * @function
* @return {ol.geom.Geometry} Clone. * @return {ol.geom.Geometry} Clone.
* @todo stability experimental
*/ */
ol.geom.Geometry.prototype.clone = goog.abstractMethod; 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} point Point.
* @param {ol.Coordinate=} opt_closestPoint Closest point. * @param {ol.Coordinate=} opt_closestPoint Closest point.
* @return {ol.Coordinate} Closest point. * @return {ol.Coordinate} Closest point.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) { 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 * @function
* @param {ol.Extent=} opt_extent Extent. * @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent. * @return {ol.Extent} extent Extent.
* @todo stability experimental * @todo api
*/ */
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod; ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -143,7 +147,6 @@ ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
* @function * @function
* @param {number} squaredTolerance Squared tolerance. * @param {number} squaredTolerance Squared tolerance.
* @return {ol.geom.Geometry} Simplified geometry. * @return {ol.geom.Geometry} Simplified geometry.
* @todo stability experimental
*/ */
ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod; ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
@@ -151,7 +154,6 @@ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
/** /**
* @function * @function
* @return {ol.geom.GeometryType} Geometry type. * @return {ol.geom.GeometryType} Geometry type.
* @todo stability experimental
*/ */
ol.geom.Geometry.prototype.getType = goog.abstractMethod; ol.geom.Geometry.prototype.getType = goog.abstractMethod;
@@ -159,7 +161,6 @@ ol.geom.Geometry.prototype.getType = goog.abstractMethod;
/** /**
* @function * @function
* @param {ol.TransformFunction} transformFn Transform. * @param {ol.TransformFunction} transformFn Transform.
* @todo stability experimental
*/ */
ol.geom.Geometry.prototype.transform = goog.abstractMethod; ol.geom.Geometry.prototype.transform = goog.abstractMethod;

View File

@@ -15,7 +15,6 @@ goog.require('ol.geom.GeometryType');
* @constructor * @constructor
* @extends {ol.geom.Geometry} * @extends {ol.geom.Geometry}
* @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries. * @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.GeometryCollection = function(opt_geometries) { ol.geom.GeometryCollection = function(opt_geometries) {
@@ -147,7 +146,6 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/** /**
* @return {Array.<ol.geom.Geometry>} Geometries. * @return {Array.<ol.geom.Geometry>} Geometries.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.GeometryCollection.prototype.getGeometries = function() { ol.geom.GeometryCollection.prototype.getGeometries = function() {
@@ -227,7 +225,6 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/** /**
* @param {Array.<ol.geom.Geometry>} geometries Geometries. * @param {Array.<ol.geom.Geometry>} geometries Geometries.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) { ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {

View File

@@ -16,7 +16,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLinearRing} coordinates Coordinates. * @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LinearRing = function(coordinates, opt_layout) { ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -75,7 +74,6 @@ ol.geom.LinearRing.prototype.closestPointXY =
/** /**
* @return {number} Area. * @return {number} Area.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LinearRing.prototype.getArea = function() { ol.geom.LinearRing.prototype.getArea = function() {
@@ -86,7 +84,6 @@ ol.geom.LinearRing.prototype.getArea = function() {
/** /**
* @return {ol.geom.RawLinearRing} Coordinates. * @return {ol.geom.RawLinearRing} Coordinates.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LinearRing.prototype.getCoordinates = function() { 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.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LinearRing.prototype.setCoordinates = ol.geom.LinearRing.prototype.setCoordinates =

View File

@@ -20,7 +20,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates. * @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LineString = function(coordinates, opt_layout) { ol.geom.LineString = function(coordinates, opt_layout) {
@@ -60,7 +59,6 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry);
/** /**
* @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} coordinate Coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LineString.prototype.appendCoordinate = function(coordinate) { ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
@@ -117,7 +115,6 @@ ol.geom.LineString.prototype.closestPointXY =
* @param {number} m M. * @param {number} m M.
* @param {boolean=} opt_extrapolate Extrapolate. * @param {boolean=} opt_extrapolate Extrapolate.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) { 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. * @return {ol.geom.RawLineString} Coordinates.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LineString.prototype.getCoordinates = function() { ol.geom.LineString.prototype.getCoordinates = function() {
@@ -144,7 +140,6 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/** /**
* @return {number} Length. * @return {number} Length.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LineString.prototype.getLength = function() { 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.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.LineString.prototype.setCoordinates = ol.geom.LineString.prototype.setCoordinates =

View File

@@ -20,7 +20,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiLineString} coordinates Coordinates. * @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiLineString = function(coordinates, opt_layout) { 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. * @param {ol.geom.LineString} lineString LineString.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiLineString.prototype.appendLineString = function(lineString) { ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
@@ -122,7 +120,6 @@ ol.geom.MultiLineString.prototype.closestPointXY =
* @param {boolean=} opt_extrapolate Extrapolate. * @param {boolean=} opt_extrapolate Extrapolate.
* @param {boolean=} opt_interpolate Interpolate. * @param {boolean=} opt_interpolate Interpolate.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiLineString.prototype.getCoordinateAtM = ol.geom.MultiLineString.prototype.getCoordinateAtM =
@@ -141,7 +138,6 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM =
/** /**
* @return {ol.geom.RawMultiLineString} Coordinates. * @return {ol.geom.RawMultiLineString} Coordinates.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiLineString.prototype.getCoordinates = function() { ol.geom.MultiLineString.prototype.getCoordinates = function() {
@@ -161,7 +157,6 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.LineString} LineString. * @return {ol.geom.LineString} LineString.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiLineString.prototype.getLineString = function(index) { ol.geom.MultiLineString.prototype.getLineString = function(index) {
@@ -178,7 +173,6 @@ ol.geom.MultiLineString.prototype.getLineString = function(index) {
/** /**
* @return {Array.<ol.geom.LineString>} LineStrings. * @return {Array.<ol.geom.LineString>} LineStrings.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiLineString.prototype.getLineStrings = function() { 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.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiLineString.prototype.setCoordinates = ol.geom.MultiLineString.prototype.setCoordinates =

View File

@@ -18,7 +18,6 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPoint} coordinates Coordinates. * @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPoint = function(coordinates, opt_layout) { 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. * @param {ol.geom.Point} point Point.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPoint.prototype.appendPoint = function(point) { ol.geom.MultiPoint.prototype.appendPoint = function(point) {
@@ -85,7 +83,6 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/** /**
* @return {ol.geom.RawMultiPoint} Coordinates. * @return {ol.geom.RawMultiPoint} Coordinates.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPoint.prototype.getCoordinates = function() { ol.geom.MultiPoint.prototype.getCoordinates = function() {
@@ -97,7 +94,6 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.Point} Point. * @return {ol.geom.Point} Point.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPoint.prototype.getPoint = function(index) { ol.geom.MultiPoint.prototype.getPoint = function(index) {
@@ -116,7 +112,6 @@ ol.geom.MultiPoint.prototype.getPoint = function(index) {
/** /**
* @return {Array.<ol.geom.Point>} Points. * @return {Array.<ol.geom.Point>} Points.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPoint.prototype.getPoints = function() { 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.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPoint.prototype.setCoordinates = ol.geom.MultiPoint.prototype.setCoordinates =

View File

@@ -25,7 +25,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates. * @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon = function(coordinates, opt_layout) { 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. * @param {ol.geom.Polygon} polygon Polygon.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) { ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
@@ -151,7 +149,6 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/** /**
* @return {number} Area. * @return {number} Area.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon.prototype.getArea = function() { ol.geom.MultiPolygon.prototype.getArea = function() {
@@ -162,7 +159,6 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/** /**
* @return {ol.geom.RawMultiPolygon} Coordinates. * @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon.prototype.getCoordinates = function() { ol.geom.MultiPolygon.prototype.getCoordinates = function() {
@@ -197,7 +193,6 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() {
/** /**
* @return {ol.geom.MultiPoint} Interior points. * @return {ol.geom.MultiPoint} Interior points.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon.prototype.getInteriorPoints = function() { ol.geom.MultiPolygon.prototype.getInteriorPoints = function() {
@@ -250,7 +245,6 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.Polygon} Polygon. * @return {ol.geom.Polygon} Polygon.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon.prototype.getPolygon = function(index) { ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
@@ -282,7 +276,6 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
/** /**
* @return {Array.<ol.geom.Polygon>} Polygons. * @return {Array.<ol.geom.Polygon>} Polygons.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon.prototype.getPolygons = function() { 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.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.MultiPolygon.prototype.setCoordinates = ol.geom.MultiPolygon.prototype.setCoordinates =

View File

@@ -14,7 +14,6 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPoint} coordinates Coordinates. * @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Point = function(coordinates, opt_layout) { ol.geom.Point = function(coordinates, opt_layout) {
@@ -60,7 +59,6 @@ ol.geom.Point.prototype.closestPointXY =
/** /**
* @return {ol.geom.RawPoint} Coordinates. * @return {ol.geom.RawPoint} Coordinates.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Point.prototype.getCoordinates = function() { 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.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -24,7 +24,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates. * @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon = function(coordinates, opt_layout) { 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. * @param {ol.geom.LinearRing} linearRing Linear ring.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) { ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
@@ -140,7 +138,6 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/** /**
* @return {number} Area. * @return {number} Area.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon.prototype.getArea = function() { ol.geom.Polygon.prototype.getArea = function() {
@@ -151,7 +148,6 @@ ol.geom.Polygon.prototype.getArea = function() {
/** /**
* @return {ol.geom.RawPolygon} Coordinates. * @return {ol.geom.RawPolygon} Coordinates.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon.prototype.getCoordinates = function() { ol.geom.Polygon.prototype.getCoordinates = function() {
@@ -185,7 +181,6 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() {
/** /**
* @return {ol.geom.Point} Interior point. * @return {ol.geom.Point} Interior point.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon.prototype.getInteriorPoint = function() { ol.geom.Polygon.prototype.getInteriorPoint = function() {
@@ -196,7 +191,6 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/** /**
* @param {number} index Index. * @param {number} index Index.
* @return {ol.geom.LinearRing} Linear ring. * @return {ol.geom.LinearRing} Linear ring.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon.prototype.getLinearRing = function(index) { ol.geom.Polygon.prototype.getLinearRing = function(index) {
@@ -213,7 +207,6 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) {
/** /**
* @return {Array.<ol.geom.LinearRing>} Linear rings. * @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon.prototype.getLinearRings = function() { 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.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {

View File

@@ -12,7 +12,6 @@ goog.require('ol.geom.flat.transform');
/** /**
* @constructor * @constructor
* @extends {ol.geom.Geometry} * @extends {ol.geom.Geometry}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.SimpleGeometry = function() { ol.geom.SimpleGeometry = function() {
@@ -103,7 +102,6 @@ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
/** /**
* @return {ol.Coordinate} First coordinate. * @return {ol.Coordinate} First coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() { ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() {
@@ -121,7 +119,6 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/** /**
* @return {ol.Coordinate} Last point. * @return {ol.Coordinate} Last point.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() { ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
@@ -131,7 +128,6 @@ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
/** /**
* @return {ol.geom.GeometryLayout} Layout. * @return {ol.geom.GeometryLayout} Layout.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.geom.SimpleGeometry.prototype.getLayout = function() { ol.geom.SimpleGeometry.prototype.getLayout = function() {

View File

@@ -67,7 +67,6 @@ goog.inherits(ol.ImageTile, ol.Tile);
/** /**
* @inheritDoc * @inheritDoc
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.ImageTile.prototype.getImage = function(opt_context) { ol.ImageTile.prototype.getImage = function(opt_context) {

View File

@@ -15,7 +15,6 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options. * @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DoubleClickZoom = function(opt_options) { ol.interaction.DoubleClickZoom = function(opt_options) {

View File

@@ -22,7 +22,6 @@ goog.require('ol.proj');
* @fires {@link ol.interaction.DragAndDropEvent} * @fires {@link ol.interaction.DragAndDropEvent}
* ol.interaction.DragAndDropEvent * ol.interaction.DragAndDropEvent
* @param {olx.interaction.DragAndDropOptions=} opt_options Options. * @param {olx.interaction.DragAndDropOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DragAndDrop = function(opt_options) { ol.interaction.DragAndDrop = function(opt_options) {
@@ -184,7 +183,7 @@ ol.interaction.DragAndDropEventType = {
/** /**
* Triggered when features are added * Triggered when features are added
* @event ol.interaction.DragAndDropEvent#addfeatures * @event ol.interaction.DragAndDropEvent#addfeatures
* @todo stability experimental * @todo api
*/ */
ADD_FEATURES: 'addfeatures' ADD_FEATURES: 'addfeatures'
}; };
@@ -208,19 +207,16 @@ ol.interaction.DragAndDropEvent =
/** /**
* @type {Array.<ol.Feature>|undefined} * @type {Array.<ol.Feature>|undefined}
* @todo stability experimental
*/ */
this.features = opt_features; this.features = opt_features;
/** /**
* @type {File} * @type {File}
* @todo stability experimental
*/ */
this.file = file; this.file = file;
/** /**
* @type {ol.proj.Projection|undefined} * @type {ol.proj.Projection|undefined}
* @todo stability experimental
*/ */
this.projection = opt_projection; this.projection = opt_projection;

View File

@@ -35,13 +35,13 @@ ol.DragBoxEventType = {
/** /**
* Triggered upon drag box start. * Triggered upon drag box start.
* @event ol.DragBoxEvent#boxstart * @event ol.DragBoxEvent#boxstart
* @todo stability experimental * @todo api
*/ */
BOXSTART: 'boxstart', BOXSTART: 'boxstart',
/** /**
* Triggered upon drag box end. * Triggered upon drag box end.
* @event ol.DragBoxEvent#boxstart * @event ol.DragBoxEvent#boxstart
* @todo stability experimental * @todo api
*/ */
BOXEND: 'boxend' BOXEND: 'boxend'
}; };
@@ -83,7 +83,6 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @fires {@link ol.DragBoxEvent} ol.DragBoxEvent * @fires {@link ol.DragBoxEvent} ol.DragBoxEvent
* @param {olx.interaction.DragBoxOptions=} opt_options Options. * @param {olx.interaction.DragBoxOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DragBox = function(opt_options) { ol.interaction.DragBox = function(opt_options) {
@@ -136,7 +135,6 @@ ol.interaction.DragBox.prototype.handlePointerDrag = function(mapBrowserEvent) {
/** /**
* Returns geometry of last drawn box. * Returns geometry of last drawn box.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DragBox.prototype.getGeometry = function() { ol.interaction.DragBox.prototype.getGeometry = function() {

View File

@@ -18,7 +18,6 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragPanOptions=} opt_options Options. * @param {olx.interaction.DragPanOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DragPan = function(opt_options) { ol.interaction.DragPan = function(opt_options) {

View File

@@ -31,7 +31,6 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400;
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options. * @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DragRotateAndZoom = function(opt_options) { ol.interaction.DragRotateAndZoom = function(opt_options) {

View File

@@ -25,7 +25,6 @@ ol.interaction.DRAGROTATE_ANIMATION_DURATION = 250;
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateOptions=} opt_options Options. * @param {olx.interaction.DragRotateOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DragRotate = function(opt_options) { ol.interaction.DragRotate = function(opt_options) {

View File

@@ -23,7 +23,6 @@ ol.interaction.DRAGZOOM_ANIMATION_DURATION = 200;
* @constructor * @constructor
* @extends {ol.interaction.DragBox} * @extends {ol.interaction.DragBox}
* @param {olx.interaction.DragZoomOptions=} opt_options Options. * @param {olx.interaction.DragZoomOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.DragZoom = function(opt_options) { ol.interaction.DragZoom = function(opt_options) {

View File

@@ -29,13 +29,13 @@ ol.DrawEventType = {
/** /**
* Triggered upon feature draw start * Triggered upon feature draw start
* @event ol.DrawEvent#drawstart * @event ol.DrawEvent#drawstart
* @todo stability experimental * @todo api
*/ */
DRAWSTART: 'drawstart', DRAWSTART: 'drawstart',
/** /**
* Triggered upon feature draw end * Triggered upon feature draw end
* @event ol.DrawEvent#drawend * @event ol.DrawEvent#drawend
* @todo stability experimental * @todo api
*/ */
DRAWEND: 'drawend' DRAWEND: 'drawend'
}; };
@@ -56,7 +56,6 @@ ol.DrawEvent = function(type, feature) {
/** /**
* The feature being drawn. * The feature being drawn.
* @type {ol.Feature} * @type {ol.Feature}
* @todo stability experimental
*/ */
this.feature = feature; this.feature = feature;
@@ -71,7 +70,6 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @fires {@link ol.DrawEvent} ol.DrawEvent * @fires {@link ol.DrawEvent} ol.DrawEvent
* @param {olx.interaction.DrawOptions} options Options. * @param {olx.interaction.DrawOptions} options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.Draw = function(options) { ol.interaction.Draw = function(options) {

View File

@@ -25,7 +25,6 @@ goog.require('ol.interaction.PinchZoom');
* @param {olx.interaction.DefaultsOptions=} opt_options Defaults options. * @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} A collection of interactions to be used with * @return {ol.Collection} A collection of interactions to be used with
* the ol.Map constructor's interactions option. * the ol.Map constructor's interactions option.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.defaults = function(opt_options) { ol.interaction.defaults = function(opt_options) {

View File

@@ -33,7 +33,6 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100;
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.KeyboardPanOptions=} opt_options Options. * @param {olx.interaction.KeyboardPanOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.KeyboardPan = function(opt_options) { ol.interaction.KeyboardPan = function(opt_options) {

View File

@@ -23,7 +23,6 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @param {olx.interaction.KeyboardZoomOptions=} opt_options Options. * @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.KeyboardZoom = function(opt_options) { ol.interaction.KeyboardZoom = function(opt_options) {

View File

@@ -40,7 +40,6 @@ ol.interaction.SegmentDataType;
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.ModifyOptions} options Options. * @param {olx.interaction.ModifyOptions} options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.Modify = function(options) { ol.interaction.Modify = function(options) {

View File

@@ -28,7 +28,6 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80;
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options. * @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.MouseWheelZoom = function(opt_options) { ol.interaction.MouseWheelZoom = function(opt_options) {

View File

@@ -23,7 +23,6 @@ ol.interaction.ROTATE_ANIMATION_DURATION = 250;
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.PinchRotateOptions=} opt_options Options. * @param {olx.interaction.PinchRotateOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.PinchRotate = function(opt_options) { ol.interaction.PinchRotate = function(opt_options) {

View File

@@ -17,7 +17,6 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.PinchZoomOptions=} opt_options Options. * @param {olx.interaction.PinchZoomOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.PinchZoom = function(opt_options) { ol.interaction.PinchZoom = function(opt_options) {

View File

@@ -18,7 +18,6 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.SelectOptions=} opt_options Options. * @param {olx.interaction.SelectOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.Select = function(opt_options) { ol.interaction.Select = function(opt_options) {
@@ -101,7 +100,6 @@ goog.inherits(ol.interaction.Select, ol.interaction.Interaction);
/** /**
* @return {ol.Collection} Features collection. * @return {ol.Collection} Features collection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.interaction.Select.prototype.getFeatures = function() { ol.interaction.Select.prototype.getFeatures = function() {

View File

@@ -8,7 +8,6 @@ goog.require('ol.IView3D');
/** /**
* Interface for views. Currently {@link ol.View2D} is implemented. * Interface for views. Currently {@link ol.View2D} is implemented.
* @interface * @interface
* @todo stability experimental
*/ */
ol.IView = function() { ol.IView = function() {
}; };

View File

@@ -14,7 +14,6 @@ ol.IView2D = function() {
/** /**
* @return {ol.Coordinate|undefined} Map center. * @return {ol.Coordinate|undefined} Map center.
* @todo stability experimental
*/ */
ol.IView2D.prototype.getCenter = function() { ol.IView2D.prototype.getCenter = function() {
}; };
@@ -22,7 +21,6 @@ ol.IView2D.prototype.getCenter = function() {
/** /**
* @return {ol.proj.Projection|undefined} Map projection. * @return {ol.proj.Projection|undefined} Map projection.
* @todo stability experimental
*/ */
ol.IView2D.prototype.getProjection = function() { ol.IView2D.prototype.getProjection = function() {
}; };
@@ -30,7 +28,6 @@ ol.IView2D.prototype.getProjection = function() {
/** /**
* @return {number|undefined} Map resolution. * @return {number|undefined} Map resolution.
* @todo stability experimental
*/ */
ol.IView2D.prototype.getResolution = function() { ol.IView2D.prototype.getResolution = function() {
}; };
@@ -38,7 +35,6 @@ ol.IView2D.prototype.getResolution = function() {
/** /**
* @return {number|undefined} Map rotation. * @return {number|undefined} Map rotation.
* @todo stability experimental
*/ */
ol.IView2D.prototype.getRotation = function() { ol.IView2D.prototype.getRotation = function() {
}; };

View File

@@ -13,7 +13,6 @@ goog.require('ol.animation');
* @param {number} delay Delay to consider to calculate the kinetic * @param {number} delay Delay to consider to calculate the kinetic
* initial values (milliseconds). * initial values (milliseconds).
* @struct * @struct
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Kinetic = function(decay, minVelocity, delay) { ol.Kinetic = function(decay, minVelocity, delay) {

View File

@@ -25,7 +25,6 @@ ol.layer.HeatmapLayerProperty = {
* @extends {ol.layer.Vector} * @extends {ol.layer.Vector}
* @fires {@link ol.render.Event} ol.render.Event * @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.HeatmapOptions=} opt_options Options. * @param {olx.layer.HeatmapOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Heatmap = function(opt_options) { ol.layer.Heatmap = function(opt_options) {

View File

@@ -9,7 +9,6 @@ goog.require('ol.layer.Layer');
* @extends {ol.layer.Layer} * @extends {ol.layer.Layer}
* @fires {@link ol.render.Event} ol.render.Event * @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.LayerOptions} options Layer options. * @param {olx.layer.LayerOptions} options Layer options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Image = function(options) { ol.layer.Image = function(options) {

View File

@@ -22,7 +22,6 @@ goog.require('ol.source.Source');
* @todo observable visible {boolean} the visiblity of the layer * @todo observable visible {boolean} the visiblity of the layer
* @todo observable maxResolution {number} the maximum resolution of the layer * @todo observable maxResolution {number} the maximum resolution of the layer
* @todo observable minResolution {number} the minimum resolution of the layer * @todo observable minResolution {number} the minimum resolution of the layer
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Layer = function(options) { ol.layer.Layer = function(options) {
@@ -67,7 +66,6 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) {
/** /**
* @return {ol.source.Source} Source. * @return {ol.source.Source} Source.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Layer.prototype.getSource = function() { ol.layer.Layer.prototype.getSource = function() {

View File

@@ -79,7 +79,7 @@ goog.inherits(ol.layer.Base, ol.Object);
/** /**
* @return {number|undefined} Brightness. * @return {number|undefined} Brightness.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getBrightness = function() { ol.layer.Base.prototype.getBrightness = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -93,7 +93,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} Contrast. * @return {number|undefined} Contrast.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getContrast = function() { ol.layer.Base.prototype.getContrast = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -107,7 +107,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} Hue. * @return {number|undefined} Hue.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getHue = function() { ol.layer.Base.prototype.getHue = function() {
return /** @type {number|undefined} */ (this.get(ol.layer.LayerProperty.HUE)); 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. * @return {number|undefined} MaxResolution.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getMaxResolution = function() { ol.layer.Base.prototype.getMaxResolution = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -178,7 +178,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} MinResolution. * @return {number|undefined} MinResolution.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getMinResolution = function() { ol.layer.Base.prototype.getMinResolution = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -192,7 +192,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} Opacity. * @return {number|undefined} Opacity.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getOpacity = function() { ol.layer.Base.prototype.getOpacity = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -206,7 +206,7 @@ goog.exportProperty(
/** /**
* @return {number|undefined} Saturation. * @return {number|undefined} Saturation.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getSaturation = function() { ol.layer.Base.prototype.getSaturation = function() {
return /** @type {number|undefined} */ ( return /** @type {number|undefined} */ (
@@ -226,7 +226,7 @@ ol.layer.Base.prototype.getSourceState = goog.abstractMethod;
/** /**
* @return {boolean|undefined} Visible. * @return {boolean|undefined} Visible.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.getVisible = function() { ol.layer.Base.prototype.getVisible = function() {
return /** @type {boolean|undefined} */ ( return /** @type {boolean|undefined} */ (
@@ -257,7 +257,7 @@ goog.exportProperty(
* [3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647 * [3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
* *
* @param {number|undefined} brightness Brightness. * @param {number|undefined} brightness Brightness.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setBrightness = function(brightness) { ol.layer.Base.prototype.setBrightness = function(brightness) {
this.set(ol.layer.LayerProperty.BRIGHTNESS, 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). * linear multipliers on the effect (and values over 1 are permitted).
* *
* @param {number|undefined} contrast Contrast. * @param {number|undefined} contrast Contrast.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setContrast = function(contrast) { ol.layer.Base.prototype.setContrast = function(contrast) {
this.set(ol.layer.LayerProperty.CONTRAST, 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 * Apply a hue-rotation to the layer. A value of 0 will leave the hue
* unchanged. Other values are radians around the color circle. * unchanged. Other values are radians around the color circle.
* @param {number|undefined} hue Hue. * @param {number|undefined} hue Hue.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setHue = function(hue) { ol.layer.Base.prototype.setHue = function(hue) {
this.set(ol.layer.LayerProperty.HUE, hue); this.set(ol.layer.LayerProperty.HUE, hue);
@@ -302,7 +302,7 @@ goog.exportProperty(
/** /**
* @param {number|undefined} maxResolution MaxResolution. * @param {number|undefined} maxResolution MaxResolution.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setMaxResolution = function(maxResolution) { ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution); this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution);
@@ -315,7 +315,7 @@ goog.exportProperty(
/** /**
* @param {number|undefined} minResolution MinResolution. * @param {number|undefined} minResolution MinResolution.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setMinResolution = function(minResolution) { ol.layer.Base.prototype.setMinResolution = function(minResolution) {
this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution); this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution);
@@ -328,7 +328,7 @@ goog.exportProperty(
/** /**
* @param {number|undefined} opacity Opacity. * @param {number|undefined} opacity Opacity.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setOpacity = function(opacity) { ol.layer.Base.prototype.setOpacity = function(opacity) {
this.set(ol.layer.LayerProperty.OPACITY, opacity); this.set(ol.layer.LayerProperty.OPACITY, opacity);
@@ -346,7 +346,7 @@ goog.exportProperty(
* permitted). * permitted).
* *
* @param {number|undefined} saturation Saturation. * @param {number|undefined} saturation Saturation.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setSaturation = function(saturation) { ol.layer.Base.prototype.setSaturation = function(saturation) {
this.set(ol.layer.LayerProperty.SATURATION, saturation); this.set(ol.layer.LayerProperty.SATURATION, saturation);
@@ -359,7 +359,7 @@ goog.exportProperty(
/** /**
* @param {boolean|undefined} visible Visible. * @param {boolean|undefined} visible Visible.
* @todo stability experimental * @todo api
*/ */
ol.layer.Base.prototype.setVisible = function(visible) { ol.layer.Base.prototype.setVisible = function(visible) {
this.set(ol.layer.LayerProperty.VISIBLE, visible); this.set(ol.layer.LayerProperty.VISIBLE, visible);

View File

@@ -30,7 +30,6 @@ ol.layer.GroupProperty = {
* @param {olx.layer.GroupOptions=} opt_options Layer options. * @param {olx.layer.GroupOptions=} opt_options Layer options.
* @todo observable layers {ol.Collection} collection of {@link ol.layer} layers * @todo observable layers {ol.Collection} collection of {@link ol.layer} layers
* that are part of this group * that are part of this group
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Group = function(opt_options) { ol.layer.Group = function(opt_options) {
@@ -144,7 +143,6 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) {
/** /**
* @return {ol.Collection|undefined} Collection of layers. * @return {ol.Collection|undefined} Collection of layers.
* @todo stability experimental
*/ */
ol.layer.Group.prototype.getLayers = function() { ol.layer.Group.prototype.getLayers = function() {
return /** @type {ol.Collection|undefined} */ (this.get( return /** @type {ol.Collection|undefined} */ (this.get(
@@ -158,7 +156,6 @@ goog.exportProperty(
/** /**
* @param {ol.Collection|undefined} layers Collection of layers. * @param {ol.Collection|undefined} layers Collection of layers.
* @todo stability experimental
*/ */
ol.layer.Group.prototype.setLayers = function(layers) { ol.layer.Group.prototype.setLayers = function(layers) {
this.set(ol.layer.GroupProperty.LAYERS, layers); this.set(ol.layer.GroupProperty.LAYERS, layers);

View File

@@ -19,7 +19,6 @@ ol.layer.TileProperty = {
* @fires {@link ol.render.Event} ol.render.Event * @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.TileOptions} options Tile layer options. * @param {olx.layer.TileOptions} options Tile layer options.
* @todo observable preload {number} the level to preload tiles up to * @todo observable preload {number} the level to preload tiles up to
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Tile = function(options) { ol.layer.Tile = function(options) {

View File

@@ -21,7 +21,6 @@ ol.layer.VectorProperty = {
* @extends {ol.layer.Layer} * @extends {ol.layer.Layer}
* @fires {@link ol.render.Event} ol.render.Event * @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.VectorOptions=} opt_options Options. * @param {olx.layer.VectorOptions=} opt_options Options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Vector = function(opt_options) { ol.layer.Vector = function(opt_options) {
@@ -71,7 +70,6 @@ ol.layer.Vector.prototype.getRenderOrder = function() {
* option at construction or to the `setStyle` method. * option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} * @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Layer style. * Layer style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Vector.prototype.getStyle = function() { ol.layer.Vector.prototype.getStyle = function() {
@@ -82,7 +80,6 @@ ol.layer.Vector.prototype.getStyle = function() {
/** /**
* Get the style function. * Get the style function.
* @return {ol.feature.StyleFunction|undefined} Layer style function. * @return {ol.feature.StyleFunction|undefined} Layer style function.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Vector.prototype.getStyleFunction = function() { ol.layer.Vector.prototype.getStyleFunction = function() {
@@ -105,7 +102,6 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {
* an array of styles. * an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style * @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Layer style. * Layer style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.layer.Vector.prototype.setStyle = function(style) { ol.layer.Vector.prototype.setStyle = function(style) {

View File

@@ -7,7 +7,6 @@ goog.require('ol.TileCoord');
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {number} resolution Resolution. * @param {number} resolution Resolution.
* @return {Array.<ol.Extent>} Extents. * @return {Array.<ol.Extent>} Extents.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.loadingstrategy.all = function(extent, resolution) { ol.loadingstrategy.all = function(extent, resolution) {
@@ -19,7 +18,6 @@ ol.loadingstrategy.all = function(extent, resolution) {
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {number} resolution Resolution. * @param {number} resolution Resolution.
* @return {Array.<ol.Extent>} Extents. * @return {Array.<ol.Extent>} Extents.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.loadingstrategy.bbox = function(extent, resolution) { ol.loadingstrategy.bbox = function(extent, resolution) {
@@ -30,7 +28,6 @@ ol.loadingstrategy.bbox = function(extent, resolution) {
/** /**
* @param {ol.tilegrid.TileGrid} tileGrid Tile grid. * @param {ol.tilegrid.TileGrid} tileGrid Tile grid.
* @return {function(ol.Extent, number): Array.<ol.Extent>} Loading strategy. * @return {function(ol.Extent, number): Array.<ol.Extent>} Loading strategy.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.loadingstrategy.createTile = function(tileGrid) { ol.loadingstrategy.createTile = function(tileGrid) {

View File

@@ -99,8 +99,9 @@ ol.OL3_LOGO_URL = 'data:image/png;base64,' +
/** /**
* Available renderers: `'canvas'`, `'dom'` or `'webgl'`.
* @enum {string} * @enum {string}
* @todo stability experimental * @todo api
*/ */
ol.RendererHint = { ol.RendererHint = {
CANVAS: 'canvas', CANVAS: 'canvas',
@@ -164,7 +165,6 @@ ol.MapProperty = {
* @todo observable target {string|Element} the Element or id of the Element * @todo observable target {string|Element} the Element or id of the Element
* that the map is rendered in. * that the map is rendered in.
* @todo observable view {ol.IView} the view that controls this map * @todo observable view {ol.IView} the view that controls this map
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map = function(options) { ol.Map = function(options) {
@@ -466,7 +466,6 @@ goog.inherits(ol.Map, ol.Object);
/** /**
* Add the given control to the map. * Add the given control to the map.
* @param {ol.control.Control} control Control. * @param {ol.control.Control} control Control.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.addControl = function(control) { 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. * Adds the given layer to the top of this map.
* @param {ol.layer.Base} layer Layer. * @param {ol.layer.Base} layer Layer.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.addLayer = function(layer) { ol.Map.prototype.addLayer = function(layer) {
@@ -504,7 +502,6 @@ ol.Map.prototype.addLayer = function(layer) {
/** /**
* Add the given overlay to the map. * Add the given overlay to the map.
* @param {ol.Overlay} overlay Overlay. * @param {ol.Overlay} overlay Overlay.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.addOverlay = function(overlay) { 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} * animations before updating the map's view. The {@link ol.animation}
* namespace provides several static methods for creating prerender functions. * namespace provides several static methods for creating prerender functions.
* @param {...ol.PreRenderFunction} var_args Any number of pre-render functions. * @param {...ol.PreRenderFunction} var_args Any number of pre-render functions.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.beforeRender = function(var_args) { ol.Map.prototype.beforeRender = function(var_args) {
@@ -581,7 +577,6 @@ ol.Map.prototype.forEachFeatureAtPixel =
* Returns the geographical coordinate for a browser event. * Returns the geographical coordinate for a browser event.
* @param {Event} event Event. * @param {Event} event Event.
* @return {ol.Coordinate} Coordinate. * @return {ol.Coordinate} Coordinate.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.getEventCoordinate = function(event) { 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. * Returns the map pixel position for a browser event.
* @param {Event} event Event. * @param {Event} event Event.
* @return {ol.Pixel} Pixel. * @return {ol.Pixel} Pixel.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.getEventPixel = function(event) { 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: * 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. * if that was an element, it returns an element; if a string, it returns that.
* @return {Element|string|undefined} Target. * @return {Element|string|undefined} Target.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.getTarget = function() { ol.Map.prototype.getTarget = function() {
return /** @type {Element|string|undefined} */ ( return /** @type {Element|string|undefined} */ (
@@ -651,7 +645,6 @@ ol.Map.prototype.getCoordinateFromPixel = function(pixel) {
/** /**
* @return {ol.Collection} Controls. * @return {ol.Collection} Controls.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.getControls = function() { ol.Map.prototype.getControls = function() {
@@ -661,7 +654,6 @@ ol.Map.prototype.getControls = function() {
/** /**
* @return {ol.Collection} Overlays. * @return {ol.Collection} Overlays.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.getOverlays = function() { ol.Map.prototype.getOverlays = function() {
@@ -677,7 +669,6 @@ ol.Map.prototype.getOverlays = function() {
* *
* Interactions are used for e.g. pan, zoom and rotate. * Interactions are used for e.g. pan, zoom and rotate.
* @return {ol.Collection} Interactions. * @return {ol.Collection} Interactions.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.getInteractions = function() { ol.Map.prototype.getInteractions = function() {
@@ -688,7 +679,7 @@ ol.Map.prototype.getInteractions = function() {
/** /**
* Get the layergroup associated with this map. * Get the layergroup associated with this map.
* @return {ol.layer.Group} LayerGroup. * @return {ol.layer.Group} LayerGroup.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.getLayerGroup = function() { ol.Map.prototype.getLayerGroup = function() {
return /** @type {ol.layer.Group} */ ( return /** @type {ol.layer.Group} */ (
@@ -703,7 +694,6 @@ goog.exportProperty(
/** /**
* Get the collection of layers associated with this map. * Get the collection of layers associated with this map.
* @return {ol.Collection|undefined} Layers. * @return {ol.Collection|undefined} Layers.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.getLayers = function() { ol.Map.prototype.getLayers = function() {
@@ -735,7 +725,7 @@ ol.Map.prototype.getPixelFromCoordinate = function(coordinate) {
/** /**
* Get the size of this map. * Get the size of this map.
* @return {ol.Size|undefined} Size. * @return {ol.Size|undefined} Size.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.getSize = function() { ol.Map.prototype.getSize = function() {
return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE)); 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 * 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. * view manages properties such as center and resolution.
* @return {ol.View|undefined} View. * @return {ol.View|undefined} View.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.getView = function() { ol.Map.prototype.getView = function() {
return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW)); return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW));
@@ -763,7 +753,6 @@ goog.exportProperty(
/** /**
* @return {Element} Viewport. * @return {Element} Viewport.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.getViewport = function() { ol.Map.prototype.getViewport = function() {
@@ -1097,7 +1086,6 @@ ol.Map.prototype.render = function() {
* @param {ol.control.Control} control Control. * @param {ol.control.Control} control Control.
* @return {ol.control.Control|undefined} The removed control of undefined * @return {ol.control.Control|undefined} The removed control of undefined
* if the control was not found. * if the control was not found.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.removeControl = function(control) { ol.Map.prototype.removeControl = function(control) {
@@ -1133,7 +1121,6 @@ ol.Map.prototype.removeInteraction = function(interaction) {
* @param {ol.layer.Base} layer Layer. * @param {ol.layer.Base} layer Layer.
* @return {ol.layer.Base|undefined} The removed layer or undefined if the * @return {ol.layer.Base|undefined} The removed layer or undefined if the
* layer was not found. * layer was not found.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.removeLayer = function(layer) { ol.Map.prototype.removeLayer = function(layer) {
@@ -1148,7 +1135,6 @@ ol.Map.prototype.removeLayer = function(layer) {
* @param {ol.Overlay} overlay Overlay. * @param {ol.Overlay} overlay Overlay.
* @return {ol.Overlay|undefined} The removed overlay of undefined * @return {ol.Overlay|undefined} The removed overlay of undefined
* if the overlay was not found. * if the overlay was not found.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.removeOverlay = function(overlay) { ol.Map.prototype.removeOverlay = function(overlay) {
@@ -1271,7 +1257,7 @@ ol.Map.prototype.renderFrame_ = function(time) {
/** /**
* Sets the layergroup of this map. * Sets the layergroup of this map.
* @param {ol.layer.Group} layerGroup Layergroup. * @param {ol.layer.Group} layerGroup Layergroup.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.setLayerGroup = function(layerGroup) { ol.Map.prototype.setLayerGroup = function(layerGroup) {
this.set(ol.MapProperty.LAYERGROUP, layerGroup); this.set(ol.MapProperty.LAYERGROUP, layerGroup);
@@ -1285,7 +1271,7 @@ goog.exportProperty(
/** /**
* Set the size of this map. * Set the size of this map.
* @param {ol.Size|undefined} size Size. * @param {ol.Size|undefined} size Size.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.setSize = function(size) { ol.Map.prototype.setSize = function(size) {
this.set(ol.MapProperty.SIZE, size); this.set(ol.MapProperty.SIZE, size);
@@ -1299,7 +1285,7 @@ goog.exportProperty(
/** /**
* Set the target element to render this map into. * Set the target element to render this map into.
* @param {Element|string|undefined} target Target. * @param {Element|string|undefined} target Target.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.setTarget = function(target) { ol.Map.prototype.setTarget = function(target) {
this.set(ol.MapProperty.TARGET, 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. * @param {ol.IView} view View.
* @todo stability experimental * @todo api
*/ */
ol.Map.prototype.setView = function(view) { ol.Map.prototype.setView = function(view) {
this.set(ol.MapProperty.VIEW, 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 * Force a recalculation of the map viewport size. This should be called when
* third-party code changes the size of the map viewport. * third-party code changes the size of the map viewport.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Map.prototype.updateSize = function() { ol.Map.prototype.updateSize = function() {

View File

@@ -40,19 +40,16 @@ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) {
/** /**
* @const * @const
* @type {Event} * @type {Event}
* @todo stability experimental
*/ */
this.originalEvent = browserEvent.getBrowserEvent(); this.originalEvent = browserEvent.getBrowserEvent();
/** /**
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo stability experimental
*/ */
this.coordinate = map.getEventCoordinate(this.originalEvent); this.coordinate = map.getEventCoordinate(this.originalEvent);
/** /**
* @type {ol.Pixel} * @type {ol.Pixel}
* @todo stability experimental
*/ */
this.pixel = map.getEventPixel(this.originalEvent); this.pixel = map.getEventPixel(this.originalEvent);
@@ -64,7 +61,6 @@ goog.inherits(ol.MapBrowserEvent, ol.MapEvent);
* Prevents the default browser action. * Prevents the default browser action.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault * @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault
* @override * @override
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.MapBrowserEvent.prototype.preventDefault = function() { ol.MapBrowserEvent.prototype.preventDefault = function() {
@@ -77,7 +73,6 @@ ol.MapBrowserEvent.prototype.preventDefault = function() {
* Prevents further propagation of the current event. * Prevents further propagation of the current event.
* @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation * @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation
* @override * @override
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.MapBrowserEvent.prototype.stopPropagation = function() { 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 * 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 is delayed by 250 ms to ensure that it is not a double click.
* @event ol.MapBrowserEvent#singleclick * @event ol.MapBrowserEvent#singleclick
* @todo stability experimental * @todo api
*/ */
SINGLECLICK: 'singleclick', SINGLECLICK: 'singleclick',
/** /**
* A click with no dragging. A double click will fire two of this. * A click with no dragging. A double click will fire two of this.
* @event ol.MapBrowserEvent#click * @event ol.MapBrowserEvent#click
* @todo stability experimental * @todo api
*/ */
CLICK: goog.events.EventType.CLICK, CLICK: goog.events.EventType.CLICK,
/** /**
* A true double click, with no dragging. * A true double click, with no dragging.
* @event ol.MapBrowserEvent#dblclick * @event ol.MapBrowserEvent#dblclick
* @todo stability experimental * @todo api
*/ */
DBLCLICK: goog.events.EventType.DBLCLICK, DBLCLICK: goog.events.EventType.DBLCLICK,
/** /**
* Triggered when a pointer is dragged. * Triggered when a pointer is dragged.
* @event ol.MapBrowserEvent#pointerdrag * @event ol.MapBrowserEvent#pointerdrag
* @todo stability experimental * @todo api
*/ */
POINTERDRAG: 'pointerdrag', POINTERDRAG: 'pointerdrag',
@@ -497,7 +492,7 @@ ol.MapBrowserEvent.EventType = {
/** /**
* Triggered when a pointer is moved. * Triggered when a pointer is moved.
* @event ol.MapBrowserEvent#pointermove * @event ol.MapBrowserEvent#pointermove
* @todo stability experimental * @todo api
*/ */
POINTERMOVE: 'pointermove', POINTERMOVE: 'pointermove',
POINTERDOWN: 'pointerdown', POINTERDOWN: 'pointerdown',

View File

@@ -11,13 +11,13 @@ ol.MapEventType = {
/** /**
* Triggered after a map frame is rendered. * Triggered after a map frame is rendered.
* @event ol.MapEvent#postrender * @event ol.MapEvent#postrender
* @todo stability experimental * @todo api
*/ */
POSTRENDER: 'postrender', POSTRENDER: 'postrender',
/** /**
* Triggered after the map is moved. * Triggered after the map is moved.
* @event ol.MapEvent#moveend * @event ol.MapEvent#moveend
* @todo stability experimental * @todo api
*/ */
MOVEEND: 'moveend' MOVEEND: 'moveend'
}; };

View File

@@ -23,13 +23,13 @@ ol.ObjectEventType = {
/** /**
* Triggered before a property is changed. * Triggered before a property is changed.
* @event ol.ObjectEvent#beforepropertychange * @event ol.ObjectEvent#beforepropertychange
* @todo stability experimental * @todo api
*/ */
BEFOREPROPERTYCHANGE: 'beforepropertychange', BEFOREPROPERTYCHANGE: 'beforepropertychange',
/** /**
* Triggered when a property is changed. * Triggered when a property is changed.
* @event ol.ObjectEvent#propertychange * @event ol.ObjectEvent#propertychange
* @todo stability experimental * @todo api
*/ */
PROPERTYCHANGE: 'propertychange' PROPERTYCHANGE: 'propertychange'
}; };
@@ -63,7 +63,6 @@ goog.inherits(ol.ObjectEvent, goog.events.Event);
* @constructor * @constructor
* @param {ol.Object} target * @param {ol.Object} target
* @param {string} key * @param {string} key
* @todo stability experimental
*/ */
ol.ObjectAccessor = function(target, key) { ol.ObjectAccessor = function(target, key) {
@@ -110,7 +109,6 @@ ol.ObjectAccessor.prototype.transform = function(from, to) {
* @extends {ol.Observable} * @extends {ol.Observable}
* @param {Object.<string, *>=} opt_values Values. * @param {Object.<string, *>=} opt_values Values.
* @fires {@link ol.ObjectEvent} ol.ObjectEvent * @fires {@link ol.ObjectEvent} ol.ObjectEvent
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object = function(opt_values) { ol.Object = function(opt_values) {
@@ -244,7 +242,6 @@ ol.Object.getSetterName = function(key) {
* @param {ol.Object} target Target. * @param {ol.Object} target Target.
* @param {string=} opt_targetKey Target key. * @param {string=} opt_targetKey Target key.
* @return {ol.ObjectAccessor} * @return {ol.ObjectAccessor}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.bindTo = function(key, target, opt_targetKey) { ol.Object.prototype.bindTo = function(key, target, opt_targetKey) {
@@ -302,7 +299,6 @@ ol.Object.prototype.createBeforeChangeListener_ = function(key, targetKey) {
* Gets a value. * Gets a value.
* @param {string} key Key name. * @param {string} key Key name.
* @return {*} Value. * @return {*} Value.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.get = function(key) { ol.Object.prototype.get = function(key) {
@@ -363,7 +359,6 @@ ol.Object.prototype.getKeys = function() {
/** /**
* Get an object of all property names and values. * Get an object of all property names and values.
* @return {Object.<string, *>} Object. * @return {Object.<string, *>} Object.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.getProperties = function() { 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 * objects that are bound to the object's property as well as the object
* that it is bound to. * that it is bound to.
* @param {string} key Key name. * @param {string} key Key name.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.notify = function(key) { ol.Object.prototype.notify = function(key) {
@@ -416,7 +410,6 @@ ol.Object.prototype.notifyInternal_ = function(key) {
* Sets a value. * Sets a value.
* @param {string} key Key name. * @param {string} key Key name.
* @param {*} value Value. * @param {*} value Value.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.set = function(key, value) { 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. * Sets a collection of key-value pairs.
* @param {Object.<string, *>} values Values. * @param {Object.<string, *>} values Values.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.setValues = function(values) { 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 * 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. * value. The object will not be notified, as the value has not changed.
* @param {string} key Key name. * @param {string} key Key name.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.unbind = function(key) { ol.Object.prototype.unbind = function(key) {
@@ -486,7 +477,6 @@ ol.Object.prototype.unbind = function(key) {
/** /**
* Removes all bindings. * Removes all bindings.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Object.prototype.unbindAll = function() { ol.Object.prototype.unbindAll = function() {

View File

@@ -14,7 +14,6 @@ goog.require('goog.events.EventType');
* @extends {goog.events.EventTarget} * @extends {goog.events.EventTarget}
* @suppress {checkStructDictInheritance} * @suppress {checkStructDictInheritance}
* @struct * @struct
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Observable = function() { 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 * Dispatches a `change` event. Register a listener for this event to get
* notified of changes. * notified of changes.
* @fires change * @fires change
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Observable.prototype.dispatchChangeEvent = function() { ol.Observable.prototype.dispatchChangeEvent = function() {
@@ -58,7 +56,6 @@ ol.Observable.prototype.getRevision = function() {
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener. * @return {goog.events.Key} Unique key for the listener.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Observable.prototype.on = function(type, listener, opt_this) { 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 {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener. * @return {goog.events.Key} Unique key for the listener.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Observable.prototype.once = function(type, listener, opt_this) { 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.<string>} type The event type or array of event types. * @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Observable.prototype.un = function(type, listener, opt_this) { 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()`. * Removes an event listener using the key returned by `on()` or `once()`.
* @param {goog.events.Key} key Key. * @param {goog.events.Key} key Key.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.Observable.prototype.unByKey = function(key) { ol.Observable.prototype.unByKey = function(key) {

View File

@@ -9,7 +9,6 @@ goog.provide('ol');
* linter complains with: * linter complains with:
* *
* "Missing newline between constructor and goog.inherits" * "Missing newline between constructor and goog.inherits"
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.inherits = ol.inherits =

View File

@@ -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} * @enum {string}
* @todo stability experimental * @todo api
*/ */
ol.OverlayPositioning = { ol.OverlayPositioning = {
BOTTOM_LEFT: 'bottom-left', BOTTOM_LEFT: 'bottom-left',
@@ -62,8 +65,7 @@ ol.OverlayPositioning = {
* is anchored at * is anchored at
* @todo observable positioning {ol.OverlayPositioning} how the overlay is * @todo observable positioning {ol.OverlayPositioning} how the overlay is
* positioned relative to its point on the map * positioned relative to its point on the map
* @todo stability stable * @todo api stable
* @todo api
*/ */
ol.Overlay = function(options) { ol.Overlay = function(options) {
@@ -158,7 +160,7 @@ goog.inherits(ol.Overlay, ol.Object);
/** /**
* Get the DOM element of this overlay. * Get the DOM element of this overlay.
* @return {Element|undefined} Element. * @return {Element|undefined} Element.
* @todo stability experimental * @todo api
*/ */
ol.Overlay.prototype.getElement = function() { ol.Overlay.prototype.getElement = function() {
return /** @type {Element|undefined} */ ( return /** @type {Element|undefined} */ (
@@ -173,7 +175,7 @@ goog.exportProperty(
/** /**
* Get the map associated with this overlay. * Get the map associated with this overlay.
* @return {ol.Map|undefined} Map. * @return {ol.Map|undefined} Map.
* @todo stability experimental * @todo api
*/ */
ol.Overlay.prototype.getMap = function() { ol.Overlay.prototype.getMap = function() {
return /** @type {ol.Map|undefined} */ ( return /** @type {ol.Map|undefined} */ (
@@ -188,7 +190,7 @@ goog.exportProperty(
/** /**
* Get the current position of this overlay. * Get the current position of this overlay.
* @return {ol.Coordinate|undefined} Position. * @return {ol.Coordinate|undefined} Position.
* @todo stability experimental * @todo api
*/ */
ol.Overlay.prototype.getPosition = function() { ol.Overlay.prototype.getPosition = function() {
return /** @type {ol.Coordinate|undefined} */ ( return /** @type {ol.Coordinate|undefined} */ (
@@ -203,7 +205,7 @@ goog.exportProperty(
/** /**
* Get the current positioning of this overlay. * Get the current positioning of this overlay.
* @return {ol.OverlayPositioning|undefined} Positioning. * @return {ol.OverlayPositioning|undefined} Positioning.
* @todo stability experimental * @todo api
*/ */
ol.Overlay.prototype.getPositioning = function() { ol.Overlay.prototype.getPositioning = function() {
return /** @type {ol.OverlayPositioning|undefined} */ ( return /** @type {ol.OverlayPositioning|undefined} */ (
@@ -280,7 +282,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() {
/** /**
* Set the DOM element to be associated with this overlay. * Set the DOM element to be associated with this overlay.
* @param {Element|undefined} element Element. * @param {Element|undefined} element Element.
* @todo stability experimental * @todo api
*/ */
ol.Overlay.prototype.setElement = function(element) { ol.Overlay.prototype.setElement = function(element) {
this.set(ol.OverlayProperty.ELEMENT, element); this.set(ol.OverlayProperty.ELEMENT, element);
@@ -294,7 +296,7 @@ goog.exportProperty(
/** /**
* Set the map to be associated with this overlay. * Set the map to be associated with this overlay.
* @param {ol.Map|undefined} map Map. * @param {ol.Map|undefined} map Map.
* @todo stability experimental * @todo api
*/ */
ol.Overlay.prototype.setMap = function(map) { ol.Overlay.prototype.setMap = function(map) {
this.set(ol.OverlayProperty.MAP, map); this.set(ol.OverlayProperty.MAP, map);
@@ -308,7 +310,7 @@ goog.exportProperty(
/** /**
* Set the position for this overlay. * Set the position for this overlay.
* @param {ol.Coordinate|undefined} position Position. * @param {ol.Coordinate|undefined} position Position.
* @todo stability stable * @todo api stable
*/ */
ol.Overlay.prototype.setPosition = function(position) { ol.Overlay.prototype.setPosition = function(position) {
this.set(ol.OverlayProperty.POSITION, position); this.set(ol.OverlayProperty.POSITION, position);
@@ -322,7 +324,7 @@ goog.exportProperty(
/** /**
* Set the positioning for this overlay. * Set the positioning for this overlay.
* @param {ol.OverlayPositioning|undefined} positioning Positioning. * @param {ol.OverlayPositioning|undefined} positioning Positioning.
* @todo stability experimental * @todo api
*/ */
ol.Overlay.prototype.setPositioning = function(positioning) { ol.Overlay.prototype.setPositioning = function(positioning) {
this.set(ol.OverlayProperty.POSITIONING, positioning); this.set(ol.OverlayProperty.POSITIONING, positioning);

View File

@@ -7,7 +7,6 @@ goog.require('ol.proj.EPSG4326');
/** /**
* FIXME empty description for jsdoc * FIXME empty description for jsdoc
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.common.add = function() { ol.proj.common.add = function() {

View File

@@ -30,14 +30,15 @@ ol.HAVE_PROJ4JS = ol.ENABLE_PROJ4JS && typeof Proj4js == 'object';
* A projection as {@link ol.proj.Projection}, SRS identifier string or * A projection as {@link ol.proj.Projection}, SRS identifier string or
* undefined. * undefined.
* @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike * @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike
* @todo stability experimental * @todo api
*/ */
ol.proj.ProjectionLike; ol.proj.ProjectionLike;
/** /**
* Projection units: `'degrees'`, `'ft'`, `'m'` or `'pixels'`.
* @enum {string} * @enum {string}
* @todo stability experimental * @todo api
*/ */
ol.proj.Units = { ol.proj.Units = {
DEGREES: 'degrees', DEGREES: 'degrees',
@@ -51,7 +52,6 @@ ol.proj.Units = {
* Meters per unit lookup table. * Meters per unit lookup table.
* @const * @const
* @type {Object.<ol.proj.Units, number>} * @type {Object.<ol.proj.Units, number>}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.METERS_PER_UNIT[ol.proj.Units.DEGREES] = ol.proj.METERS_PER_UNIT[ol.proj.Units.DEGREES] =
@@ -65,7 +65,6 @@ ol.proj.METERS_PER_UNIT[ol.proj.Units.METERS] = 1;
* @constructor * @constructor
* @param {olx.ProjectionOptions} options Projection options. * @param {olx.ProjectionOptions} options Projection options.
* @struct * @struct
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.Projection = function(options) { ol.proj.Projection = function(options) {
@@ -113,7 +112,6 @@ ol.proj.Projection = function(options) {
/** /**
* Get the code for this projection, e.g. 'EPSG:4326'. * Get the code for this projection, e.g. 'EPSG:4326'.
* @return {string} Code. * @return {string} Code.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.Projection.prototype.getCode = function() { ol.proj.Projection.prototype.getCode = function() {
@@ -124,7 +122,6 @@ ol.proj.Projection.prototype.getCode = function() {
/** /**
* Get the validity extent for this projection. * Get the validity extent for this projection.
* @return {ol.Extent} Extent. * @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.Projection.prototype.getExtent = function() { ol.proj.Projection.prototype.getExtent = function() {
@@ -148,7 +145,6 @@ ol.proj.Projection.prototype.getPointResolution = goog.abstractMethod;
/** /**
* Get the units of this projection. * Get the units of this projection.
* @return {ol.proj.Units} Units. * @return {ol.proj.Units} Units.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.Projection.prototype.getUnits = function() { ol.proj.Projection.prototype.getUnits = function() {
@@ -380,7 +376,6 @@ ol.proj.addProj4jsProjection_ = function(proj4jsProjection) {
/** /**
* @param {ol.proj.Projection} projection Projection. * @param {ol.proj.Projection} projection Projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.addProjection = function(projection) { 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 * a combination of authority and identifier such as "EPSG:4326", or an
* existing projection object, or undefined. * existing projection object, or undefined.
* @return {ol.proj.Projection} Projection. * @return {ol.proj.Projection} Projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.get = function(projectionLike) { 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} source Source.
* @param {ol.proj.ProjectionLike} destination Destination. * @param {ol.proj.ProjectionLike} destination Destination.
* @return {ol.TransformFunction} Transform. * @return {ol.TransformFunction} Transform.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.getTransform = function(source, destination) { 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} sourceProjection Source projection.
* @param {ol.proj.Projection} destinationProjection Destination projection. * @param {ol.proj.Projection} destinationProjection Destination projection.
* @return {ol.TransformFunction} Transform. * @return {ol.TransformFunction} Transform.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.getTransformFromProjections = 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} source Source.
* @param {ol.proj.ProjectionLike} destination Destination. * @param {ol.proj.ProjectionLike} destination Destination.
* @return {ol.Coordinate} Point. * @return {ol.Coordinate} Point.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.transform = function(point, source, destination) { 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} sourceProjection Source projection.
* @param {ol.proj.Projection} destinationProjection Destination projection. * @param {ol.proj.Projection} destinationProjection Destination projection.
* @return {ol.Coordinate} Point. * @return {ol.Coordinate} Point.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.transformWithProjections = ol.proj.transformWithProjections =
@@ -731,7 +721,6 @@ ol.proj.transformWithProjections =
/** /**
* @param {olx.Proj4jsProjectionOptions} options Proj4js projection options. * @param {olx.Proj4jsProjectionOptions} options Proj4js projection options.
* @return {ol.proj.Projection} Proj4js projection. * @return {ol.proj.Projection} Proj4js projection.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.proj.configureProj4jsProjection = function(options) { ol.proj.configureProj4jsProjection = function(options) {

View File

@@ -380,7 +380,6 @@ ol.render.canvas.Immediate.prototype.drawRings_ =
* *
* @param {number} zIndex Z index. * @param {number} zIndex Z index.
* @param {function(ol.render.canvas.Immediate)} callback Callback. * @param {function(ol.render.canvas.Immediate)} callback Callback.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) { 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 {ol.geom.Circle} circleGeometry Circle geometry.
* @param {Object} data Opaque data object, * @param {Object} data Opaque data object,
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawCircleGeometry = ol.render.canvas.Immediate.prototype.drawCircleGeometry =
@@ -446,7 +444,6 @@ ol.render.canvas.Immediate.prototype.drawCircleGeometry =
* *
* @param {ol.Feature} feature Feature. * @param {ol.Feature} feature Feature.
* @param {ol.style.Style} style Style. * @param {ol.style.Style} style Style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) { 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 {ol.geom.Point} pointGeometry Point geometry.
* @param {Object} data Opaque data object. * @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawPointGeometry = ol.render.canvas.Immediate.prototype.drawPointGeometry =
@@ -521,7 +517,6 @@ ol.render.canvas.Immediate.prototype.drawPointGeometry =
* *
* @param {ol.geom.MultiPoint} multiPointGeometry MultiPoint geometry. * @param {ol.geom.MultiPoint} multiPointGeometry MultiPoint geometry.
* @param {Object} data Opaque data object. * @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawMultiPointGeometry = 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 {ol.geom.LineString} lineStringGeometry Line string geometry.
* @param {Object} data Opaque data object. * @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawLineStringGeometry = ol.render.canvas.Immediate.prototype.drawLineStringGeometry =
@@ -574,7 +568,6 @@ ol.render.canvas.Immediate.prototype.drawLineStringGeometry =
* @param {ol.geom.MultiLineString} multiLineStringGeometry * @param {ol.geom.MultiLineString} multiLineStringGeometry
* MultiLineString geometry. * MultiLineString geometry.
* @param {Object} data Opaque data object. * @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry = ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry =
@@ -611,7 +604,6 @@ ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry =
* *
* @param {ol.geom.Polygon} polygonGeometry Polygon geometry. * @param {ol.geom.Polygon} polygonGeometry Polygon geometry.
* @param {Object} data Opaque data object. * @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawPolygonGeometry = ol.render.canvas.Immediate.prototype.drawPolygonGeometry =
@@ -651,7 +643,6 @@ ol.render.canvas.Immediate.prototype.drawPolygonGeometry =
* uses the current style. * uses the current style.
* @param {ol.geom.MultiPolygon} multiPolygonGeometry MultiPolygon geometry. * @param {ol.geom.MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
* @param {Object} data Opaque data object. * @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.drawMultiPolygonGeometry = 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.Fill} fillStyle Fill style.
* @param {ol.style.Stroke} strokeStyle Stroke style. * @param {ol.style.Stroke} strokeStyle Stroke style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.setFillStrokeStyle = ol.render.canvas.Immediate.prototype.setFillStrokeStyle =
@@ -873,7 +863,6 @@ ol.render.canvas.Immediate.prototype.setFillStrokeStyle =
* the image style. * the image style.
* *
* @param {ol.style.Image} imageStyle Image style. * @param {ol.style.Image} imageStyle Image style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) { ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
@@ -913,7 +902,6 @@ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
* remove the text style. * remove the text style.
* *
* @param {ol.style.Text} textStyle Text style. * @param {ol.style.Text} textStyle Text style.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) { ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) {

View File

@@ -8,7 +8,6 @@ goog.provide('ol.render.IVectorContext');
* VectorContext interface. Currently implemented by * VectorContext interface. Currently implemented by
* {@link ol.render.canvas.Immediate} * {@link ol.render.canvas.Immediate}
* @interface * @interface
* @todo stability experimental
*/ */
ol.render.IVectorContext = function() { ol.render.IVectorContext = function() {
}; };

View File

@@ -11,17 +11,17 @@ goog.require('ol.render.IVectorContext');
ol.render.EventType = { ol.render.EventType = {
/** /**
* @event ol.render.Event#postcompose * @event ol.render.Event#postcompose
* @todo stability experimental * @todo api
*/ */
POSTCOMPOSE: 'postcompose', POSTCOMPOSE: 'postcompose',
/** /**
* @event ol.render.Event#precompose * @event ol.render.Event#precompose
* @todo stability experimental * @todo api
*/ */
PRECOMPOSE: 'precompose', PRECOMPOSE: 'precompose',
/** /**
* @event ol.render.Event#render * @event ol.render.Event#render
* @todo stability experimental * @todo api
*/ */
RENDER: 'render' RENDER: 'render'
}; };
@@ -47,13 +47,11 @@ ol.render.Event = function(
/** /**
* @type {ol.render.IVectorContext|undefined} * @type {ol.render.IVectorContext|undefined}
* @todo stability experimental
*/ */
this.vectorContext = opt_vectorContext; this.vectorContext = opt_vectorContext;
/** /**
* @type {oli.FrameState|undefined} * @type {oli.FrameState|undefined}
* @todo stability experimental
*/ */
this.frameState = opt_frameState; this.frameState = opt_frameState;
@@ -61,7 +59,6 @@ ol.render.Event = function(
* Canvas context. Only available when a Canvas renderer is used, * Canvas context. Only available when a Canvas renderer is used,
* null otherwise. * null otherwise.
* @type {CanvasRenderingContext2D|null|undefined} * @type {CanvasRenderingContext2D|null|undefined}
* @todo stability experimental
*/ */
this.context = opt_context; this.context = opt_context;
@@ -69,7 +66,6 @@ ol.render.Event = function(
* WebGL context. Only available when a WebGL renderer is used, null * WebGL context. Only available when a WebGL renderer is used, null
* otherwise. * otherwise.
* @type {ol.webgl.Context|null|undefined} * @type {ol.webgl.Context|null|undefined}
* @todo stability experimental
*/ */
this.glContext = opt_glContext; this.glContext = opt_glContext;

View File

@@ -4,8 +4,8 @@ goog.provide('ol.size');
/** /**
* An array of numbers representing a size: `[width, height]`. * An array of numbers representing a size: `[width, height]`.
* @typedef {Array.<number>} ol.Size * @typedef {Array.<number>}
* @todo stability experimental * @todo api
*/ */
ol.Size; ol.Size;

View File

@@ -19,7 +19,6 @@ goog.require('ol.tilegrid.XYZ');
* @constructor * @constructor
* @extends {ol.source.TileImage} * @extends {ol.source.TileImage}
* @param {olx.source.BingMapsOptions} options Bing Maps options. * @param {olx.source.BingMapsOptions} options Bing Maps options.
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.source.BingMaps = function(options) { ol.source.BingMaps = function(options) {
@@ -56,7 +55,6 @@ goog.inherits(ol.source.BingMaps, ol.source.TileImage);
/** /**
* @const * @const
* @type {ol.Attribution} * @type {ol.Attribution}
* @todo stability experimental
* @todo api * @todo api
*/ */
ol.source.BingMaps.TOS_ATTRIBUTION = new ol.Attribution({ ol.source.BingMaps.TOS_ATTRIBUTION = new ol.Attribution({

Some files were not shown because too many files have changed in this diff Show More