From bada596b4547eda863216e089b7fa2ea6190f22e Mon Sep 17 00:00:00 2001 From: Paul Spencer Date: Thu, 24 Oct 2013 17:07:02 -0400 Subject: [PATCH] Add default stability level to docs of exported things. --- build.py | 2 + src/objectliterals.jsdoc | 72 +++++++++++++++++++ src/ol/animation.js | 4 ++ src/ol/attribution.js | 1 + src/ol/centerconstraint.js | 1 + src/ol/collection.js | 13 ++++ src/ol/control/attributioncontrol.js | 1 + src/ol/control/control.js | 3 + src/ol/control/controldefaults.js | 1 + src/ol/control/dragboxcontrol.js | 1 + src/ol/control/fullscreencontrol.js | 1 + src/ol/control/logocontrol.js | 1 + src/ol/control/mousepositioncontrol.js | 5 ++ src/ol/control/scalelinecontrol.js | 6 ++ src/ol/control/zoomcontrol.js | 1 + src/ol/control/zoomslidercontrol.js | 1 + src/ol/control/zoomtoextentcontrol.js | 1 + src/ol/coordinate.js | 7 ++ src/ol/deviceorientation.js | 8 +++ src/ol/dom/input.js | 7 ++ src/ol/expr/expression.js | 2 + src/ol/extent.js | 27 +++++++ src/ol/feature.js | 6 ++ src/ol/geolocation.js | 14 ++++ src/ol/geom/geometry.js | 2 + src/ol/geom/geometrycollection.js | 1 + src/ol/geom/linearring.js | 1 + src/ol/geom/linestring.js | 1 + src/ol/geom/multilinestring.js | 1 + src/ol/geom/multipoint.js | 1 + src/ol/geom/multipolygon.js | 1 + src/ol/geom/point.js | 1 + src/ol/geom/polygon.js | 2 + src/ol/geom2/linestringcollection.js | 2 + src/ol/geom2/pointcollection.js | 4 ++ src/ol/imagetile.js | 2 + src/ol/interaction/condition.js | 8 +++ .../interaction/doubleclickzoominteraction.js | 1 + src/ol/interaction/dragpaninteraction.js | 1 + .../dragrotateandzoominteraction.js | 1 + src/ol/interaction/dragzoominteraction.js | 1 + src/ol/interaction/interactiondefaults.js | 1 + src/ol/interaction/keyboardpaninteraction.js | 1 + src/ol/interaction/keyboardzoominteraction.js | 1 + .../interaction/mousewheelzoominteraction.js | 1 + src/ol/interaction/selectinteraction.js | 1 + src/ol/interaction/touchpaninteraction.js | 1 + src/ol/interaction/touchrotateinteraction.js | 1 + src/ol/interaction/touchzoominteraction.js | 1 + src/ol/iview2d.js | 4 ++ src/ol/kinetic.js | 1 + src/ol/layer/imagelayer.js | 1 + src/ol/layer/layer.js | 2 + src/ol/layer/layergroup.js | 3 + src/ol/layer/tilelayer.js | 3 + src/ol/layer/vectorlayer.js | 1 + src/ol/layer/vectorlayer2.js | 1 + src/ol/map.js | 28 ++++++++ src/ol/mapbrowserevent.js | 5 ++ src/ol/object.js | 12 ++++ src/ol/ol.js | 1 + src/ol/overlay.js | 10 +++ src/ol/parser/geojsonparser.js | 1 + src/ol/parser/gpxparser.js | 1 + src/ol/parser/kmlparser.js | 1 + src/ol/parser/ogc/gmlparser_v2.js | 2 + src/ol/parser/ogc/gmlparser_v3.js | 2 + src/ol/parser/ogc/wmscapabilitiesparser.js | 1 + src/ol/parser/ogc/wmtscapabilitiesparser.js | 1 + src/ol/parser/parser.js | 1 + src/ol/parser/topojsonparser.js | 1 + src/ol/parser/wktparser.js | 1 + src/ol/parser/xmlparser.js | 1 + src/ol/proj/proj.js | 10 +++ src/ol/size.js | 1 + src/ol/source/bingmapssource.js | 1 + src/ol/source/debugtilesource.js | 1 + src/ol/source/featureinfosource.js | 1 + src/ol/source/imagesource.js | 2 + src/ol/source/imagestaticsource.js | 1 + src/ol/source/imagewmssource.js | 1 + src/ol/source/mapquestsource.js | 2 + src/ol/source/osmsource.js | 1 + src/ol/source/source.js | 2 + src/ol/source/stamensource.js | 1 + src/ol/source/tileimagesource.js | 2 + src/ol/source/tilejsonsource.js | 1 + src/ol/source/tilesource.js | 2 + src/ol/source/tilewmssource.js | 3 + src/ol/source/vectorsource.js | 1 + src/ol/source/vectorsource2.js | 1 + src/ol/source/wmssource.js | 1 + src/ol/source/wmtssource.js | 4 ++ src/ol/source/xyzsource.js | 2 + src/ol/structs/buffer.js | 1 + src/ol/style/fillsymbolizer.js | 1 + src/ol/style/iconsymbolizer.js | 1 + src/ol/style/rule.js | 1 + src/ol/style/shapeliteral.js | 1 + src/ol/style/shapesymbolizer.js | 1 + src/ol/style/strokesymbolizer.js | 1 + src/ol/style/style.js | 1 + src/ol/tile.js | 1 + src/ol/tilegrid/tilegrid.js | 6 ++ src/ol/tilegrid/wmtstilegrid.js | 2 + src/ol/tilegrid/xyztilegrid.js | 1 + src/ol/transformfunction.js | 1 + src/ol/view2d.js | 12 ++++ 108 files changed, 382 insertions(+) diff --git a/build.py b/build.py index 9d4b0a3f14..287f505552 100755 --- a/build.py +++ b/build.py @@ -374,6 +374,7 @@ virtual('lint', 'build/lint-timestamp', 'build/lint-generated-timestamp', def build_lint_src_timestamp(t): t.run('%(GJSLINT)s', '--jslint_error=all', + '--custom_jsdoc_tags=todo', '--strict', t.newer(t.dependencies)) t.touch() @@ -390,6 +391,7 @@ def build_lint_generated_timestamp(t): '--jslint_error=all', # ignore error for max line length (for these auto-generated sources) '--disable=110', + '--custom_jsdoc_tags=todo', # for a complete list of error codes to allow, see # http://closure-linter.googlecode.com/svn/trunk/closure_linter/errors.py '--limited_doc_files=%s' % (','.join(limited_doc_files),), diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index e60751ac8e..2384b123ec 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -3,11 +3,13 @@ * @property {string} html HTML markup for this attribution. * @property {Object.>|undefined} tileRanges * Tile ranges (FOR INTERNAL USE ONLY). + * @todo stability experimental */ /** * @typedef {Object} ol.DeviceOrientationOptions * @property {boolean|undefined} tracking Start tracking. Default is false. + * @todo stability experimental */ /** @@ -15,6 +17,7 @@ * @property {boolean|undefined} tracking Start Tracking. Default is false. * @property {GeolocationPositionOptions|undefined} trackingOptions Tracking options. * @property {ol.proj.ProjectionLike} projection Projection. + * @todo stability experimental */ /** @@ -30,6 +33,7 @@ * @property {function()|undefined} error Callback for unsuccessful queries. * Note that queries with no matching features trigger the success callback, * not the error callback. + * @todo stability experimental */ /** @@ -45,6 +49,7 @@ * @property {function()|undefined} error Callback for unsuccessful queries. * Note that queries with no matching features trigger the success callback, * not the error callback. + * @todo stability experimental */ /** @@ -63,6 +68,7 @@ * @property {Element|string|undefined} target The container for the map. * @property {ol.IView|undefined} view The map's view. Currently * {@link ol.View2D} is available as view. + * @todo stability experimental */ /** @@ -74,6 +80,7 @@ * @property {ol.OverlayPositioning|undefined} positioning Positioning. * @property {boolean|undefined} stopEvent Whether event propagation to the map * should be stopped. Default is `false`. + * @todo stability experimental */ /** @@ -83,6 +90,7 @@ * @property {ol.Extent|undefined} extent The validity extent for the SRS. * @property {boolean|undefined} global Whether the projection is valid for the * whole globe. Default is false. + * @todo stability experimental */ /** @@ -95,6 +103,7 @@ * specified in Proj4. The default is `enu`. * @property {boolean|undefined} global Whether the projection is valid for the * whole globe. Default is false. + * @todo stability experimental */ /** @@ -131,6 +140,7 @@ * @property {number|undefined} zoomFactor The zoom factor used to determine the * resolution constraint. Used together with `maxResolution` and `maxZoom`. * Default is 2. + * @todo stability experimental */ /** @@ -139,6 +149,7 @@ * @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000. * @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.upAndDown` + * @todo stability experimental */ /** @@ -147,6 +158,7 @@ * @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000. * @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut` + * @todo stability experimental */ /** @@ -155,6 +167,7 @@ * @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} duration The duration of the animation in milliseconds. Default is 1000. * @property {function(number):number|undefined} easing The easing function to use. Default is `ol.easing.inAndOut` + * @todo stability experimental */ /** @@ -163,18 +176,21 @@ * @property {number|undefined} start The start time of the animation. Default is immediately. * @property {number|undefined} duration The duration of the animation in milliseconds. * @property {function(number):number|undefined} easing Easing function. + * @todo stability experimental */ /** * @typedef {Object} ol.control.AttributionOptions * @property {string|undefined} className CSS class name. Default is `ol-attribution`. * @property {Element|undefined} target Target. + * @todo stability experimental */ /** * @typedef {Object} ol.control.ControlOptions * @property {Element|undefined} element Element. * @property {Element|undefined} target Target. + * @todo stability experimental */ /** @@ -186,6 +202,7 @@ * @property {ol.control.LogoOptions|undefined} logoOptions Logo options. * @property {boolean|undefined} zoom Zoom. * @property {ol.control.ZoomOptions|undefined} zoomOptions Zoom options. + * @todo stability experimental */ /** @@ -193,12 +210,14 @@ * @property {string|undefined} className CSS class name. Default is `ol-full-screen`. * @property {boolean|undefined} keys Full keyboard access. * @property {Element|undefined} target Target. + * @todo stability experimental */ /** * @typedef {Object} ol.control.LogoOptions * @property {string|undefined} className CSS class name. Default is `ol-logo`. * @property {Element|undefined} target Target. + * @todo stability experimental */ /** @@ -210,6 +229,7 @@ * @property {Element|undefined} target Target. * @property {string|undefined} undefinedHTML Markup for undefined coordinates. * Default is `` (empty string). + * @todo stability experimental */ /** @@ -218,6 +238,7 @@ * @property {number|undefined} minWidth Minimum width in pixels. * @property {Element|undefined} target Target. * @property {ol.control.ScaleLineUnits|undefined} units Units. + * @todo stability experimental */ /** @@ -226,6 +247,7 @@ * @property {string|undefined} className CSS class name. Default is `ol-zoom`. * @property {number|undefined} delta The zoom delta applied on each click. * @property {Element|undefined} target Target. + * @todo stability experimental */ /** @@ -233,6 +255,7 @@ * @property {string|undefined} className CSS class name. * @property {number|undefined} maxResolution Maximum resolution. * @property {number|undefined} minResolution Minimum resolution. + * @todo stability experimental */ /** @@ -241,6 +264,7 @@ * @property {Element|undefined} target Target. * @property {ol.Extent|undefined} extent The extent to zoom to. If * undefined the validity extent of the view projection is used. + * @todo stability experimental */ /** @@ -248,6 +272,7 @@ * @property {number|undefined} duration Animation duration. Default is 250ms. * @property {number|undefined} delta The zoom delta applied on each double * click, default is 1. + * @todo stability experimental */ /** @@ -256,6 +281,7 @@ * @property {ol.interaction.ConditionType|undefined} condition A conditional * modifier (i.e. Shift key) that determines if the interaction is active * or not, default is no modifiers. + * @todo stability experimental */ /** @@ -263,6 +289,7 @@ * @property {ol.interaction.ConditionType|undefined} condition A conditional * modifier (i.e. Shift key) that determines if the interaction is active * or not, default is both shift and alt keys. + * @todo stability experimental */ /** @@ -270,6 +297,7 @@ * @property {ol.interaction.ConditionType|undefined} condition A conditional * modifier (i.e. Shift key) that determines if the interaction is active * or not, default is shify key. + * @todo stability experimental */ /** @@ -277,6 +305,7 @@ * @property {ol.interaction.ConditionType|undefined} condition A conditional * modifier (i.e. Shift key) that determines if the interaction is active * or not, default is shift key. + * @todo stability experimental */ /** @@ -299,6 +328,7 @@ * @property {boolean|undefined} touchZoom Whether touch zoom is desired. * @property {number|undefined} zoomDelta Zoom delta. * @property {number|undefined} zoomDuration Zoom duration. + * @todo stability experimental */ /** @@ -308,6 +338,7 @@ * or not, default is no modifiers. * @property {number|undefined} pixelDelta Pixel The amount to pan on each key * press + * @todo stability experimental */ /** @@ -317,11 +348,13 @@ * modifier (i.e. Shift key) that determines if the interaction is active * or not, default is no modifiers. * @property {number|undefined} delta The amount to zoom on each key press. + * @todo stability experimental */ /** * @typedef {Object} ol.interaction.MouseWheelZoomOptions * @property {number|undefined} duration Animation duration. Default is 250ms. + * @todo stability experimental */ /** @@ -336,22 +369,26 @@ * toggles the selection. * @property {undefined|function(ol.layer.Layer):boolean} layerFilter Filter * function to restrict selection to a subset of layers. + * @todo stability experimental */ /** * @typedef {Object} ol.interaction.TouchPanOptions * @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the * pan. + * @todo stability experimental */ /** * @typedef {Object} ol.interaction.TouchRotateOptions * @property {number|undefined} threshold Minimal angle to start a rotation. + * @todo stability experimental */ /** * @typedef {Object} ol.interaction.TouchZoomOptions * @property {number|undefined} duration Animation duration. Default is 400ms. + * @todo stability experimental */ /** @@ -366,6 +403,7 @@ * (inclusive) at which this layer will be visible. * @property {number|undefined} maxResolution The maximum resolution * (exclusive) below which this layer will be visible. + * @todo stability experimental */ /** @@ -381,6 +419,7 @@ * (inclusive) at which this layer will be visible. * @property {number|undefined} maxResolution The maximum resolution * (exclusive) below which this layer will be visible. + * @todo stability experimental */ /** @@ -396,6 +435,7 @@ * @property {number|undefined} maxResolution The maximum resolution * (exclusive) below which this layer will be visible. * @property {Array.|ol.Collection|undefined} layers Child layers. + * @todo stability experimental */ /** @@ -412,6 +452,7 @@ * (inclusive) at which this layer will be visible. * @property {number|undefined} maxResolution The maximum resolution * (exclusive) below which this layer will be visible. + * @todo stability experimental */ /** @@ -428,6 +469,7 @@ * (inclusive) at which this layer will be visible. * @property {number|undefined} maxResolution The maximum resolution * (exclusive) below which this layer will be visible. + * @todo stability experimental */ /** @@ -440,17 +482,20 @@ * Default is 0, which means we don't follow network links at all. * @property {Array.|undefined} trackAttributes Track attributes to * parse. + * @todo stability experimental */ /** * @typedef {Object} ol.parser.GMLReadOptions * @property {string|undefined} axisOrientation The axis orientation. + * @todo stability experimental */ /** * @typedef {Object} ol.parser.GMLWriteOptions * @property {ol.proj.ProjectionLike} srsName The srsName to use when writing. * @property {string|undefined} axisOrientation The axis orientation. + * @todo stability experimental */ /** @@ -482,6 +527,7 @@ * use for this instance. * @property {ol.parser.GMLWriteOptions|undefined} writeOptions writeOptions * to use for this instance. + * @todo stability experimental */ /** @@ -499,6 +545,7 @@ * Default is `true´. * @property {boolean|undefined} extractRoutes Extract routes from GPX. * Default is `true´. + * @todo stability experimental */ /** @@ -507,6 +554,7 @@ * out. * @property {Object|undefined} metadata Metadata key/value pair with keys: * name, desc and author. + * @todo stability experimental */ /** @@ -517,12 +565,14 @@ * @property {string} style Style. * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * function to load a tile given a URL. + * @todo stability experimental */ /** * @typedef {Object} ol.source.MapQuestOptions * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * function to load a tile given a URL. + * @todo stability experimental */ /** @@ -530,6 +580,7 @@ * @property {ol.Extent|undefined} extent Extent. * @property {ol.proj.ProjectionLike} projection Projection. * @property {ol.tilegrid.TileGrid|undefined} tileGrid Tile grid. + * @todo stability experimental */ /** @@ -539,6 +590,7 @@ * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * function to load a tile given a URL. * @property {string|undefined} url URL. + * @todo stability experimental */ /** @@ -560,6 +612,7 @@ * @property {Array.|undefined} resolutions Resolutions. If specified, * requests will be made for these resolutions only. * @property {string|undefined} url WMS service URL. + * @todo stability experimental */ /** @@ -571,6 +624,7 @@ * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * function to load a tile given a URL. * @property {string|undefined} url URL. + * @todo stability experimental */ /** @@ -583,6 +637,7 @@ * @property {ol.Size|undefined} imageSize Size of the image. * @property {ol.proj.ProjectionLike} projection Projection. * @property {string|undefined} url URL. + * @todo stability experimental */ /** @@ -592,6 +647,7 @@ * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * function to load a tile given a URL. * @property {string} url URL. + * @todo stability experimental */ /** @@ -615,6 +671,7 @@ * @property {string|undefined} url WMS service URL. * @property {Array.|undefined} urls WMS service urls. Use this instead * of `url` when the WMS supports multiple urls for GetMap requests. + * @todo stability experimental */ /** @@ -630,6 +687,7 @@ * the parser does not know the SRS (e.g. in some GML flavors), or if the * projection determined by the parser needs to be overridden. * @property {string|undefined} url Server url providing the vector data. + * @todo stability experimental */ /** @@ -641,6 +699,7 @@ * @property {Array.|undefined} pointCollections * Point collections. * @property {ol.proj.ProjectionLike} projection Projection. + * @todo stability experimental */ @@ -650,6 +709,7 @@ * GetFeatureInfo. Default is `ol.source.WMSGetFeatureInfoMethod.IFRAME`. * @property {Object} params Params for the GetFeatureInfo request. Default is * `{'INFO_FORMAT': 'text/html'}`. + * @todo stability experimental */ @@ -675,6 +735,7 @@ * @property {ol.TileLoadFunctionType|undefined} tileLoadFunction Optional * function to load a tile given a URL. * @property {Array.|undefined} urls Urls. + * @todo stability experimental */ /** @@ -696,6 +757,7 @@ * @property {string|undefined} url URL template. Must include `{x}`, `{y}`, * and `{z}` placeholders. * @property {Array.|undefined} urls An array of URL templates. + * @todo stability experimental */ /** @@ -714,6 +776,7 @@ * @property {number|ol.expr.Expression|undefined} yOffset Pixel offset from the * point to the center of the icon (positive values shift image down). * @property {number|ol.expr.Expression|undefined} zIndex Stack order. + * @todo stability experimental */ /** @@ -722,6 +785,7 @@ * code. * @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1). * @property {number|ol.expr.Expression|undefined} zIndex Stack order. + * @todo stability experimental */ /** @@ -734,6 +798,7 @@ * a value is provided, the rule will apply at resolutions greater than or * equal to this value. * @property {Array.|undefined} symbolizers Symbolizers. + * @todo stability experimental */ /** @@ -743,6 +808,7 @@ * @property {ol.style.Fill|undefined} fill Fill symbolizer for shape. * @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for shape. * @property {number|ol.expr.Expression|undefined} zIndex Stack order. + * @todo stability experimental */ /** @@ -752,6 +818,7 @@ * @property {number|ol.expr.Expression|undefined} opacity Stroke opacity (0-1). * @property {number|ol.expr.Expression|undefined} width Stroke width in pixels. * @property {number|ol.expr.Expression|undefined} zIndex Stack order. + * @todo stability experimental */ /** @@ -760,6 +827,7 @@ * @property {Array.|undefined} symbolizers Symbolizers * (that apply if no rules are provided or where none of the provided rules * apply). + * @todo stability experimental */ /** @@ -772,6 +840,7 @@ * @property {number|ol.expr.Expression|undefined} opacity Opacity (0-1). * @property {ol.style.Stroke|undefined} stroke Stroke symbolizer for text. * @property {number|ol.expr.Expression|undefined} zIndex Stack order. + * @todo stability experimental */ /** @@ -782,6 +851,7 @@ * @property {!Array.} resolutions Resolutions. * @property {ol.Size|undefined} tileSize Tile size. * @property {Array.|undefined} tileSizes Tile sizes. + * @todo stability experimental */ /** @@ -792,9 +862,11 @@ * @property {!Array.} matrixIds matrix IDs. * @property {ol.Size|undefined} tileSize Tile size. * @property {Array.|undefined} tileSizes Tile sizes. + * @todo stability experimental */ /** * @typedef {Object} ol.tilegrid.XYZOptions * @property {number} maxZoom Maximum zoom. + * @todo stability experimental */ diff --git a/src/ol/animation.js b/src/ol/animation.js index 3d67b58af8..b1a15fa966 100644 --- a/src/ol/animation.js +++ b/src/ol/animation.js @@ -10,6 +10,7 @@ goog.require('ol.easing'); /** * @param {ol.animation.BounceOptions} options Bounce options. * @return {ol.PreRenderFunction} Pre-render function. + * @todo stability experimental */ ol.animation.bounce = function(options) { var resolution = options.resolution; @@ -44,6 +45,7 @@ ol.animation.bounce = function(options) { /** * @param {ol.animation.PanOptions} options Pan options. * @return {ol.PreRenderFunction} Pre-render function. + * @todo stability experimental */ ol.animation.pan = function(options) { var source = options.source; @@ -82,6 +84,7 @@ ol.animation.pan = function(options) { /** * @param {ol.animation.RotateOptions} options Rotate options. * @return {ol.PreRenderFunction} Pre-render function. + * @todo stability experimental */ ol.animation.rotate = function(options) { var sourceRotation = options.rotation; @@ -118,6 +121,7 @@ ol.animation.rotate = function(options) { /** * @param {ol.animation.ZoomOptions} options Zoom options. * @return {ol.PreRenderFunction} Pre-render function. + * @todo stability experimental */ ol.animation.zoom = function(options) { var sourceResolution = options.resolution; diff --git a/src/ol/attribution.js b/src/ol/attribution.js index 95bc352e60..361572bcc7 100644 --- a/src/ol/attribution.js +++ b/src/ol/attribution.js @@ -21,6 +21,7 @@ goog.require('ol.TileRange'); * * @constructor * @param {ol.AttributionOptions} options Attribution options. + * @todo stability experimental */ ol.Attribution = function(options) { diff --git a/src/ol/centerconstraint.js b/src/ol/centerconstraint.js index 2cc4db9592..790e53237f 100644 --- a/src/ol/centerconstraint.js +++ b/src/ol/centerconstraint.js @@ -6,6 +6,7 @@ goog.require('goog.math'); /** * @typedef {function((ol.Coordinate|undefined)): (ol.Coordinate|undefined)} + * @todo stability experimental */ ol.CenterConstraintType; diff --git a/src/ol/collection.js b/src/ol/collection.js index 7034e69135..cbf681d73f 100644 --- a/src/ol/collection.js +++ b/src/ol/collection.js @@ -66,6 +66,7 @@ ol.CollectionProperty = { * @constructor * @extends {ol.Object} * @param {Array=} opt_array Array. + * @todo stability experimental */ ol.Collection = function(opt_array) { @@ -85,6 +86,7 @@ goog.inherits(ol.Collection, ol.Object); /** * Remove all elements from the collection. + * @todo stability experimental */ ol.Collection.prototype.clear = function() { while (this.getLength() > 0) { @@ -96,6 +98,7 @@ ol.Collection.prototype.clear = function() { /** * @param {Array} arr Array. * @return {ol.Collection} This collection. + * @todo stability experimental */ ol.Collection.prototype.extend = function(arr) { var i, ii; @@ -113,6 +116,7 @@ ol.Collection.prototype.extend = function(arr) { * value is ignored. * @param {Object=} opt_obj The object to be used as the value of 'this' * within f. + * @todo stability experimental */ ol.Collection.prototype.forEach = function(f, opt_obj) { goog.array.forEach(this.array_, f, opt_obj); @@ -125,6 +129,7 @@ ol.Collection.prototype.forEach = function(f, opt_obj) { * collection's "length" property won't be in sync with the actual length * of the array. * @return {Array} Array. + * @todo stability experimental */ ol.Collection.prototype.getArray = function() { return this.array_; @@ -135,6 +140,7 @@ ol.Collection.prototype.getArray = function() { * Get the element at the provided index. * @param {number} index Index. * @return {*} Element. + * @todo stability experimental */ ol.Collection.prototype.getAt = function(index) { return this.array_[index]; @@ -144,6 +150,7 @@ ol.Collection.prototype.getAt = function(index) { /** * Get the length of this collection. * @return {number} Length. + * @todo stability experimental */ ol.Collection.prototype.getLength = function() { return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH)); @@ -154,6 +161,7 @@ ol.Collection.prototype.getLength = function() { * Insert an element at the provided index. * @param {number} index Index. * @param {*} elem Element. + * @todo stability experimental */ ol.Collection.prototype.insertAt = function(index, elem) { goog.array.insertAt(this.array_, elem, index); @@ -166,6 +174,7 @@ ol.Collection.prototype.insertAt = function(index, elem) { /** * Remove the last element of the collection. * @return {*} Element. + * @todo stability experimental */ ol.Collection.prototype.pop = function() { return this.removeAt(this.getLength() - 1); @@ -176,6 +185,7 @@ ol.Collection.prototype.pop = function() { * Insert the provided element at the end of the collection. * @param {*} elem Element. * @return {number} Length. + * @todo stability experimental */ ol.Collection.prototype.push = function(elem) { var n = this.array_.length; @@ -188,6 +198,7 @@ ol.Collection.prototype.push = function(elem) { * Removes the first occurence of elem from the collection. * @param {*} elem Element. * @return {*} The removed element or undefined if elem was not found. + * @todo stability experimental */ ol.Collection.prototype.remove = function(elem) { var arr = this.array_; @@ -205,6 +216,7 @@ ol.Collection.prototype.remove = function(elem) { * Remove the element at the provided index. * @param {number} index Index. * @return {*} Value. + * @todo stability experimental */ ol.Collection.prototype.removeAt = function(index) { var prev = this.array_[index]; @@ -220,6 +232,7 @@ ol.Collection.prototype.removeAt = function(index) { * Set the element at the provided index. * @param {number} index Index. * @param {*} elem Element. + * @todo stability experimental */ ol.Collection.prototype.setAt = function(index, elem) { var n = this.getLength(); diff --git a/src/ol/control/attributioncontrol.js b/src/ol/control/attributioncontrol.js index 312c1a3e85..f5d2ed225f 100644 --- a/src/ol/control/attributioncontrol.js +++ b/src/ol/control/attributioncontrol.js @@ -22,6 +22,7 @@ goog.require('ol.css'); * @constructor * @extends {ol.control.Control} * @param {ol.control.AttributionOptions=} opt_options Attribution options. + * @todo stability experimental */ ol.control.Attribution = function(opt_options) { diff --git a/src/ol/control/control.js b/src/ol/control/control.js index fdf721e00c..b57a732e38 100644 --- a/src/ol/control/control.js +++ b/src/ol/control/control.js @@ -16,6 +16,7 @@ goog.require('ol.Object'); * @extends {ol.Object} * @implements {oli.control.Control} * @param {ol.control.ControlOptions} options Control options. + * @todo stability experimental */ ol.control.Control = function(options) { @@ -61,6 +62,7 @@ ol.control.Control.prototype.disposeInternal = function() { /** * Get the map associated with this control. * @return {ol.Map} Map. + * @todo stability experimental */ ol.control.Control.prototype.getMap = function() { return this.map_; @@ -81,6 +83,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction; * Subclasses may set up event handlers to get notified about changes to * the map here. * @param {ol.Map} map Map. + * @todo stability experimental */ ol.control.Control.prototype.setMap = function(map) { if (!goog.isNull(this.map_)) { diff --git a/src/ol/control/controldefaults.js b/src/ol/control/controldefaults.js index 77db5098c8..0546ee1229 100644 --- a/src/ol/control/controldefaults.js +++ b/src/ol/control/controldefaults.js @@ -9,6 +9,7 @@ goog.require('ol.control.Zoom'); /** * @param {ol.control.DefaultsOptions=} opt_options Defaults options. * @return {ol.Collection} Controls. + * @todo stability experimental */ ol.control.defaults = function(opt_options) { diff --git a/src/ol/control/dragboxcontrol.js b/src/ol/control/dragboxcontrol.js index 18bf8ad5c9..3459fe9d07 100644 --- a/src/ol/control/dragboxcontrol.js +++ b/src/ol/control/dragboxcontrol.js @@ -27,6 +27,7 @@ ol.control.DragBoxOptions; * @constructor * @extends {ol.control.Control} * @param {ol.control.DragBoxOptions} options Drag box options. + * @todo stability experimental */ ol.control.DragBox = function(options) { diff --git a/src/ol/control/fullscreencontrol.js b/src/ol/control/fullscreencontrol.js index 70c9913d85..12f9823f4d 100644 --- a/src/ol/control/fullscreencontrol.js +++ b/src/ol/control/fullscreencontrol.js @@ -23,6 +23,7 @@ goog.require('ol.css'); * @constructor * @extends {ol.control.Control} * @param {ol.control.FullScreenOptions=} opt_options Options. + * @todo stability experimental */ ol.control.FullScreen = function(opt_options) { diff --git a/src/ol/control/logocontrol.js b/src/ol/control/logocontrol.js index 4d969c1abe..8843e10d7e 100644 --- a/src/ol/control/logocontrol.js +++ b/src/ol/control/logocontrol.js @@ -18,6 +18,7 @@ goog.require('ol.css'); * @constructor * @extends {ol.control.Control} * @param {ol.control.LogoOptions=} opt_options Logo options. + * @todo stability experimental */ ol.control.Logo = function(opt_options) { diff --git a/src/ol/control/mousepositioncontrol.js b/src/ol/control/mousepositioncontrol.js index bc5f39311e..88750a6abe 100644 --- a/src/ol/control/mousepositioncontrol.js +++ b/src/ol/control/mousepositioncontrol.js @@ -37,6 +37,7 @@ ol.control.MousePositionProperty = { * @constructor * @extends {ol.control.Control} * @param {ol.control.MousePositionOptions=} opt_options Mouse position options. + * @todo stability experimental */ ol.control.MousePosition = function(opt_options) { @@ -127,6 +128,7 @@ ol.control.MousePosition.prototype.handleProjectionChanged_ = function() { /** * @return {ol.CoordinateFormatType|undefined} projection. + * @todo stability experimental */ ol.control.MousePosition.prototype.getCoordinateFormat = function() { return /** @type {ol.CoordinateFormatType|undefined} */ ( @@ -140,6 +142,7 @@ goog.exportProperty( /** * @return {ol.proj.Projection|undefined} projection. + * @todo stability experimental */ ol.control.MousePosition.prototype.getProjection = function() { return /** @type {ol.proj.Projection|undefined} */ ( @@ -193,6 +196,7 @@ ol.control.MousePosition.prototype.setMap = function(map) { /** * @param {ol.CoordinateFormatType} format Coordinate format. + * @todo stability experimental */ ol.control.MousePosition.prototype.setCoordinateFormat = function(format) { this.set(ol.control.MousePositionProperty.COORDINATE_FORMAT, format); @@ -205,6 +209,7 @@ goog.exportProperty( /** * @param {ol.proj.Projection} projection Projection. + * @todo stability experimental */ ol.control.MousePosition.prototype.setProjection = function(projection) { this.set(ol.control.MousePositionProperty.PROJECTION, projection); diff --git a/src/ol/control/scalelinecontrol.js b/src/ol/control/scalelinecontrol.js index e8c242bf9d..7783cd8e8b 100644 --- a/src/ol/control/scalelinecontrol.js +++ b/src/ol/control/scalelinecontrol.js @@ -21,6 +21,7 @@ goog.require('ol.sphere.NORMAL'); /** * @enum {string} + * @todo stability experimental */ ol.control.ScaleLineProperty = { UNITS: 'units' @@ -29,6 +30,7 @@ ol.control.ScaleLineProperty = { /** * @enum {string} + * @todo stability experimental */ ol.control.ScaleLineUnits = { DEGREES: 'degrees', @@ -48,6 +50,7 @@ ol.control.ScaleLineUnits = { * @constructor * @extends {ol.control.Control} * @param {ol.control.ScaleLineOptions=} opt_options Scale line options. + * @todo stability experimental */ ol.control.ScaleLine = function(opt_options) { @@ -126,12 +129,14 @@ goog.inherits(ol.control.ScaleLine, ol.control.Control); /** * @const * @type {Array.} + * @todo stability experimental */ ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5]; /** * @return {ol.control.ScaleLineUnits|undefined} units. + * @todo stability experimental */ ol.control.ScaleLine.prototype.getUnits = function() { return /** @type {ol.control.ScaleLineUnits|undefined} */ ( @@ -167,6 +172,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() { /** * @param {ol.control.ScaleLineUnits} units Units. + * @todo stability experimental */ ol.control.ScaleLine.prototype.setUnits = function(units) { this.set(ol.control.ScaleLineProperty.UNITS, units); diff --git a/src/ol/control/zoomcontrol.js b/src/ol/control/zoomcontrol.js index 05cb4e0974..72f278353b 100644 --- a/src/ol/control/zoomcontrol.js +++ b/src/ol/control/zoomcontrol.js @@ -20,6 +20,7 @@ goog.require('ol.easing'); * @constructor * @extends {ol.control.Control} * @param {ol.control.ZoomOptions=} opt_options Zoom options. + * @todo stability experimental */ ol.control.Zoom = function(opt_options) { diff --git a/src/ol/control/zoomslidercontrol.js b/src/ol/control/zoomslidercontrol.js index a258afc23e..2d7bbbad80 100644 --- a/src/ol/control/zoomslidercontrol.js +++ b/src/ol/control/zoomslidercontrol.js @@ -38,6 +38,7 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200; * @constructor * @extends {ol.control.Control} * @param {ol.control.ZoomSliderOptions=} opt_options Zoom slider options. + * @todo stability experimental */ ol.control.ZoomSlider = function(opt_options) { diff --git a/src/ol/control/zoomtoextentcontrol.js b/src/ol/control/zoomtoextentcontrol.js index c749c06982..f926db5a0d 100644 --- a/src/ol/control/zoomtoextentcontrol.js +++ b/src/ol/control/zoomtoextentcontrol.js @@ -18,6 +18,7 @@ goog.require('ol.css'); * @constructor * @extends {ol.control.Control} * @param {ol.control.ZoomToExtentOptions=} opt_options Options. + * @todo stability experimental */ ol.control.ZoomToExtent = function(opt_options) { var options = goog.isDef(opt_options) ? opt_options : {}; diff --git a/src/ol/coordinate.js b/src/ol/coordinate.js index baa0b42f42..1753c76ec5 100644 --- a/src/ol/coordinate.js +++ b/src/ol/coordinate.js @@ -9,6 +9,7 @@ goog.require('goog.math'); /** * A function that formats a {@link ol.Coordinate} into a string. * @typedef {function((ol.Coordinate|undefined)): string} + * @todo stability experimental */ ol.CoordinateFormatType; @@ -16,6 +17,7 @@ ol.CoordinateFormatType; /** * An array of numbers representing a coordinate. * @typedef {Array.} ol.Coordinate + * @todo stability experimental */ ol.Coordinate; @@ -23,6 +25,7 @@ ol.Coordinate; /** * An array of coordinate arrays. * @typedef {Array.} + * @todo stability experimental */ ol.CoordinateArray; @@ -42,6 +45,7 @@ ol.coordinate.add = function(coordinate, delta) { /** * @param {number=} opt_precision Precision. * @return {ol.CoordinateFormatType} Coordinate format. + * @todo stability experimental */ ol.coordinate.createStringXY = function(opt_precision) { return ( @@ -114,6 +118,7 @@ ol.coordinate.squaredDistance = function(coord1, coord2) { /** * @param {ol.Coordinate|undefined} coordinate Coordinate. * @return {string} Hemisphere, degrees, minutes and seconds. + * @todo stability experimental */ ol.coordinate.toStringHDMS = function(coordinate) { if (goog.isDef(coordinate)) { @@ -129,6 +134,7 @@ ol.coordinate.toStringHDMS = function(coordinate) { * @param {ol.Coordinate|undefined} coordinate Coordinate. * @param {number=} opt_precision Precision. * @return {string} XY. + * @todo stability experimental */ ol.coordinate.toStringXY = function(coordinate, opt_precision) { if (goog.isDef(coordinate)) { @@ -146,6 +152,7 @@ ol.coordinate.toStringXY = function(coordinate, opt_precision) { * @param {Array} array The array with coordinates. * @param {string} axis the axis info. * @return {ol.Coordinate} The coordinate created. + * @todo stability experimental */ ol.coordinate.fromProjectedArray = function(array, axis) { var firstAxis = axis.charAt(0); diff --git a/src/ol/deviceorientation.js b/src/ol/deviceorientation.js index c4a0a1f35c..523f242443 100644 --- a/src/ol/deviceorientation.js +++ b/src/ol/deviceorientation.js @@ -68,6 +68,7 @@ ol.DeviceOrientationProperty = { * @constructor * @extends {ol.Object} * @param {ol.DeviceOrientationOptions=} opt_options Options. + * @todo stability experimental */ ol.DeviceOrientation = function(opt_options) { @@ -104,6 +105,7 @@ ol.DeviceOrientation.prototype.disposeInternal = function() { * Indicates if DeviceOrientation is supported in the user's browser. * @const * @type {boolean} + * @todo stability experimental */ ol.DeviceOrientation.SUPPORTED = 'DeviceOrientationEvent' in goog.global; @@ -142,6 +144,7 @@ ol.DeviceOrientation.prototype.orientationChange_ = function(browserEvent) { /** * @return {number|undefined} The alpha value of the DeviceOrientation, * in radians. + * @todo stability experimental */ ol.DeviceOrientation.prototype.getAlpha = function() { return /** @type {number|undefined} */ ( @@ -156,6 +159,7 @@ goog.exportProperty( /** * @return {number|undefined} The beta value of the DeviceOrientation, * in radians. + * @todo stability experimental */ ol.DeviceOrientation.prototype.getBeta = function() { return /** @type {number|undefined} */ ( @@ -170,6 +174,7 @@ goog.exportProperty( /** * @return {number|undefined} The gamma value of the DeviceOrientation, * in radians. + * @todo stability experimental */ ol.DeviceOrientation.prototype.getGamma = function() { return /** @type {number|undefined} */ ( @@ -184,6 +189,7 @@ goog.exportProperty( /** * @return {number|undefined} The heading of the device relative to * north, in radians, normalizing for different browser behavior. + * @todo stability experimental */ ol.DeviceOrientation.prototype.getHeading = function() { return /** @type {number|undefined} */ ( @@ -198,6 +204,7 @@ goog.exportProperty( /** * Are we tracking the device's orientation? * @return {boolean} The current tracking state, true if tracking is on. + * @todo stability experimental */ ol.DeviceOrientation.prototype.getTracking = function() { return /** @type {boolean} */ ( @@ -229,6 +236,7 @@ ol.DeviceOrientation.prototype.handleTrackingChanged_ = function() { /** * Enable or disable tracking of DeviceOrientation events. * @param {boolean} tracking True to enable and false to disable tracking. + * @todo stability experimental */ ol.DeviceOrientation.prototype.setTracking = function(tracking) { this.set(ol.DeviceOrientationProperty.TRACKING, tracking); diff --git a/src/ol/dom/input.js b/src/ol/dom/input.js index 5769bfbe75..1c7147778a 100644 --- a/src/ol/dom/input.js +++ b/src/ol/dom/input.js @@ -29,6 +29,7 @@ ol.dom.InputProperty = { * @constructor * @extends {ol.Object} * @param {Element} target Target element. + * @todo stability experimental */ ol.dom.Input = function(target) { goog.base(this); @@ -58,6 +59,7 @@ goog.inherits(ol.dom.Input, ol.Object); /** * If the input is a checkbox, return whether or not the checbox is checked. * @return {boolean|undefined} checked. + * @todo stability experimental */ ol.dom.Input.prototype.getChecked = function() { return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED)); @@ -71,6 +73,7 @@ goog.exportProperty( /** * Get the value of the input. * @return {string|undefined} input value. + * @todo stability experimental */ ol.dom.Input.prototype.getValue = function() { return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE)); @@ -84,6 +87,7 @@ goog.exportProperty( /** * Get the value of the input as a number. * @return {number|null|undefined} input value as number. + * @todo stability experimental */ ol.dom.Input.prototype.getValueAsNumber = function() { return /** @type {number} */ (this.get(ol.dom.InputProperty.VALUE_AS_NUMBER)); @@ -97,6 +101,7 @@ goog.exportProperty( /** * Sets the value of the input. * @param {string} value Value. + * @todo stability experimental */ ol.dom.Input.prototype.setValue = function(value) { this.set(ol.dom.InputProperty.VALUE, value); @@ -110,6 +115,7 @@ goog.exportProperty( /** * Sets the number value of the input. * @param {number} value Number value. + * @todo stability experimental */ ol.dom.Input.prototype.setValueAsNumber = function(value) { this.set(ol.dom.InputProperty.VALUE_AS_NUMBER, value); @@ -123,6 +129,7 @@ goog.exportProperty( /** * Set whether or not a checkbox is checked. * @param {boolean} checked Checked. + * @todo stability experimental */ ol.dom.Input.prototype.setChecked = function(checked) { this.set(ol.dom.InputProperty.CHECKED, checked); diff --git a/src/ol/expr/expression.js b/src/ol/expr/expression.js index 3e8103885d..25eb4163e5 100644 --- a/src/ol/expr/expression.js +++ b/src/ol/expr/expression.js @@ -34,6 +34,7 @@ ol.expr.evaluateFeature = function(expr, opt_feature) { * @param {string} source The expression source (e.g. `'foo + 2'`). * @return {ol.expr.Expression} An expression instance that can be * evaluated within some scope to provide a value. + * @todo stability experimental */ ol.expr.parse = function(source) { var parser = new ol.expr.Parser(); @@ -47,6 +48,7 @@ ol.expr.parse = function(source) { * @param {function(this:ol.Feature)} func The function to be called in an * expression. This function will be called with a feature as the `this` * argument when the expression is evaluated in the context of a features. + * @todo stability experimental */ ol.expr.register = function(name, func) { ol.expr.lib[name] = func; diff --git a/src/ol/extent.js b/src/ol/extent.js index 6fc2e940ca..25464d5e68 100644 --- a/src/ol/extent.js +++ b/src/ol/extent.js @@ -10,6 +10,7 @@ goog.require('ol.TransformFunction'); /** * An array of numbers representing an extent: `[minx, miny, maxx, maxy]`. * @typedef {Array.} + * @todo stability experimental */ ol.Extent; @@ -19,6 +20,7 @@ ol.Extent; * * @param {Array.} coordinates Coordinates. * @return {ol.Extent} Bounding extent. + * @todo stability experimental */ ol.extent.boundingExtent = function(coordinates) { var extent = ol.extent.createEmpty(); @@ -37,6 +39,7 @@ ol.extent.boundingExtent = function(coordinates) { * @param {ol.Extent=} opt_extent Destination extent. * @private * @return {ol.Extent} Extent. + * @todo stability experimental */ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) { goog.asserts.assert(xs.length > 0); @@ -54,6 +57,7 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) { * * @param {ol.Extent} extent Extent to clone. * @return {ol.Extent} The clone. + * @todo stability experimental */ ol.extent.clone = function(extent) { return extent.slice(); @@ -66,6 +70,7 @@ ol.extent.clone = function(extent) { * @param {ol.Extent} extent Extent. * @param {ol.Coordinate} coordinate Coordinate. * @return {boolean} Contains. + * @todo stability experimental */ ol.extent.containsCoordinate = function(extent, coordinate) { return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] && @@ -79,6 +84,7 @@ ol.extent.containsCoordinate = function(extent, coordinate) { * @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent2 Extent 2. * @return {boolean} Contains. + * @todo stability experimental */ ol.extent.containsExtent = function(extent1, extent2) { return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] && @@ -88,6 +94,7 @@ ol.extent.containsExtent = function(extent1, extent2) { /** * @return {ol.Extent} Empty extent. + * @todo stability experimental */ ol.extent.createEmpty = function() { return [Infinity, Infinity, -Infinity, -Infinity]; @@ -101,6 +108,7 @@ ol.extent.createEmpty = function() { * @param {number} maxY Maximum Y. * @param {ol.Extent=} opt_extent Destination extent. * @return {ol.Extent} Extent. + * @todo stability experimental */ ol.extent.createOrUpdate = function(minX, maxX, minY, maxY, opt_extent) { if (goog.isDef(opt_extent)) { @@ -119,6 +127,7 @@ ol.extent.createOrUpdate = function(minX, maxX, minY, maxY, opt_extent) { * Empties extent in place. * @param {ol.Extent} extent Extent. * @return {ol.Extent} Extent. + * @todo stability experimental */ ol.extent.empty = function(extent) { extent[0] = extent[1] = Infinity; @@ -131,6 +140,7 @@ ol.extent.empty = function(extent) { * @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent2 Extent 2. * @return {boolean} Equals. + * @todo stability experimental */ ol.extent.equals = function(extent1, extent2) { return extent1[0] == extent2[0] && extent1[2] == extent2[2] && @@ -141,6 +151,7 @@ ol.extent.equals = function(extent1, extent2) { /** * @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent2 Extent 2. + * @todo stability experimental */ ol.extent.extend = function(extent1, extent2) { if (extent2[0] < extent1[0]) { @@ -161,6 +172,7 @@ ol.extent.extend = function(extent1, extent2) { /** * @param {ol.Extent} extent Extent. * @param {ol.Coordinate} coordinate Coordinate. + * @todo stability experimental */ ol.extent.extendCoordinate = function(extent, coordinate) { if (coordinate[0] < extent[0]) { @@ -181,6 +193,7 @@ ol.extent.extendCoordinate = function(extent, coordinate) { /** * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Bottom left coordinate. + * @todo stability experimental */ ol.extent.getBottomLeft = function(extent) { return [extent[0], extent[1]]; @@ -190,6 +203,7 @@ ol.extent.getBottomLeft = function(extent) { /** * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Bottom right coordinate. + * @todo stability experimental */ ol.extent.getBottomRight = function(extent) { return [extent[2], extent[1]]; @@ -199,6 +213,7 @@ ol.extent.getBottomRight = function(extent) { /** * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Center. + * @todo stability experimental */ ol.extent.getCenter = function(extent) { return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2]; @@ -212,6 +227,7 @@ ol.extent.getCenter = function(extent) { * @param {ol.Size} size Size. * @param {ol.Extent=} opt_extent Destination extent. * @return {ol.Extent} Extent. + * @todo stability experimental */ ol.extent.getForView2DAndSize = function(center, resolution, rotation, size, opt_extent) { @@ -237,6 +253,7 @@ ol.extent.getForView2DAndSize = /** * @param {ol.Extent} extent Extent. * @return {number} Height. + * @todo stability experimental */ ol.extent.getHeight = function(extent) { return extent[3] - extent[1]; @@ -246,6 +263,7 @@ ol.extent.getHeight = function(extent) { /** * @param {ol.Extent} extent Extent. * @return {ol.Size} Size. + * @todo stability experimental */ ol.extent.getSize = function(extent) { return [extent[2] - extent[0], extent[3] - extent[1]]; @@ -255,6 +273,7 @@ ol.extent.getSize = function(extent) { /** * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Top left coordinate. + * @todo stability experimental */ ol.extent.getTopLeft = function(extent) { return [extent[0], extent[3]]; @@ -264,6 +283,7 @@ ol.extent.getTopLeft = function(extent) { /** * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Top right coordinate. + * @todo stability experimental */ ol.extent.getTopRight = function(extent) { return [extent[2], extent[3]]; @@ -273,6 +293,7 @@ ol.extent.getTopRight = function(extent) { /** * @param {ol.Extent} extent Extent. * @return {number} Width. + * @todo stability experimental */ ol.extent.getWidth = function(extent) { return extent[2] - extent[0]; @@ -283,6 +304,7 @@ ol.extent.getWidth = function(extent) { * @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent2 Extent. * @return {boolean} Intersects. + * @todo stability experimental */ ol.extent.intersects = function(extent1, extent2) { return extent1[0] <= extent2[2] && @@ -295,6 +317,7 @@ ol.extent.intersects = function(extent1, extent2) { /** * @param {ol.Extent} extent Extent. * @return {boolean} Is empty. + * @todo stability experimental */ ol.extent.isEmpty = function(extent) { return extent[2] < extent[0] || extent[3] < extent[1]; @@ -305,6 +328,7 @@ ol.extent.isEmpty = function(extent) { * @param {ol.Extent} extent Extent. * @param {ol.Coordinate} coordinate Coordinate. * @return {ol.Coordinate} Coordinate. + * @todo stability experimental */ ol.extent.normalize = function(extent, coordinate) { return [ @@ -317,6 +341,7 @@ ol.extent.normalize = function(extent, coordinate) { /** * @param {ol.Extent} extent Extent. * @param {number} value Value. + * @todo stability experimental */ ol.extent.scaleFromCenter = function(extent, value) { var deltaX = ((extent[2] - extent[0]) / 2) * (value - 1); @@ -332,6 +357,7 @@ ol.extent.scaleFromCenter = function(extent, value) { * @param {ol.Extent} extent1 Extent 1. * @param {ol.Extent} extent2 Extent 2. * @return {boolean} Touches. + * @todo stability experimental */ ol.extent.touches = function(extent1, extent2) { var intersects = ol.extent.intersects(extent1, extent2); @@ -346,6 +372,7 @@ ol.extent.touches = function(extent1, extent2) { * @param {ol.TransformFunction} transformFn Transform function. * @param {ol.Extent=} opt_extent Destination extent. * @return {ol.Extent} Extent. + * @todo stability experimental */ ol.extent.transform = function(extent, transformFn, opt_extent) { var coordinates = [ diff --git a/src/ol/feature.js b/src/ol/feature.js index 424a04ddf6..4adffbe482 100644 --- a/src/ol/feature.js +++ b/src/ol/feature.js @@ -24,6 +24,7 @@ goog.require('ol.layer.VectorLayerRenderIntent'); * @constructor * @extends {ol.Object} * @param {Object.=} opt_values Attributes. + * @todo stability experimental */ ol.Feature = function(opt_values) { @@ -60,6 +61,7 @@ goog.inherits(ol.Feature, ol.Object); /** * Gets a copy of the attributes of this feature. * @return {Object.} Attributes object. + * @todo stability experimental */ ol.Feature.prototype.getAttributes = function() { var keys = this.getKeys(), @@ -79,6 +81,7 @@ ol.Feature.prototype.getAttributes = function() { * the unique id in the source store. * * @return {string|undefined} The feature's identifier. + * @todo stability experimental */ ol.Feature.prototype.getId = function() { return this.featureId_; @@ -88,6 +91,7 @@ ol.Feature.prototype.getId = function() { /** * Get the geometry associated with this feature. * @return {ol.geom.Geometry} The geometry (or null if none). + * @todo stability experimental */ ol.Feature.prototype.getGeometry = function() { return goog.isDef(this.geometryName_) ? @@ -120,6 +124,7 @@ ol.Feature.prototype.handleGeometryChange_ = function(evt) { * @inheritDoc * @param {string} key Key. * @param {*} value Value. + * @todo stability experimental */ ol.Feature.prototype.set = function(key, value) { var geometry = this.getGeometry(); @@ -160,6 +165,7 @@ ol.Feature.prototype.setId = function(featureId) { /** * Set the geometry to be associated with this feature after its creation. * @param {ol.geom.Geometry} geometry The geometry. + * @todo stability experimental */ ol.Feature.prototype.setGeometry = function(geometry) { if (!goog.isDef(this.geometryName_)) { diff --git a/src/ol/geolocation.js b/src/ol/geolocation.js index 7a68f5743a..f8f8d17a96 100644 --- a/src/ol/geolocation.js +++ b/src/ol/geolocation.js @@ -46,6 +46,7 @@ ol.GeolocationProperty = { * @constructor * @extends {ol.Object} * @param {ol.GeolocationOptions=} opt_options Options. + * @todo stability experimental */ ol.Geolocation = function(opt_options) { @@ -140,6 +141,7 @@ ol.Geolocation.prototype.handleTrackingChanged_ = function() { * Is HTML5 geolocation supported in the current browser? * @const * @type {boolean} + * @todo stability experimental */ ol.Geolocation.SUPPORTED = 'geolocation' in goog.global.navigator; @@ -183,6 +185,7 @@ ol.Geolocation.prototype.positionError_ = function(error) { /** * Get the accuracy of the position in meters. * @return {number|undefined} Position accuracy in meters. + * @todo stability experimental */ ol.Geolocation.prototype.getAccuracy = function() { return /** @type {number|undefined} */ ( @@ -197,6 +200,7 @@ goog.exportProperty( /** * Get the altitude associated with the position. * @return {number|undefined} The altitude in meters above the mean sea level. + * @todo stability experimental */ ol.Geolocation.prototype.getAltitude = function() { return /** @type {number|undefined} */ ( @@ -211,6 +215,7 @@ goog.exportProperty( /** * Get the altitude accuracy of the position. * @return {number|undefined} Altitude accuracy in meters. + * @todo stability experimental */ ol.Geolocation.prototype.getAltitudeAccuracy = function() { return /** @type {number|undefined} */ ( @@ -225,6 +230,7 @@ goog.exportProperty( /** * Get the heading as radians clockwise from North. * @return {number|undefined} Heading. + * @todo stability experimental */ ol.Geolocation.prototype.getHeading = function() { return /** @type {number|undefined} */ ( @@ -239,6 +245,7 @@ goog.exportProperty( /** * Get the position of the device. * @return {ol.Coordinate|undefined} position. + * @todo stability experimental */ ol.Geolocation.prototype.getPosition = function() { return /** @type {ol.Coordinate|undefined} */ ( @@ -253,6 +260,7 @@ goog.exportProperty( /** * Get the projection associated with the position. * @return {ol.proj.Projection|undefined} projection. + * @todo stability experimental */ ol.Geolocation.prototype.getProjection = function() { return /** @type {ol.proj.Projection|undefined} */ ( @@ -267,6 +275,7 @@ goog.exportProperty( /** * Get the speed in meters per second. * @return {number|undefined} Speed. + * @todo stability experimental */ ol.Geolocation.prototype.getSpeed = function() { return /** @type {number|undefined} */ ( @@ -281,6 +290,7 @@ goog.exportProperty( /** * Are we tracking the user's position? * @return {boolean} tracking. + * @todo stability experimental */ ol.Geolocation.prototype.getTracking = function() { return /** @type {boolean} */ ( @@ -297,6 +307,7 @@ goog.exportProperty( * @see http://www.w3.org/TR/geolocation-API/#position-options * @return {GeolocationPositionOptions|undefined} HTML 5 Gelocation * tracking options. + * @todo stability experimental */ ol.Geolocation.prototype.getTrackingOptions = function() { return /** @type {GeolocationPositionOptions|undefined} */ ( @@ -311,6 +322,7 @@ goog.exportProperty( /** * Set the projection to use for transforming the coordinates. * @param {ol.proj.Projection} projection Projection. + * @todo stability experimental */ ol.Geolocation.prototype.setProjection = function(projection) { this.set(ol.GeolocationProperty.PROJECTION, projection); @@ -324,6 +336,7 @@ goog.exportProperty( /** * Enable/disable tracking. * @param {boolean} tracking Enable or disable tracking. + * @todo stability experimental */ ol.Geolocation.prototype.setTracking = function(tracking) { this.set(ol.GeolocationProperty.TRACKING, tracking); @@ -339,6 +352,7 @@ goog.exportProperty( * @see http://www.w3.org/TR/geolocation-API/#position-options * @param {GeolocationPositionOptions} options HTML 5 Geolocation * tracking options. + * @todo stability experimental */ ol.Geolocation.prototype.setTrackingOptions = function(options) { this.set(ol.GeolocationProperty.TRACKING_OPTIONS, options); diff --git a/src/ol/geom/geometry.js b/src/ol/geom/geometry.js index 9578c7cd5b..452d30c26b 100644 --- a/src/ol/geom/geometry.js +++ b/src/ol/geom/geometry.js @@ -12,6 +12,7 @@ goog.require('ol.TransformFunction'); /** * @constructor * @extends {goog.events.EventTarget} + * @todo stability experimental */ ol.geom.Geometry = function() { goog.base(this); @@ -76,6 +77,7 @@ goog.inherits(ol.geom.GeometryEvent, goog.events.Event); * Geometry types. * * @enum {string} + * @todo stability experimental */ ol.geom.GeometryType = { POINT: 'point', diff --git a/src/ol/geom/geometrycollection.js b/src/ol/geom/geometrycollection.js index 73407fad57..463150b006 100644 --- a/src/ol/geom/geometrycollection.js +++ b/src/ol/geom/geometrycollection.js @@ -16,6 +16,7 @@ goog.require('ol.geom.GeometryType'); * @constructor * @extends {ol.geom.AbstractCollection} * @param {Array.} geometries Array of geometries. + * @todo stability experimental */ ol.geom.GeometryCollection = function(geometries) { goog.base(this); diff --git a/src/ol/geom/linearring.js b/src/ol/geom/linearring.js index fb7eb418eb..31f4ba200e 100644 --- a/src/ol/geom/linearring.js +++ b/src/ol/geom/linearring.js @@ -11,6 +11,7 @@ goog.require('ol.geom.LineString'); * @extends {ol.geom.LineString} * @param {ol.CoordinateArray} coordinates Vertex array (e.g. * [[x0, y0], [x1, y1]]). + * @todo stability experimental */ ol.geom.LinearRing = function(coordinates) { goog.base(this, coordinates); diff --git a/src/ol/geom/linestring.js b/src/ol/geom/linestring.js index bbb598bfd8..11b2fd3e05 100644 --- a/src/ol/geom/linestring.js +++ b/src/ol/geom/linestring.js @@ -16,6 +16,7 @@ goog.require('ol.geom.GeometryType'); * @extends {ol.geom.Geometry} * @param {ol.CoordinateArray} coordinates Array of coordinates (e.g. * [[x0, y0], [x1, y1]]). + * @todo stability experimental */ ol.geom.LineString = function(coordinates) { goog.base(this); diff --git a/src/ol/geom/multilinestring.js b/src/ol/geom/multilinestring.js index f86669e5d9..0f5d0f9955 100644 --- a/src/ol/geom/multilinestring.js +++ b/src/ol/geom/multilinestring.js @@ -14,6 +14,7 @@ goog.require('ol.geom.LineString'); * @constructor * @extends {ol.geom.AbstractCollection} * @param {Array.} coordinates Coordinates array. + * @todo stability experimental */ ol.geom.MultiLineString = function(coordinates) { goog.base(this); diff --git a/src/ol/geom/multipoint.js b/src/ol/geom/multipoint.js index 4f588b69c3..850367e1fd 100644 --- a/src/ol/geom/multipoint.js +++ b/src/ol/geom/multipoint.js @@ -14,6 +14,7 @@ goog.require('ol.geom.Point'); * @constructor * @extends {ol.geom.AbstractCollection} * @param {ol.CoordinateArray} coordinates Coordinates array. + * @todo stability experimental */ ol.geom.MultiPoint = function(coordinates) { goog.base(this); diff --git a/src/ol/geom/multipolygon.js b/src/ol/geom/multipolygon.js index 3982081074..d8f8066436 100644 --- a/src/ol/geom/multipolygon.js +++ b/src/ol/geom/multipolygon.js @@ -15,6 +15,7 @@ goog.require('ol.geom.Polygon'); * @extends {ol.geom.AbstractCollection} * @param {Array.>} coordinates Coordinates * array. + * @todo stability experimental */ ol.geom.MultiPolygon = function(coordinates) { goog.base(this); diff --git a/src/ol/geom/point.js b/src/ol/geom/point.js index ffa269d902..b11f862858 100644 --- a/src/ol/geom/point.js +++ b/src/ol/geom/point.js @@ -13,6 +13,7 @@ goog.require('ol.geom.GeometryType'); * @constructor * @extends {ol.geom.Geometry} * @param {ol.Coordinate} coordinates Coordinate values (e.g. [x, y]). + * @todo stability experimental */ ol.geom.Point = function(coordinates) { goog.base(this); diff --git a/src/ol/geom/polygon.js b/src/ol/geom/polygon.js index 6016a8d08a..dff49abef3 100644 --- a/src/ol/geom/polygon.js +++ b/src/ol/geom/polygon.js @@ -23,6 +23,7 @@ goog.require('ol.geom.LinearRing'); * @extends {ol.geom.Geometry} * @param {Array.} coordinates Array of rings. First * is outer, any remaining are inner. + * @todo stability experimental */ ol.geom.Polygon = function(coordinates) { goog.base(this); @@ -75,6 +76,7 @@ ol.geom.Polygon.prototype.getBounds = function() { /** * @return {Array.} Coordinates array. + * @todo stability experimental */ ol.geom.Polygon.prototype.getCoordinates = function() { var count = this.rings_.length; diff --git a/src/ol/geom2/linestringcollection.js b/src/ol/geom2/linestringcollection.js index c159777634..b07455e638 100644 --- a/src/ol/geom2/linestringcollection.js +++ b/src/ol/geom2/linestringcollection.js @@ -21,6 +21,7 @@ ol.geom2.LineString; * @param {ol.structs.Buffer} buf Buffer. * @param {Object.=} opt_ranges Ranges. * @param {number=} opt_dim Dimension. + * @todo stability experimental */ ol.geom2.LineStringCollection = function(buf, opt_ranges, opt_dim) { @@ -61,6 +62,7 @@ ol.geom2.LineStringCollection.createEmpty = function(capacity, opt_dim) { * @param {number=} opt_capacity Capacity. * @param {number=} opt_dim Dimension. * @return {ol.geom2.LineStringCollection} Line string collection. + * @todo stability experimental */ ol.geom2.LineStringCollection.pack = function(unpackedLineStrings, opt_capacity, opt_dim) { diff --git a/src/ol/geom2/pointcollection.js b/src/ol/geom2/pointcollection.js index c9ba6e8336..235fd6b7ab 100644 --- a/src/ol/geom2/pointcollection.js +++ b/src/ol/geom2/pointcollection.js @@ -19,6 +19,7 @@ ol.geom2.Point; * @constructor * @param {ol.structs.Buffer} buf Buffer. * @param {number=} opt_dim Dimension. + * @todo stability experimental */ ol.geom2.PointCollection = function(buf, opt_dim) { @@ -40,6 +41,7 @@ ol.geom2.PointCollection = function(buf, opt_dim) { * @param {number} capacity Capacity. * @param {number=} opt_dim Dimension. * @return {ol.geom2.PointCollection} Point collection. + * @todo stability experimental */ ol.geom2.PointCollection.createEmpty = function(capacity, opt_dim) { var dim = goog.isDef(opt_dim) ? opt_dim : 2; @@ -54,6 +56,7 @@ ol.geom2.PointCollection.createEmpty = function(capacity, opt_dim) { * @param {number=} opt_capacity Capacity. * @param {number=} opt_dim Dimension. * @return {ol.geom2.PointCollection} Point collection. + * @todo stability experimental */ ol.geom2.PointCollection.pack = function(unpackedPoints, opt_capacity, opt_dim) { @@ -72,6 +75,7 @@ ol.geom2.PointCollection.pack = /** * @param {ol.geom2.Point} point Point. * @return {number} Offset. + * @todo stability experimental */ ol.geom2.PointCollection.prototype.add = function(point) { goog.asserts.assert(point.length == this.dim); diff --git a/src/ol/imagetile.js b/src/ol/imagetile.js index 6457d7458f..dd7098f00e 100644 --- a/src/ol/imagetile.js +++ b/src/ol/imagetile.js @@ -20,6 +20,7 @@ goog.require('ol.TileState'); * @param {string} src Image source URI. * @param {?string} crossOrigin Cross origin. * @param {ol.TileLoadFunctionType} tileLoadFunction Tile load function. + * @todo stability experimental */ ol.ImageTile = function(tileCoord, state, src, crossOrigin, tileLoadFunction) { @@ -67,6 +68,7 @@ goog.inherits(ol.ImageTile, ol.Tile); /** * @inheritDoc + * @todo stability experimental */ ol.ImageTile.prototype.getImage = function(opt_context) { if (goog.isDef(opt_context)) { diff --git a/src/ol/interaction/condition.js b/src/ol/interaction/condition.js index 08bcdd805a..3ff779260c 100644 --- a/src/ol/interaction/condition.js +++ b/src/ol/interaction/condition.js @@ -15,6 +15,7 @@ ol.interaction.ConditionType; /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt key is pressed. + * @todo stability experimental */ ol.interaction.condition.altKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -28,6 +29,7 @@ ol.interaction.condition.altKeyOnly = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt and shift keys are pressed. + * @todo stability experimental */ ol.interaction.condition.altShiftKeysOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -42,6 +44,7 @@ ol.interaction.condition.altShiftKeysOnly = function(mapBrowserEvent) { * Always true. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True. + * @todo stability experimental */ ol.interaction.condition.always = goog.functions.TRUE; @@ -49,6 +52,7 @@ ol.interaction.condition.always = goog.functions.TRUE; /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if the event is a click event. + * @todo stability experimental */ ol.interaction.condition.clickOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -59,6 +63,7 @@ ol.interaction.condition.clickOnly = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True only if there no modifier keys are pressed. + * @todo stability experimental */ ol.interaction.condition.noModifierKeys = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -72,6 +77,7 @@ ol.interaction.condition.noModifierKeys = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the platform modifier key is pressed. + * @todo stability experimental */ ol.interaction.condition.platformModifierKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -85,6 +91,7 @@ ol.interaction.condition.platformModifierKeyOnly = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the shift key is pressed. + * @todo stability experimental */ ol.interaction.condition.shiftKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -98,6 +105,7 @@ ol.interaction.condition.shiftKeyOnly = function(mapBrowserEvent) { /** * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True only if the target element is not editable. + * @todo stability experimental */ ol.interaction.condition.targetNotEditable = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; diff --git a/src/ol/interaction/doubleclickzoominteraction.js b/src/ol/interaction/doubleclickzoominteraction.js index f68a348c5d..dc439f8b33 100644 --- a/src/ol/interaction/doubleclickzoominteraction.js +++ b/src/ol/interaction/doubleclickzoominteraction.js @@ -15,6 +15,7 @@ goog.require('ol.interaction.Interaction'); * @constructor * @extends {ol.interaction.Interaction} * @param {ol.interaction.DoubleClickZoomOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.DoubleClickZoom = function(opt_options) { diff --git a/src/ol/interaction/dragpaninteraction.js b/src/ol/interaction/dragpaninteraction.js index 0ef41626d6..04f40c3353 100644 --- a/src/ol/interaction/dragpaninteraction.js +++ b/src/ol/interaction/dragpaninteraction.js @@ -18,6 +18,7 @@ goog.require('ol.interaction.condition'); * @constructor * @extends {ol.interaction.Drag} * @param {ol.interaction.DragPanOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.DragPan = function(opt_options) { diff --git a/src/ol/interaction/dragrotateandzoominteraction.js b/src/ol/interaction/dragrotateandzoominteraction.js index 5ad2eecd18..9c0d28d8b2 100644 --- a/src/ol/interaction/dragrotateandzoominteraction.js +++ b/src/ol/interaction/dragrotateandzoominteraction.js @@ -26,6 +26,7 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400; * @constructor * @extends {ol.interaction.Drag} * @param {ol.interaction.DragRotateAndZoomOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.DragRotateAndZoom = function(opt_options) { diff --git a/src/ol/interaction/dragzoominteraction.js b/src/ol/interaction/dragzoominteraction.js index 9481af6ff2..252643afda 100644 --- a/src/ol/interaction/dragzoominteraction.js +++ b/src/ol/interaction/dragzoominteraction.js @@ -35,6 +35,7 @@ ol.SHIFT_DRAG_ZOOM_HYSTERESIS_PIXELS_SQUARED = * @constructor * @extends {ol.interaction.Drag} * @param {ol.interaction.DragZoomOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.DragZoom = function(opt_options) { diff --git a/src/ol/interaction/interactiondefaults.js b/src/ol/interaction/interactiondefaults.js index 27a2010b62..b6e39c8752 100644 --- a/src/ol/interaction/interactiondefaults.js +++ b/src/ol/interaction/interactiondefaults.js @@ -26,6 +26,7 @@ goog.require('ol.interaction.TouchZoom'); * @param {ol.interaction.DefaultsOptions=} opt_options Defaults options. * @return {ol.Collection} A collection of interactions to be used with * the ol.Map constructor's interactions option. + * @todo stability experimental */ ol.interaction.defaults = function(opt_options) { diff --git a/src/ol/interaction/keyboardpaninteraction.js b/src/ol/interaction/keyboardpaninteraction.js index 980f9afd5e..6d0a06213f 100644 --- a/src/ol/interaction/keyboardpaninteraction.js +++ b/src/ol/interaction/keyboardpaninteraction.js @@ -25,6 +25,7 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100; * @constructor * @extends {ol.interaction.Interaction} * @param {ol.interaction.KeyboardPanOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.KeyboardPan = function(opt_options) { diff --git a/src/ol/interaction/keyboardzoominteraction.js b/src/ol/interaction/keyboardzoominteraction.js index 436a77e509..5c963ce886 100644 --- a/src/ol/interaction/keyboardzoominteraction.js +++ b/src/ol/interaction/keyboardzoominteraction.js @@ -15,6 +15,7 @@ goog.require('ol.interaction.condition'); * @constructor * @param {ol.interaction.KeyboardZoomOptions=} opt_options Options. * @extends {ol.interaction.Interaction} + * @todo stability experimental */ ol.interaction.KeyboardZoom = function(opt_options) { diff --git a/src/ol/interaction/mousewheelzoominteraction.js b/src/ol/interaction/mousewheelzoominteraction.js index 0463143de1..29999fb194 100644 --- a/src/ol/interaction/mousewheelzoominteraction.js +++ b/src/ol/interaction/mousewheelzoominteraction.js @@ -28,6 +28,7 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80; * @constructor * @extends {ol.interaction.Interaction} * @param {ol.interaction.MouseWheelZoomOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.MouseWheelZoom = function(opt_options) { diff --git a/src/ol/interaction/selectinteraction.js b/src/ol/interaction/selectinteraction.js index 813e6d1e0f..e4e123d4e7 100644 --- a/src/ol/interaction/selectinteraction.js +++ b/src/ol/interaction/selectinteraction.js @@ -17,6 +17,7 @@ goog.require('ol.source.Vector'); * @constructor * @extends {ol.interaction.Interaction} * @param {ol.interaction.SelectOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.Select = function(opt_options) { var options = goog.isDef(opt_options) ? opt_options : {}; diff --git a/src/ol/interaction/touchpaninteraction.js b/src/ol/interaction/touchpaninteraction.js index e2bd7c4533..41f494a7b2 100644 --- a/src/ol/interaction/touchpaninteraction.js +++ b/src/ol/interaction/touchpaninteraction.js @@ -16,6 +16,7 @@ goog.require('ol.interaction.Touch'); * @constructor * @extends {ol.interaction.Touch} * @param {ol.interaction.TouchPanOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.TouchPan = function(opt_options) { diff --git a/src/ol/interaction/touchrotateinteraction.js b/src/ol/interaction/touchrotateinteraction.js index db0f1a7615..617c522daf 100644 --- a/src/ol/interaction/touchrotateinteraction.js +++ b/src/ol/interaction/touchrotateinteraction.js @@ -22,6 +22,7 @@ ol.interaction.TOUCHROTATE_ANIMATION_DURATION = 250; * @constructor * @extends {ol.interaction.Touch} * @param {ol.interaction.TouchRotateOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.TouchRotate = function(opt_options) { diff --git a/src/ol/interaction/touchzoominteraction.js b/src/ol/interaction/touchzoominteraction.js index 8d1ece062b..17c2c9f3bc 100644 --- a/src/ol/interaction/touchzoominteraction.js +++ b/src/ol/interaction/touchzoominteraction.js @@ -16,6 +16,7 @@ goog.require('ol.interaction.Touch'); * @constructor * @extends {ol.interaction.Touch} * @param {ol.interaction.TouchZoomOptions=} opt_options Options. + * @todo stability experimental */ ol.interaction.TouchZoom = function(opt_options) { diff --git a/src/ol/iview2d.js b/src/ol/iview2d.js index 784b91f7b7..cd3cb188f4 100644 --- a/src/ol/iview2d.js +++ b/src/ol/iview2d.js @@ -24,6 +24,7 @@ ol.IView2D = function() { /** * @return {ol.Coordinate|undefined} Map center. + * @todo stability experimental */ ol.IView2D.prototype.getCenter = function() { }; @@ -31,6 +32,7 @@ ol.IView2D.prototype.getCenter = function() { /** * @return {ol.proj.Projection|undefined} Map projection. + * @todo stability experimental */ ol.IView2D.prototype.getProjection = function() { }; @@ -38,6 +40,7 @@ ol.IView2D.prototype.getProjection = function() { /** * @return {number|undefined} Map resolution. + * @todo stability experimental */ ol.IView2D.prototype.getResolution = function() { }; @@ -45,6 +48,7 @@ ol.IView2D.prototype.getResolution = function() { /** * @return {number|undefined} Map rotation. + * @todo stability experimental */ ol.IView2D.prototype.getRotation = function() { }; diff --git a/src/ol/kinetic.js b/src/ol/kinetic.js index 17e1e27d9c..7bdbf1a3d4 100644 --- a/src/ol/kinetic.js +++ b/src/ol/kinetic.js @@ -13,6 +13,7 @@ goog.require('ol.animation'); * @param {number} minVelocity Minimum velocity (pixels/millisecond). * @param {number} delay Delay to consider to calculate the kinetic * initial values (milliseconds). + * @todo stability experimental */ ol.Kinetic = function(decay, minVelocity, delay) { diff --git a/src/ol/layer/imagelayer.js b/src/ol/layer/imagelayer.js index 9718aeef27..f3d6b49ac9 100644 --- a/src/ol/layer/imagelayer.js +++ b/src/ol/layer/imagelayer.js @@ -9,6 +9,7 @@ goog.require('ol.source.Image'); * @constructor * @extends {ol.layer.Layer} * @param {ol.layer.LayerOptions} options Layer options. + * @todo stability experimental */ ol.layer.Image = function(options) { goog.base(this, options); diff --git a/src/ol/layer/layer.js b/src/ol/layer/layer.js index fae4420727..3da230571a 100644 --- a/src/ol/layer/layer.js +++ b/src/ol/layer/layer.js @@ -13,6 +13,7 @@ goog.require('ol.source.Source'); * @constructor * @extends {ol.layer.Base} * @param {ol.layer.LayerOptions} options Layer options. + * @todo stability experimental */ ol.layer.Layer = function(options) { @@ -62,6 +63,7 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_obj) { /** * @return {ol.source.Source} Source. + * @todo stability experimental */ ol.layer.Layer.prototype.getSource = function() { return this.source_; diff --git a/src/ol/layer/layergroup.js b/src/ol/layer/layergroup.js index 7336f682a4..0be13c959b 100644 --- a/src/ol/layer/layergroup.js +++ b/src/ol/layer/layergroup.js @@ -27,6 +27,7 @@ ol.layer.GroupProperty = { * @constructor * @extends {ol.layer.Base} * @param {ol.layer.GroupOptions=} opt_options Layer options. + * @todo stability experimental */ ol.layer.Group = function(opt_options) { @@ -146,6 +147,7 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) { /** * @return {ol.Collection} Collection of layers. + * @todo stability experimental */ ol.layer.Group.prototype.getLayers = function() { return /** @type {ol.Collection} */ (this.get( @@ -159,6 +161,7 @@ goog.exportProperty( /** * @param {ol.Collection} layers Collection of layers. + * @todo stability experimental */ ol.layer.Group.prototype.setLayers = function(layers) { this.set(ol.layer.GroupProperty.LAYERS, layers); diff --git a/src/ol/layer/tilelayer.js b/src/ol/layer/tilelayer.js index 12abf09a64..b8d10f520f 100644 --- a/src/ol/layer/tilelayer.js +++ b/src/ol/layer/tilelayer.js @@ -17,6 +17,7 @@ ol.layer.TileProperty = { * @constructor * @extends {ol.layer.Layer} * @param {ol.layer.TileOptions} options Tile layer options. + * @todo stability experimental */ ol.layer.Tile = function(options) { @@ -31,6 +32,7 @@ goog.inherits(ol.layer.Tile, ol.layer.Layer); /** * @return {number} Preload. + * @todo stability experimental */ ol.layer.Tile.prototype.getPreload = function() { return /** @type {number} */ (this.get(ol.layer.TileProperty.PRELOAD)); @@ -51,6 +53,7 @@ ol.layer.Tile.prototype.getTileSource = function() { /** * @param {number} preload Preload. + * @todo stability experimental */ ol.layer.Tile.prototype.setPreload = function(preload) { this.set(ol.layer.TileProperty.PRELOAD, preload); diff --git a/src/ol/layer/vectorlayer.js b/src/ol/layer/vectorlayer.js index d6dea95c45..235433a756 100644 --- a/src/ol/layer/vectorlayer.js +++ b/src/ol/layer/vectorlayer.js @@ -137,6 +137,7 @@ ol.layer.FeatureCache.prototype.remove = function(feature, opt_extent) { * @constructor * @extends {ol.layer.Layer} * @param {ol.layer.VectorLayerOptions} options Vector layer options. + * @todo stability experimental */ ol.layer.Vector = function(options) { diff --git a/src/ol/layer/vectorlayer2.js b/src/ol/layer/vectorlayer2.js index 8e86d76645..cdfeb4bac4 100644 --- a/src/ol/layer/vectorlayer2.js +++ b/src/ol/layer/vectorlayer2.js @@ -10,6 +10,7 @@ goog.require('ol.source.Vector2'); * @constructor * @extends {ol.layer.Layer} * @param {ol.layer.LayerOptions} options Options. + * @todo stability experimental */ ol.layer.Vector2 = function(options) { goog.base(this, options); diff --git a/src/ol/map.js b/src/ol/map.js index be7e9bc8c9..716e1e325b 100644 --- a/src/ol/map.js +++ b/src/ol/map.js @@ -87,6 +87,7 @@ ol.ENABLE_WEBGL = true; /** * @enum {string} + * @todo stability experimental */ ol.RendererHint = { CANVAS: 'canvas', @@ -141,6 +142,7 @@ ol.MapProperty = { * @constructor * @extends {ol.Object} * @param {ol.MapOptions} options Map options. + * @todo stability experimental */ ol.Map = function(options) { @@ -361,6 +363,7 @@ goog.inherits(ol.Map, ol.Object); /** * Add the given control to the map. * @param {ol.control.Control} control Control. + * @todo stability experimental */ ol.Map.prototype.addControl = function(control) { var controls = this.getControls(); @@ -373,6 +376,7 @@ ol.Map.prototype.addControl = function(control) { /** * Adds the given layer to the top of this map. * @param {ol.layer.Base} layer Layer. + * @todo stability experimental */ ol.Map.prototype.addLayer = function(layer) { var layers = this.getLayerGroup().getLayers(); @@ -384,6 +388,7 @@ ol.Map.prototype.addLayer = function(layer) { /** * Add the given overlay to the map. * @param {ol.Overlay} overlay Overlay. + * @todo stability experimental */ ol.Map.prototype.addOverlay = function(overlay) { var overlays = this.getOverlays(); @@ -398,6 +403,7 @@ ol.Map.prototype.addOverlay = function(overlay) { * animations before updating the map's view. The {@link ol.animation} * namespace provides several static methods for creating prerender functions. * @param {...ol.PreRenderFunction} var_args Any number of pre-render functions. + * @todo stability experimental */ ol.Map.prototype.beforeRender = function(var_args) { this.requestRenderFrame(); @@ -436,6 +442,7 @@ ol.Map.prototype.freezeRendering = function() { * Returns the map pixel position for a a browser event. * @param {Event} event Event. * @return {ol.Coordinate} Coordinate. + * @todo stability experimental */ ol.Map.prototype.getEventCoordinate = function(event) { return this.getCoordinateFromPixel(this.getEventPixel(event)); @@ -446,6 +453,7 @@ ol.Map.prototype.getEventCoordinate = function(event) { * Returns the geographical coordinate for a browser event. * @param {Event} event Event. * @return {ol.Pixel} Pixel. + * @todo stability experimental */ ol.Map.prototype.getEventPixel = function(event) { // goog.style.getRelativePosition is based on event.targetTouches, @@ -470,6 +478,7 @@ ol.Map.prototype.getEventPixel = function(event) { /** * Get the map's renderer. * @return {ol.renderer.Map} Renderer. + * @todo stability experimental */ ol.Map.prototype.getRenderer = function() { return this.renderer_; @@ -479,6 +488,7 @@ ol.Map.prototype.getRenderer = function() { /** * Get the element in which this map is rendered. * @return {Element|string|undefined} Target. + * @todo stability experimental */ ol.Map.prototype.getTarget = function() { return /** @type {Element|string|undefined} */ ( @@ -507,6 +517,7 @@ ol.Map.prototype.getCoordinateFromPixel = function(pixel) { /** * @return {ol.Collection} Controls. + * @todo stability experimental */ ol.Map.prototype.getControls = function() { return this.controls_; @@ -515,6 +526,7 @@ ol.Map.prototype.getControls = function() { /** * @return {ol.Collection} Overlays. + * @todo stability experimental */ ol.Map.prototype.getOverlays = function() { return this.overlays_; @@ -525,6 +537,7 @@ ol.Map.prototype.getOverlays = function() { * Get feature information for a pixel on the map. * * @param {ol.GetFeatureInfoOptions} options Options. + * @todo stability experimental */ ol.Map.prototype.getFeatureInfo = function(options) { var layers = goog.isDefAndNotNull(options.layers) ? @@ -538,6 +551,7 @@ ol.Map.prototype.getFeatureInfo = function(options) { * Get features for a pixel on the map. * * @param {ol.GetFeaturesOptions} options Options. + * @todo stability experimental */ ol.Map.prototype.getFeatures = function(options) { var layers = goog.isDefAndNotNull(options.layers) ? @@ -555,6 +569,7 @@ ol.Map.prototype.getFeatures = function(options) { * * Interactions are used for e.g. pan, zoom and rotate. * @return {ol.Collection} Interactions. + * @todo stability experimental */ ol.Map.prototype.getInteractions = function() { return this.interactions_; @@ -564,6 +579,7 @@ ol.Map.prototype.getInteractions = function() { /** * Get the layergroup associated with this map. * @return {ol.layer.Group} LayerGroup. + * @todo stability experimental */ ol.Map.prototype.getLayerGroup = function() { return /** @type {ol.layer.Group} */ ( @@ -578,6 +594,7 @@ goog.exportProperty( /** * Get the collection of layers associated with this map. * @return {ol.Collection} Layers. + * @todo stability experimental */ ol.Map.prototype.getLayers = function() { return this.getLayerGroup().getLayers(); @@ -602,6 +619,7 @@ ol.Map.prototype.getPixelFromCoordinate = function(coordinate) { /** * Get the size of this map. * @return {ol.Size|undefined} Size. + * @todo stability experimental */ ol.Map.prototype.getSize = function() { return /** @type {ol.Size|undefined} */ (this.get(ol.MapProperty.SIZE)); @@ -616,6 +634,7 @@ goog.exportProperty( * Get the view associated with this map. This can be a 2D or 3D view. A 2D * view manages properties such as center and resolution. * @return {ol.View} View. + * @todo stability experimental */ ol.Map.prototype.getView = function() { return /** @type {ol.View} */ (this.get(ol.MapProperty.VIEW)); @@ -628,6 +647,7 @@ goog.exportProperty( /** * @return {Element} Viewport. + * @todo stability experimental */ ol.Map.prototype.getViewport = function() { return this.viewport_; @@ -918,6 +938,7 @@ ol.Map.prototype.requestRenderFrame = function() { * @param {ol.control.Control} control Control. * @return {ol.control.Control|undefined} The removed control of undefined * if the control was not found. + * @todo stability experimental */ ol.Map.prototype.removeControl = function(control) { var controls = this.getControls(); @@ -935,6 +956,7 @@ ol.Map.prototype.removeControl = function(control) { * @param {ol.layer.Base} layer Layer. * @return {ol.layer.Base|undefined} The removed layer or undefined if the * layer was not found. + * @todo stability experimental */ ol.Map.prototype.removeLayer = function(layer) { var layers = this.getLayerGroup().getLayers(); @@ -948,6 +970,7 @@ ol.Map.prototype.removeLayer = function(layer) { * @param {ol.Overlay} overlay Overlay. * @return {ol.Overlay|undefined} The removed overlay of undefined * if the overlay was not found. + * @todo stability experimental */ ol.Map.prototype.removeOverlay = function(overlay) { var overlays = this.getOverlays(); @@ -1059,6 +1082,7 @@ ol.Map.prototype.renderFrame_ = function(time) { /** * Sets the layergroup of this map. * @param {ol.layer.Group} layerGroup Layergroup. + * @todo stability experimental */ ol.Map.prototype.setLayerGroup = function(layerGroup) { this.set(ol.MapProperty.LAYERGROUP, layerGroup); @@ -1072,6 +1096,7 @@ goog.exportProperty( /** * Set the size of this map. * @param {ol.Size|undefined} size Size. + * @todo stability experimental */ ol.Map.prototype.setSize = function(size) { this.set(ol.MapProperty.SIZE, size); @@ -1085,6 +1110,7 @@ goog.exportProperty( /** * Set the target element to render this map into. * @param {Element|string|undefined} target Target. + * @todo stability experimental */ ol.Map.prototype.setTarget = function(target) { this.set(ol.MapProperty.TARGET, target); @@ -1098,6 +1124,7 @@ goog.exportProperty( /** * Set the view for this map. * @param {ol.IView} view View. + * @todo stability experimental */ ol.Map.prototype.setView = function(view) { this.set(ol.MapProperty.VIEW, view); @@ -1122,6 +1149,7 @@ ol.Map.prototype.unfreezeRendering = function() { /** * Force a recalculation of the map viewport size. This should be called when * third-party code changes the size of the map viewport. + * @todo stability experimental */ ol.Map.prototype.updateSize = function() { var target = this.getTarget(); diff --git a/src/ol/mapbrowserevent.js b/src/ol/mapbrowserevent.js index a90bcc64d9..de24ec2085 100644 --- a/src/ol/mapbrowserevent.js +++ b/src/ol/mapbrowserevent.js @@ -23,6 +23,7 @@ goog.require('ol.Pixel'); * @param {ol.Map} map Map. * @param {goog.events.BrowserEvent} browserEvent Browser event. * @param {?ol.FrameState=} opt_frameState Frame state. + * @todo stability experimental */ ol.MapBrowserEvent = function(type, map, browserEvent, opt_frameState) { @@ -51,6 +52,7 @@ goog.inherits(ol.MapBrowserEvent, ol.MapEvent); /** * @return {ol.Coordinate} Coordinate. + * @todo stability experimental */ ol.MapBrowserEvent.prototype.getCoordinate = function() { if (goog.isNull(this.coordinate_)) { @@ -64,6 +66,7 @@ ol.MapBrowserEvent.prototype.getCoordinate = function() { /** * Get pixel offset of the event from the top-left corner of the map viewport. * @return {ol.Pixel} Pixel offset. + * @todo stability experimental */ ol.MapBrowserEvent.prototype.getPixel = function() { if (goog.isNull(this.pixel_)) { @@ -87,6 +90,7 @@ ol.MapBrowserEvent.prototype.isMouseActionButton = function() { * Prevents the default browser action. * @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault * @override + * @todo stability experimental */ ol.MapBrowserEvent.prototype.preventDefault = function() { goog.base(this, 'preventDefault'); @@ -98,6 +102,7 @@ ol.MapBrowserEvent.prototype.preventDefault = function() { * Prevents further propagation of the current event. * @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation * @override + * @todo stability experimental */ ol.MapBrowserEvent.prototype.stopPropagation = function() { goog.base(this, 'stopPropagation'); diff --git a/src/ol/object.js b/src/ol/object.js index a0cada9cec..4c9338a932 100644 --- a/src/ol/object.js +++ b/src/ol/object.js @@ -37,6 +37,7 @@ ol.ObjectProperty = { * @constructor * @extends {goog.events.EventTarget} * @param {Object.=} opt_values Values. + * @todo stability experimental */ ol.Object = function(opt_values) { goog.base(this); @@ -142,6 +143,7 @@ ol.Object.getSetterName = function(key) { * @param {string} key Key. * @param {ol.Object} target Target. * @param {string=} opt_targetKey Target key. + * @todo stability experimental */ ol.Object.prototype.bindTo = function(key, target, opt_targetKey) { @@ -162,6 +164,7 @@ ol.Object.prototype.bindTo = * Gets a value. * @param {string} key Key. * @return {*} Value. + * @todo stability experimental */ ol.Object.prototype.get = function(key) { var value; @@ -200,6 +203,7 @@ ol.Object.prototype.getKeys = function() { * objects that are bound to the object's property as well as the object * that it is bound to. * @param {string} key Key. + * @todo stability experimental */ ol.Object.prototype.notify = function(key) { var accessors = ol.Object.getAccessors(this); @@ -232,6 +236,7 @@ ol.Object.prototype.notifyInternal_ = function(key) { * @param {Object=} opt_scope Object is whose scope to call * the listener. * @return {goog.events.Key} Unique key for the listener. + * @todo stability experimental */ ol.Object.prototype.on = function(type, listener, opt_scope) { return goog.events.listen(this, type, listener, false, opt_scope); @@ -245,6 +250,7 @@ ol.Object.prototype.on = function(type, listener, opt_scope) { * @param {Object=} opt_scope Object is whose scope to call * the listener. * @return {goog.events.Key} Unique key for the listener. + * @todo stability experimental */ ol.Object.prototype.once = function(type, listener, opt_scope) { return goog.events.listenOnce(this, type, listener, false, opt_scope); @@ -255,6 +261,7 @@ ol.Object.prototype.once = function(type, listener, opt_scope) { * Sets a value. * @param {string} key Key. * @param {*} value Value. + * @todo stability experimental */ ol.Object.prototype.set = function(key, value) { var accessors = ol.Object.getAccessors(this); @@ -278,6 +285,7 @@ ol.Object.prototype.set = function(key, value) { /** * Sets a collection of key-value pairs. * @param {Object.} values Values. + * @todo stability experimental */ ol.Object.prototype.setValues = function(values) { var key, value, setterName; @@ -297,6 +305,7 @@ ol.Object.prototype.setValues = function(values) { * Removes a binding. Unbinding will set the unbound property to the current * value. The object will not be notified, as the value has not changed. * @param {string} key Key. + * @todo stability experimental */ ol.Object.prototype.unbind = function(key) { var listeners = ol.Object.getListeners(this); @@ -318,6 +327,7 @@ ol.Object.prototype.unbind = function(key) { * @param {Function} listener The listener function. * @param {Object=} opt_scope Object is whose scope to call * the listener. + * @todo stability experimental */ ol.Object.prototype.un = function(type, listener, opt_scope) { goog.events.unlisten(this, type, listener, false, opt_scope); @@ -328,6 +338,7 @@ ol.Object.prototype.un = function(type, listener, opt_scope) { * Removes an event listener which was added with listen() by the key returned * by on(). * @param {?number} key Key. + * @todo stability experimental */ ol.Object.prototype.unByKey = function(key) { goog.events.unlistenByKey(key); @@ -336,6 +347,7 @@ ol.Object.prototype.unByKey = function(key) { /** * Removes all bindings. + * @todo stability experimental */ ol.Object.prototype.unbindAll = function() { for (var key in ol.Object.getListeners(this)) { diff --git a/src/ol/ol.js b/src/ol/ol.js index d118ba330f..6a7e7312e6 100644 --- a/src/ol/ol.js +++ b/src/ol/ol.js @@ -9,6 +9,7 @@ goog.provide('ol'); * linter complains with: * * "Missing newline between constructor and goog.inherits" + * @todo stability experimental */ ol.inherits = goog.inherits; diff --git a/src/ol/overlay.js b/src/ol/overlay.js index 0a4eec0548..00156e5079 100644 --- a/src/ol/overlay.js +++ b/src/ol/overlay.js @@ -26,6 +26,7 @@ ol.OverlayProperty = { /** * @enum {string} + * @todo stability experimental */ ol.OverlayPositioning = { BOTTOM_LEFT: 'bottom-left', @@ -55,6 +56,7 @@ ol.OverlayPositioning = { * @constructor * @extends {ol.Object} * @param {ol.OverlayOptions} options Overlay options. + * @todo stability experimental */ ol.Overlay = function(options) { @@ -129,6 +131,7 @@ goog.inherits(ol.Overlay, ol.Object); /** * Get the DOM element of this overlay. * @return {Element|undefined} Element. + * @todo stability experimental */ ol.Overlay.prototype.getElement = function() { return /** @type {Element|undefined} */ ( @@ -143,6 +146,7 @@ goog.exportProperty( /** * Get the map associated with this overlay. * @return {ol.Map|undefined} Map. + * @todo stability experimental */ ol.Overlay.prototype.getMap = function() { return /** @type {ol.Map|undefined} */ ( @@ -157,6 +161,7 @@ goog.exportProperty( /** * Get the current position of this overlay. * @return {ol.Coordinate|undefined} Position. + * @todo stability experimental */ ol.Overlay.prototype.getPosition = function() { return /** @type {ol.Coordinate|undefined} */ ( @@ -171,6 +176,7 @@ goog.exportProperty( /** * Get the current positioning of this overlay. * @return {ol.OverlayPositioning|undefined} Positioning. + * @todo stability experimental */ ol.Overlay.prototype.getPositioning = function() { return /** @type {ol.OverlayPositioning|undefined} */ ( @@ -243,6 +249,7 @@ ol.Overlay.prototype.handlePositioningChanged = function() { /** * Set the DOM element to be associated with this overlay. * @param {Element|undefined} element Element. + * @todo stability experimental */ ol.Overlay.prototype.setElement = function(element) { this.set(ol.OverlayProperty.ELEMENT, element); @@ -256,6 +263,7 @@ goog.exportProperty( /** * Set the map to be associated with this overlay. * @param {ol.Map|undefined} map Map. + * @todo stability experimental */ ol.Overlay.prototype.setMap = function(map) { this.set(ol.OverlayProperty.MAP, map); @@ -269,6 +277,7 @@ goog.exportProperty( /** * Set the position for this overlay. * @param {ol.Coordinate|undefined} position Position. + * @todo stability experimental */ ol.Overlay.prototype.setPosition = function(position) { this.set(ol.OverlayProperty.POSITION, position); @@ -282,6 +291,7 @@ goog.exportProperty( /** * Set the positioning for this overlay. * @param {ol.OverlayPositioning|undefined} positioning Positioning. + * @todo stability experimental */ ol.Overlay.prototype.setPositioning = function(positioning) { this.set(ol.OverlayProperty.POSITIONING, positioning); diff --git a/src/ol/parser/geojsonparser.js b/src/ol/parser/geojsonparser.js index 3429b3456d..6966c098d3 100644 --- a/src/ol/parser/geojsonparser.js +++ b/src/ol/parser/geojsonparser.js @@ -24,6 +24,7 @@ goog.require('ol.parser.StringFeatureParser'); * @constructor * @implements {ol.parser.StringFeatureParser} * @extends {ol.parser.Parser} + * @todo stability experimental */ ol.parser.GeoJSON = function() {}; goog.inherits(ol.parser.GeoJSON, ol.parser.Parser); diff --git a/src/ol/parser/gpxparser.js b/src/ol/parser/gpxparser.js index 55c17fbaa8..bbe29264f3 100644 --- a/src/ol/parser/gpxparser.js +++ b/src/ol/parser/gpxparser.js @@ -23,6 +23,7 @@ goog.require('ol.parser.XML'); * @implements {ol.parser.ObjectFeatureParser} * @param {ol.parser.GPXOptions=} opt_options Optional configuration object. * @extends {ol.parser.XML} + * @todo stability experimental */ ol.parser.GPX = function(opt_options) { var options = /** @type {ol.parser.GPXOptions} */ diff --git a/src/ol/parser/kmlparser.js b/src/ol/parser/kmlparser.js index 6fdb95bac9..1fecd92d39 100644 --- a/src/ol/parser/kmlparser.js +++ b/src/ol/parser/kmlparser.js @@ -42,6 +42,7 @@ goog.require('ol.style.Stroke'); * @implements {ol.parser.AsyncStringFeatureParser} * @param {ol.parser.KMLOptions=} opt_options Optional configuration object. * @extends {ol.parser.XML} + * @todo stability experimental */ ol.parser.KML = function(opt_options) { var options = /** @type {ol.parser.KMLOptions} */ diff --git a/src/ol/parser/ogc/gmlparser_v2.js b/src/ol/parser/ogc/gmlparser_v2.js index ff83c9f46a..837b5d844e 100644 --- a/src/ol/parser/ogc/gmlparser_v2.js +++ b/src/ol/parser/ogc/gmlparser_v2.js @@ -13,6 +13,7 @@ goog.require('ol.parser.ogc.GML'); * @constructor * @param {ol.parser.GMLOptions=} opt_options Optional configuration object. * @extends {ol.parser.ogc.GML} + * @todo stability experimental */ ol.parser.ogc.GML_v2 = function(opt_options) { this.schemaLocation = 'http://www.opengis.net/gml ' + @@ -127,6 +128,7 @@ goog.inherits(ol.parser.ogc.GML_v2, ol.parser.ogc.GML); * GML. * @param {ol.parser.GMLWriteOptions=} opt_options Write options. * @return {string} A string representing the GML document. + * @todo stability experimental */ ol.parser.ogc.GML_v2.prototype.write = function(obj, opt_options) { this.applyWriteOptions(obj, opt_options); diff --git a/src/ol/parser/ogc/gmlparser_v3.js b/src/ol/parser/ogc/gmlparser_v3.js index 0812d1c9ac..47f06f9531 100644 --- a/src/ol/parser/ogc/gmlparser_v3.js +++ b/src/ol/parser/ogc/gmlparser_v3.js @@ -15,6 +15,7 @@ goog.require('ol.parser.ogc.GML'); * @constructor * @param {ol.parser.GMLOptions=} opt_options Optional configuration object. * @extends {ol.parser.ogc.GML} + * @todo stability experimental */ ol.parser.ogc.GML_v3 = function(opt_options) { this.schemaLocation = 'http://www.opengis.net/gml ' + @@ -425,6 +426,7 @@ goog.inherits(ol.parser.ogc.GML_v3, ol.parser.ogc.GML); * XML. * @param {ol.parser.GMLWriteOptions=} opt_options Write options. * @return {string} An string representing the XML document. + * @todo stability experimental */ ol.parser.ogc.GML_v3.prototype.write = function(obj, opt_options) { this.applyWriteOptions(obj, opt_options); diff --git a/src/ol/parser/ogc/wmscapabilitiesparser.js b/src/ol/parser/ogc/wmscapabilitiesparser.js index 82efbd4beb..b2e699c8af 100644 --- a/src/ol/parser/ogc/wmscapabilitiesparser.js +++ b/src/ol/parser/ogc/wmscapabilitiesparser.js @@ -43,6 +43,7 @@ ol.ENABLE_WMSCAPS_1_1_1_WMSC = true; * @constructor * @param {Object=} opt_options Options which will be set on this object. * @extends {ol.parser.ogc.Versioned} + * @todo stability experimental */ ol.parser.ogc.WMSCapabilities = function(opt_options) { opt_options = opt_options || {}; diff --git a/src/ol/parser/ogc/wmtscapabilitiesparser.js b/src/ol/parser/ogc/wmtscapabilitiesparser.js index 37c095e318..2bb20e5859 100644 --- a/src/ol/parser/ogc/wmtscapabilitiesparser.js +++ b/src/ol/parser/ogc/wmtscapabilitiesparser.js @@ -10,6 +10,7 @@ goog.require('ol.parser.ogc.WMTSCapabilities_v1_0_0'); * @constructor * @param {Object=} opt_options Options which will be set on this object. * @extends {ol.parser.ogc.Versioned} + * @todo stability experimental */ ol.parser.ogc.WMTSCapabilities = function(opt_options) { opt_options = opt_options || {}; diff --git a/src/ol/parser/parser.js b/src/ol/parser/parser.js index 8d6d214147..bf79f729a6 100644 --- a/src/ol/parser/parser.js +++ b/src/ol/parser/parser.js @@ -4,5 +4,6 @@ goog.provide('ol.parser.Parser'); /** * @constructor + * @todo stability experimental */ ol.parser.Parser = function() {}; diff --git a/src/ol/parser/topojsonparser.js b/src/ol/parser/topojsonparser.js index 8bcbaf57e6..e409756b75 100644 --- a/src/ol/parser/topojsonparser.js +++ b/src/ol/parser/topojsonparser.js @@ -20,6 +20,7 @@ goog.require('ol.parser.StringFeatureParser'); * @constructor * @implements {ol.parser.StringFeatureParser} * @extends {ol.parser.Parser} + * @todo stability experimental */ ol.parser.TopoJSON = function() {}; goog.inherits(ol.parser.TopoJSON, ol.parser.Parser); diff --git a/src/ol/parser/wktparser.js b/src/ol/parser/wktparser.js index 350ce4cda5..8e79e0a1e5 100644 --- a/src/ol/parser/wktparser.js +++ b/src/ol/parser/wktparser.js @@ -17,6 +17,7 @@ goog.require('ol.parser.Parser'); /** * @constructor * @extends {ol.parser.Parser} + * @todo stability experimental */ ol.parser.WKT = function() { }; diff --git a/src/ol/parser/xmlparser.js b/src/ol/parser/xmlparser.js index 09a4389792..a531e276eb 100644 --- a/src/ol/parser/xmlparser.js +++ b/src/ol/parser/xmlparser.js @@ -8,6 +8,7 @@ goog.require('ol.parser.Parser'); /** * @constructor * @extends {ol.parser.Parser} + * @todo stability experimental */ ol.parser.XML = function() { if (goog.global.ActiveXObject) { diff --git a/src/ol/proj/proj.js b/src/ol/proj/proj.js index 330561a19f..c6268dd3ec 100644 --- a/src/ol/proj/proj.js +++ b/src/ol/proj/proj.js @@ -28,12 +28,14 @@ ol.HAVE_PROJ4JS = ol.ENABLE_PROJ4JS && typeof Proj4js == 'object'; * A projection as {@link ol.proj.Projection}, SRS identifier string or * undefined. * @typedef {ol.proj.Projection|string|undefined} ol.proj.ProjectionLike + * @todo stability experimental */ ol.proj.ProjectionLike; /** * @enum {string} + * @todo stability experimental */ ol.proj.Units = { DEGREES: 'degrees', @@ -57,6 +59,7 @@ ol.METERS_PER_UNIT[ol.proj.Units.METERS] = 1; /** * @constructor * @param {ol.ProjectionOptions} options Projection options. + * @todo stability experimental */ ol.proj.Projection = function(options) { @@ -363,6 +366,7 @@ ol.proj.addProj4jsProjection_ = function(proj4jsProjection) { /** * @param {ol.proj.Projection} projection Projection. + * @todo stability experimental */ ol.proj.addProjection = function(projection) { var projections = ol.proj.projections_; @@ -460,6 +464,7 @@ ol.proj.removeTransform = function(source, destination) { * a combination of authority and identifier such as "EPSG:4326", or an * existing projection object, or undefined. * @return {ol.proj.Projection} Projection. + * @todo stability experimental */ ol.proj.get = function(projectionLike) { var projection; @@ -541,6 +546,7 @@ ol.proj.equivalent = function(projection1, projection2) { * @param {ol.proj.ProjectionLike} source Source. * @param {ol.proj.ProjectionLike} destination Destination. * @return {ol.TransformFunction} Transform. + * @todo stability experimental */ ol.proj.getTransform = function(source, destination) { var sourceProjection = ol.proj.get(source); @@ -557,6 +563,7 @@ ol.proj.getTransform = function(source, destination) { * @param {ol.proj.Projection} sourceProjection Source projection. * @param {ol.proj.Projection} destinationProjection Destination projection. * @return {ol.TransformFunction} Transform. + * @todo stability experimental */ ol.proj.getTransformFromProjections = function(sourceProjection, destinationProjection) { @@ -676,6 +683,7 @@ ol.proj.cloneTransform = function(input, opt_output, opt_dimension) { * @param {ol.proj.ProjectionLike} source Source. * @param {ol.proj.ProjectionLike} destination Destination. * @return {ol.Coordinate} Point. + * @todo stability experimental */ ol.proj.transform = function(point, source, destination) { var transformFn = ol.proj.getTransform(source, destination); @@ -690,6 +698,7 @@ ol.proj.transform = function(point, source, destination) { * @param {ol.proj.Projection} sourceProjection Source projection. * @param {ol.proj.Projection} destinationProjection Destination projection. * @return {ol.Coordinate} Point. + * @todo stability experimental */ ol.proj.transformWithProjections = function(point, sourceProjection, destinationProjection) { @@ -702,6 +711,7 @@ ol.proj.transformWithProjections = /** * @param {ol.Proj4jsProjectionOptions} options Proj4js projection options. * @return {ol.proj.Projection} Proj4js projection. + * @todo stability experimental */ ol.proj.configureProj4jsProjection = function(options) { goog.asserts.assert(!goog.object.containsKey( diff --git a/src/ol/size.js b/src/ol/size.js index 2b13500c36..f4305b8046 100644 --- a/src/ol/size.js +++ b/src/ol/size.js @@ -5,6 +5,7 @@ goog.provide('ol.size'); /** * An array of numbers representing a size: `[width, height]`. * @typedef {Array.} ol.Size + * @todo stability experimental */ ol.Size; diff --git a/src/ol/source/bingmapssource.js b/src/ol/source/bingmapssource.js index 930fb6f436..a19eac70a0 100644 --- a/src/ol/source/bingmapssource.js +++ b/src/ol/source/bingmapssource.js @@ -19,6 +19,7 @@ goog.require('ol.tilegrid.XYZ'); * @constructor * @extends {ol.source.TileImage} * @param {ol.source.BingMapsOptions} options Bing Maps options. + * @todo stability experimental */ ol.source.BingMaps = function(options) { diff --git a/src/ol/source/debugtilesource.js b/src/ol/source/debugtilesource.js index 8c53bce520..15a7b1bb15 100644 --- a/src/ol/source/debugtilesource.js +++ b/src/ol/source/debugtilesource.js @@ -85,6 +85,7 @@ ol.DebugTile_.prototype.getImage = function(opt_context) { * @constructor * @extends {ol.source.Tile} * @param {ol.source.TileDebugOptions} options Debug tile options. + * @todo stability experimental */ ol.source.TileDebug = function(options) { diff --git a/src/ol/source/featureinfosource.js b/src/ol/source/featureinfosource.js index 6d061866c0..61f4d116ec 100644 --- a/src/ol/source/featureinfosource.js +++ b/src/ol/source/featureinfosource.js @@ -4,6 +4,7 @@ goog.provide('ol.source.FeatureInfoSource'); /** * @interface + * @todo stability experimental */ ol.source.FeatureInfoSource = function() {}; diff --git a/src/ol/source/imagesource.js b/src/ol/source/imagesource.js index ad5e77a519..31b9c1d384 100644 --- a/src/ol/source/imagesource.js +++ b/src/ol/source/imagesource.js @@ -21,6 +21,7 @@ goog.require('ol.source.Source'); * resolutions: (Array.|undefined), * imageUrlFunction: (ol.ImageUrlFunctionType| * undefined)}} + * @todo stability experimental */ ol.source.ImageOptions; @@ -30,6 +31,7 @@ ol.source.ImageOptions; * @constructor * @extends {ol.source.Source} * @param {ol.source.ImageOptions} options Single image source options. + * @todo stability experimental */ ol.source.Image = function(options) { diff --git a/src/ol/source/imagestaticsource.js b/src/ol/source/imagestaticsource.js index 4f15199c41..8a3cae06ca 100644 --- a/src/ol/source/imagestaticsource.js +++ b/src/ol/source/imagestaticsource.js @@ -12,6 +12,7 @@ goog.require('ol.source.Image'); * @constructor * @extends {ol.source.Image} * @param {ol.source.ImageStaticOptions} options Options. + * @todo stability experimental */ ol.source.ImageStatic = function(options) { diff --git a/src/ol/source/imagewmssource.js b/src/ol/source/imagewmssource.js index e3293703a9..5a408687d1 100644 --- a/src/ol/source/imagewmssource.js +++ b/src/ol/source/imagewmssource.js @@ -16,6 +16,7 @@ goog.require('ol.source.wms'); * @extends {ol.source.Image} * @implements {ol.source.FeatureInfoSource} * @param {ol.source.ImageWMSOptions} options Options. + * @todo stability experimental */ ol.source.ImageWMS = function(options) { diff --git a/src/ol/source/mapquestsource.js b/src/ol/source/mapquestsource.js index fb5b60f5a0..126072087a 100644 --- a/src/ol/source/mapquestsource.js +++ b/src/ol/source/mapquestsource.js @@ -11,6 +11,7 @@ goog.require('ol.source.XYZ'); * @constructor * @extends {ol.source.XYZ} * @param {ol.source.MapQuestOptions=} opt_options MapQuest options. + * @todo stability experimental */ ol.source.MapQuestOSM = function(opt_options) { @@ -43,6 +44,7 @@ goog.inherits(ol.source.MapQuestOSM, ol.source.XYZ); * @constructor * @extends {ol.source.XYZ} * @param {ol.source.MapQuestOptions=} opt_options MapQuest options. + * @todo stability experimental */ ol.source.MapQuestOpenAerial = function(opt_options) { diff --git a/src/ol/source/osmsource.js b/src/ol/source/osmsource.js index 1f31a55f07..92e13ec6b8 100644 --- a/src/ol/source/osmsource.js +++ b/src/ol/source/osmsource.js @@ -9,6 +9,7 @@ goog.require('ol.source.XYZ'); * @constructor * @extends {ol.source.XYZ} * @param {ol.source.OSMOptions=} opt_options Open Street Map options. + * @todo stability experimental */ ol.source.OSM = function(opt_options) { diff --git a/src/ol/source/source.js b/src/ol/source/source.js index 83a4b2ae6d..3f5a46d2d1 100644 --- a/src/ol/source/source.js +++ b/src/ol/source/source.js @@ -24,6 +24,7 @@ ol.source.State = { * logo: (string|undefined), * projection: ol.proj.ProjectionLike, * state: (ol.source.State|undefined)}} + * @todo stability experimental */ ol.source.SourceOptions; @@ -33,6 +34,7 @@ ol.source.SourceOptions; * @constructor * @extends {goog.events.EventTarget} * @param {ol.source.SourceOptions} options Source options. + * @todo stability experimental */ ol.source.Source = function(options) { diff --git a/src/ol/source/stamensource.js b/src/ol/source/stamensource.js index 27bc6eb90e..34509ac611 100644 --- a/src/ol/source/stamensource.js +++ b/src/ol/source/stamensource.js @@ -81,6 +81,7 @@ ol.source.StamenProviderConfig = { * @constructor * @extends {ol.source.XYZ} * @param {ol.source.StamenOptions} options Stamen options. + * @todo stability experimental */ ol.source.Stamen = function(options) { diff --git a/src/ol/source/tileimagesource.js b/src/ol/source/tileimagesource.js index 6a50826732..dd9da53a21 100644 --- a/src/ol/source/tileimagesource.js +++ b/src/ol/source/tileimagesource.js @@ -25,6 +25,7 @@ goog.require('ol.tilegrid.TileGrid'); * tileGrid: (ol.tilegrid.TileGrid|undefined), * tileLoadFunction: (ol.TileLoadFunctionType|undefined), * tileUrlFunction: (ol.TileUrlFunctionType|undefined)}} + * @todo stability experimental */ ol.source.TileImageOptions; @@ -34,6 +35,7 @@ ol.source.TileImageOptions; * @constructor * @extends {ol.source.Tile} * @param {ol.source.TileImageOptions} options Image tile options. + * @todo stability experimental */ ol.source.TileImage = function(options) { diff --git a/src/ol/source/tilejsonsource.js b/src/ol/source/tilejsonsource.js index e31b9d83e0..81e57f6098 100644 --- a/src/ol/source/tilejsonsource.js +++ b/src/ol/source/tilejsonsource.js @@ -41,6 +41,7 @@ goog.exportSymbol('grid', grid); * @constructor * @extends {ol.source.TileImage} * @param {ol.source.TileJSONOptions} options TileJSON options. + * @todo stability experimental */ ol.source.TileJSON = function(options) { diff --git a/src/ol/source/tilesource.js b/src/ol/source/tilesource.js index 6588072121..e40c93d937 100644 --- a/src/ol/source/tilesource.js +++ b/src/ol/source/tilesource.js @@ -18,6 +18,7 @@ goog.require('ol.tilegrid.TileGrid'); * opaque: (boolean|undefined), * projection: ol.proj.ProjectionLike, * tileGrid: (ol.tilegrid.TileGrid|undefined)}} + * @todo stability experimental */ ol.source.TileOptions; @@ -27,6 +28,7 @@ ol.source.TileOptions; * @constructor * @extends {ol.source.Source} * @param {ol.source.TileOptions} options Tile source options. + * @todo stability experimental */ ol.source.Tile = function(options) { diff --git a/src/ol/source/tilewmssource.js b/src/ol/source/tilewmssource.js index f9751e62ff..48c2d15876 100644 --- a/src/ol/source/tilewmssource.js +++ b/src/ol/source/tilewmssource.js @@ -20,6 +20,7 @@ goog.require('ol.source.wms'); * @extends {ol.source.TileImage} * @implements {ol.source.FeatureInfoSource} * @param {ol.source.TileWMSOptions} options Tile WMS options. + * @todo stability experimental */ ol.source.TileWMS = function(options) { @@ -127,6 +128,7 @@ ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) { * Get the user-provided params, i.e. those passed to the constructor through * the "params" option, and possibly updated using the updateParams method. * @return {Object} Params. + * @todo stability experimental */ ol.source.TileWMS.prototype.getParams = function() { return this.params_; @@ -172,6 +174,7 @@ ol.source.TileWMS.prototype.resetCoordKeyPrefix_ = function() { /** * Update the user-provided params. * @param {Object} params Params. + * @todo stability experimental */ ol.source.TileWMS.prototype.updateParams = function(params) { goog.object.extend(this.params_, params); diff --git a/src/ol/source/vectorsource.js b/src/ol/source/vectorsource.js index 4c24b94a1c..32afe70bfe 100644 --- a/src/ol/source/vectorsource.js +++ b/src/ol/source/vectorsource.js @@ -21,6 +21,7 @@ ol.source.VectorLoadState = { * @constructor * @extends {ol.source.Source} * @param {ol.source.VectorOptions} options Vector source options. + * @todo stability experimental */ ol.source.Vector = function(options) { diff --git a/src/ol/source/vectorsource2.js b/src/ol/source/vectorsource2.js index a4ea79dc01..812d724896 100644 --- a/src/ol/source/vectorsource2.js +++ b/src/ol/source/vectorsource2.js @@ -11,6 +11,7 @@ goog.require('ol.source.Source'); * @constructor * @extends {ol.source.Source} * @param {ol.source.Vector2Options} options Options. + * @todo stability experimental */ ol.source.Vector2 = function(options) { diff --git a/src/ol/source/wmssource.js b/src/ol/source/wmssource.js index 36626c7257..f2ff28a3c8 100644 --- a/src/ol/source/wmssource.js +++ b/src/ol/source/wmssource.js @@ -9,6 +9,7 @@ goog.require('goog.uri.utils'); /** * Method to use to get WMS feature info. * @enum {string} + * @todo stability experimental */ ol.source.WMSGetFeatureInfoMethod = { /** diff --git a/src/ol/source/wmtssource.js b/src/ol/source/wmtssource.js index 767c85e5aa..7136aaa3d2 100644 --- a/src/ol/source/wmtssource.js +++ b/src/ol/source/wmtssource.js @@ -29,6 +29,7 @@ ol.source.WMTSRequestEncoding = { * @constructor * @extends {ol.source.TileImage} * @param {ol.source.WMTSOptions} options WMTS options. + * @todo stability experimental */ ol.source.WMTS = function(options) { @@ -193,6 +194,7 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage); * "dimensions" option, and possibly updated using the updateDimensions * method. * @return {Object} Dimensions. + * @todo stability experimental */ ol.source.WMTS.prototype.getDimensions = function() { return this.dimensions_; @@ -223,6 +225,7 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() { /** * Update the dimensions. * @param {Object} dimensions Dimensions. + * @todo stability experimental */ ol.source.WMTS.prototype.updateDimensions = function(dimensions) { goog.object.extend(this.dimensions_, dimensions); @@ -235,6 +238,7 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) { * @param {Object} wmtsCap An object representing the capabilities document. * @param {string} layer The layer identifier. * @return {ol.source.WMTSOptions} WMTS source options object. + * @todo stability experimental */ ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) { diff --git a/src/ol/source/xyzsource.js b/src/ol/source/xyzsource.js index f25339064b..baf5b67b3a 100644 --- a/src/ol/source/xyzsource.js +++ b/src/ol/source/xyzsource.js @@ -13,6 +13,7 @@ goog.require('ol.tilegrid.XYZ'); * @constructor * @extends {ol.source.TileImage} * @param {ol.source.XYZOptions} options XYZ options. + * @todo stability experimental */ ol.source.XYZ = function(options) { @@ -67,6 +68,7 @@ ol.source.XYZ.prototype.setTileUrlFunction = function(tileUrlFunction) { /** * @param {string} url URL. + * @todo stability experimental */ ol.source.XYZ.prototype.setUrl = function(url) { this.setTileUrlFunction(ol.TileUrlFunction.createFromTemplates( diff --git a/src/ol/structs/buffer.js b/src/ol/structs/buffer.js index 91848768c2..1a3aad615f 100644 --- a/src/ol/structs/buffer.js +++ b/src/ol/structs/buffer.js @@ -28,6 +28,7 @@ ol.BUFFER_REPLACE_UNUSED_ENTRIES_WITH_NANS = goog.DEBUG; * @param {Array.=} opt_arr Array. * @param {number=} opt_used Used. * @param {number=} opt_usage Usage. + * @todo stability experimental */ ol.structs.Buffer = function(opt_arr, opt_used, opt_usage) { diff --git a/src/ol/style/fillsymbolizer.js b/src/ol/style/fillsymbolizer.js index 0ef25c967a..7ca87aee96 100644 --- a/src/ol/style/fillsymbolizer.js +++ b/src/ol/style/fillsymbolizer.js @@ -15,6 +15,7 @@ goog.require('ol.style.Symbolizer'); * @constructor * @extends {ol.style.Symbolizer} * @param {ol.style.FillOptions=} opt_options Polygon options. + * @todo stability experimental */ ol.style.Fill = function(opt_options) { goog.base(this); diff --git a/src/ol/style/iconsymbolizer.js b/src/ol/style/iconsymbolizer.js index d8e8c0556e..911ea3a968 100644 --- a/src/ol/style/iconsymbolizer.js +++ b/src/ol/style/iconsymbolizer.js @@ -15,6 +15,7 @@ goog.require('ol.style.Point'); * @constructor * @extends {ol.style.Point} * @param {ol.style.IconOptions} options Icon options. + * @todo stability experimental */ ol.style.Icon = function(options) { goog.base(this); diff --git a/src/ol/style/rule.js b/src/ol/style/rule.js index 4d94c669eb..b06e03cae9 100644 --- a/src/ol/style/rule.js +++ b/src/ol/style/rule.js @@ -12,6 +12,7 @@ goog.require('ol.style.Symbolizer'); /** * @constructor * @param {ol.style.RuleOptions} options Rule options. + * @todo stability experimental */ ol.style.Rule = function(options) { diff --git a/src/ol/style/shapeliteral.js b/src/ol/style/shapeliteral.js index 602c58c28b..9879f89946 100644 --- a/src/ol/style/shapeliteral.js +++ b/src/ol/style/shapeliteral.js @@ -7,6 +7,7 @@ goog.require('ol.style.PointLiteral'); /** * @enum {string} + * @todo stability experimental */ ol.style.ShapeType = { CIRCLE: 'circle' diff --git a/src/ol/style/shapesymbolizer.js b/src/ol/style/shapesymbolizer.js index 699ad9b364..137580b034 100644 --- a/src/ol/style/shapesymbolizer.js +++ b/src/ol/style/shapesymbolizer.js @@ -18,6 +18,7 @@ goog.require('ol.style.Stroke'); * @constructor * @extends {ol.style.Point} * @param {ol.style.ShapeOptions} options Shape options. + * @todo stability experimental */ ol.style.Shape = function(options) { goog.base(this); diff --git a/src/ol/style/strokesymbolizer.js b/src/ol/style/strokesymbolizer.js index 1c3c5605b1..ab268948ef 100644 --- a/src/ol/style/strokesymbolizer.js +++ b/src/ol/style/strokesymbolizer.js @@ -17,6 +17,7 @@ goog.require('ol.style.Symbolizer'); * @constructor * @extends {ol.style.Symbolizer} * @param {ol.style.StrokeOptions=} opt_options Stroke options. + * @todo stability experimental */ ol.style.Stroke = function(opt_options) { goog.base(this); diff --git a/src/ol/style/style.js b/src/ol/style/style.js index f4b832b188..1a99081935 100644 --- a/src/ol/style/style.js +++ b/src/ol/style/style.js @@ -21,6 +21,7 @@ goog.require('ol.style.Symbolizer'); /** * @constructor * @param {ol.style.StyleOptions} options Style options. + * @todo stability experimental */ ol.style.Style = function(options) { diff --git a/src/ol/tile.js b/src/ol/tile.js index 9b35b5ec2d..610150083e 100644 --- a/src/ol/tile.js +++ b/src/ol/tile.js @@ -72,6 +72,7 @@ ol.Tile.prototype.getKey = function() { /** * @return {ol.TileCoord} + * @todo stability experimental */ ol.Tile.prototype.getTileCoord = function() { return this.tileCoord; diff --git a/src/ol/tilegrid/tilegrid.js b/src/ol/tilegrid/tilegrid.js index 6285376d21..59bf95fb61 100644 --- a/src/ol/tilegrid/tilegrid.js +++ b/src/ol/tilegrid/tilegrid.js @@ -28,6 +28,7 @@ ol.DEFAULT_MAX_ZOOM = 42; /** * @constructor * @param {ol.tilegrid.TileGridOptions} options Tile grid options. + * @todo stability experimental */ ol.tilegrid.TileGrid = function(options) { @@ -138,6 +139,7 @@ ol.tilegrid.TileGrid.prototype.forEachTileCoordParentTileRange = /** * @return {number} Max zoom. + * @todo stability experimental */ ol.tilegrid.TileGrid.prototype.getMaxZoom = function() { return this.maxZoom; @@ -146,6 +148,7 @@ ol.tilegrid.TileGrid.prototype.getMaxZoom = function() { /** * @return {number} Min zoom. + * @todo stability experimental */ ol.tilegrid.TileGrid.prototype.getMinZoom = function() { return this.minZoom; @@ -155,6 +158,7 @@ ol.tilegrid.TileGrid.prototype.getMinZoom = function() { /** * @param {number} z Z. * @return {ol.Coordinate} Origin. + * @todo stability experimental */ ol.tilegrid.TileGrid.prototype.getOrigin = function(z) { if (!goog.isNull(this.origin_)) { @@ -179,6 +183,7 @@ ol.tilegrid.TileGrid.prototype.getResolution = function(z) { /** * @return {Array.} Resolutions. + * @todo stability experimental */ ol.tilegrid.TileGrid.prototype.getResolutions = function() { return this.resolutions_; @@ -367,6 +372,7 @@ ol.tilegrid.TileGrid.prototype.getTileCoordResolution = function(tileCoord) { /** * @param {number} z Z. * @return {ol.Size} Tile size. + * @todo stability experimental */ ol.tilegrid.TileGrid.prototype.getTileSize = function(z) { if (!goog.isNull(this.tileSize_)) { diff --git a/src/ol/tilegrid/wmtstilegrid.js b/src/ol/tilegrid/wmtstilegrid.js index a49940b552..108840ecd4 100644 --- a/src/ol/tilegrid/wmtstilegrid.js +++ b/src/ol/tilegrid/wmtstilegrid.js @@ -11,6 +11,7 @@ goog.require('ol.tilegrid.TileGrid'); * @constructor * @extends {ol.tilegrid.TileGrid} * @param {ol.tilegrid.WMTSOptions} options WMTS options. + * @todo stability experimental */ ol.tilegrid.WMTS = function(options) { @@ -48,6 +49,7 @@ ol.tilegrid.WMTS.prototype.getMatrixId = function(z) { /** * @return {Array.} MatrixIds. + * @todo stability experimental */ ol.tilegrid.WMTS.prototype.getMatrixIds = function() { return this.matrixIds_; diff --git a/src/ol/tilegrid/xyztilegrid.js b/src/ol/tilegrid/xyztilegrid.js index a68d754ed9..aba7b4cc16 100644 --- a/src/ol/tilegrid/xyztilegrid.js +++ b/src/ol/tilegrid/xyztilegrid.js @@ -13,6 +13,7 @@ goog.require('ol.tilegrid.TileGrid'); * @constructor * @extends {ol.tilegrid.TileGrid} * @param {ol.tilegrid.XYZOptions} options XYZ options. + * @todo stability experimental */ ol.tilegrid.XYZ = function(options) { diff --git a/src/ol/transformfunction.js b/src/ol/transformfunction.js index b5fb315d69..3bf13896ec 100644 --- a/src/ol/transformfunction.js +++ b/src/ol/transformfunction.js @@ -8,5 +8,6 @@ goog.provide('ol.TransformFunction'); * returns the output array. * * @typedef {function(Array., Array.=, number=): Array.} + * @todo stability experimental */ ol.TransformFunction; diff --git a/src/ol/view2d.js b/src/ol/view2d.js index be24bf532e..910dec9e49 100644 --- a/src/ol/view2d.js +++ b/src/ol/view2d.js @@ -22,6 +22,7 @@ goog.require('ol.proj.Units'); /** * @enum {string} + * @todo stability experimental */ ol.View2DProperty = { CENTER: 'center', @@ -84,6 +85,7 @@ ol.View2DProperty = { * @implements {ol.IView3D} * @extends {ol.View} * @param {ol.View2DOptions=} opt_options View2D options. + * @todo stability experimental */ ol.View2D = function(opt_options) { goog.base(this); @@ -189,6 +191,7 @@ ol.View2D.prototype.constrainCenter = function(center) { * @param {number=} opt_delta Delta. * @param {number=} opt_direction Direction. * @return {number|undefined} Constrained resolution. + * @todo stability experimental */ ol.View2D.prototype.constrainResolution = function( resolution, opt_delta, opt_direction) { @@ -203,6 +206,7 @@ ol.View2D.prototype.constrainResolution = function( * @param {number|undefined} rotation Rotation. * @param {number=} opt_delta Delta. * @return {number|undefined} Constrained rotation. + * @todo stability experimental */ ol.View2D.prototype.constrainRotation = function(rotation, opt_delta) { var delta = opt_delta || 0; @@ -228,6 +232,7 @@ goog.exportProperty( * resolution and the current center. * @param {ol.Size} size Box pixel size. * @return {ol.Extent} Extent. + * @todo stability experimental */ ol.View2D.prototype.calculateExtent = function(size) { goog.asserts.assert(this.isDef()); @@ -378,6 +383,7 @@ ol.View2D.prototype.getView3D = function() { * Get the current zoom level. Return undefined if the current * resolution is undefined or not a "constrained resolution". * @return {number|undefined} Zoom. + * @todo stability experimental */ ol.View2D.prototype.getZoom = function() { var zoom; @@ -403,6 +409,7 @@ ol.View2D.prototype.getZoom = function() { * Fit the given extent based on the given map size. * @param {ol.Extent} extent Extent. * @param {ol.Size} size Box pixel size. + * @todo stability experimental */ ol.View2D.prototype.fitExtent = function(extent, size) { this.setCenter(ol.extent.getCenter(extent)); @@ -424,6 +431,7 @@ ol.View2D.prototype.isDef = function() { /** * Set the center of the current view. * @param {ol.Coordinate|undefined} center Center. + * @todo stability experimental */ ol.View2D.prototype.setCenter = function(center) { this.set(ol.View2DProperty.CENTER, center); @@ -438,6 +446,7 @@ goog.exportProperty( * Set the projection of this view. * Warning! This code is not yet implemented. Function should not be used. * @param {ol.proj.Projection|undefined} projection Projection. + * @todo stability experimental */ ol.View2D.prototype.setProjection = function(projection) { this.set(ol.View2DProperty.PROJECTION, projection); @@ -451,6 +460,7 @@ goog.exportProperty( /** * Set the resolution for this view. * @param {number|undefined} resolution Resolution. + * @todo stability experimental */ ol.View2D.prototype.setResolution = function(resolution) { this.set(ol.View2DProperty.RESOLUTION, resolution); @@ -464,6 +474,7 @@ goog.exportProperty( /** * Set the rotation for this view. * @param {number|undefined} rotation Rotation. + * @todo stability experimental */ ol.View2D.prototype.setRotation = function(rotation) { this.set(ol.View2DProperty.ROTATION, rotation); @@ -477,6 +488,7 @@ goog.exportProperty( /** * Zoom to a specific zoom level. * @param {number} zoom Zoom level. + * @todo stability experimental */ ol.View2D.prototype.setZoom = function(zoom) { var resolution = this.constrainResolution(this.maxResolution_, zoom, 0);