diff --git a/src/ol/animation.exports b/src/ol/animation.exports deleted file mode 100644 index 5cab49819d..0000000000 --- a/src/ol/animation.exports +++ /dev/null @@ -1,4 +0,0 @@ -@exportSymbol ol.animation.bounce -@exportSymbol ol.animation.pan -@exportSymbol ol.animation.rotate -@exportSymbol ol.animation.zoom diff --git a/src/ol/animation.js b/src/ol/animation.js index 50c69921d5..e0bb3b7a16 100644 --- a/src/ol/animation.js +++ b/src/ol/animation.js @@ -12,6 +12,7 @@ goog.require('ol.easing'); * @param {olx.animation.BounceOptions} options Bounce options. * @return {ol.PreRenderFunction} Pre-render function. * @todo stability experimental + * @todo api */ ol.animation.bounce = function(options) { var resolution = options.resolution; @@ -47,6 +48,7 @@ ol.animation.bounce = function(options) { * @param {olx.animation.PanOptions} options Pan options. * @return {ol.PreRenderFunction} Pre-render function. * @todo stability experimental + * @todo api */ ol.animation.pan = function(options) { var source = options.source; @@ -86,6 +88,7 @@ ol.animation.pan = function(options) { * @param {olx.animation.RotateOptions} options Rotate options. * @return {ol.PreRenderFunction} Pre-render function. * @todo stability experimental + * @todo api */ ol.animation.rotate = function(options) { var sourceRotation = goog.isDef(options.rotation) ? options.rotation : 0; @@ -131,6 +134,7 @@ ol.animation.rotate = function(options) { * @param {olx.animation.ZoomOptions} options Zoom options. * @return {ol.PreRenderFunction} Pre-render function. * @todo stability experimental + * @todo api */ ol.animation.zoom = function(options) { var sourceResolution = options.resolution; diff --git a/src/ol/attribution.exports b/src/ol/attribution.exports deleted file mode 100644 index 053c0abeae..0000000000 --- a/src/ol/attribution.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.Attribution diff --git a/src/ol/attribution.js b/src/ol/attribution.js index 3c95c8b83d..bfaebf8364 100644 --- a/src/ol/attribution.js +++ b/src/ol/attribution.js @@ -23,6 +23,7 @@ goog.require('ol.TileRange'); * @param {olx.AttributionOptions} options Attribution options. * @struct * @todo stability experimental + * @todo api */ ol.Attribution = function(options) { diff --git a/src/ol/browserfeature.exports b/src/ol/browserfeature.exports deleted file mode 100644 index 832c611d89..0000000000 --- a/src/ol/browserfeature.exports +++ /dev/null @@ -1,7 +0,0 @@ -@exportSymbol ol.BrowserFeature -@exportProperty ol.BrowserFeature.DEVICE_PIXEL_RATIO -@exportProperty ol.BrowserFeature.HAS_CANVAS -@exportProperty ol.BrowserFeature.HAS_DEVICE_ORIENTATION -@exportProperty ol.BrowserFeature.HAS_GEOLOCATION -@exportProperty ol.BrowserFeature.HAS_TOUCH -@exportProperty ol.BrowserFeature.HAS_WEBGL diff --git a/src/ol/browserfeature.js b/src/ol/browserfeature.js index 939a8d9081..411c812db1 100644 --- a/src/ol/browserfeature.js +++ b/src/ol/browserfeature.js @@ -78,6 +78,7 @@ ol.IS_LEGACY_IE = goog.userAgent.IE && * @const * @type {number} * @todo stability experimental + * @todo api */ ol.BrowserFeature.DEVICE_PIXEL_RATIO = goog.global.devicePixelRatio || 1; @@ -104,6 +105,7 @@ ol.BrowserFeature.HAS_CANVAS_LINE_DASH = false; * @const * @type {boolean} * @todo stability experimental + * @todo api */ ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && ( /** @@ -134,6 +136,7 @@ ol.BrowserFeature.HAS_CANVAS = ol.ENABLE_CANVAS && ( * @const * @type {boolean} * @todo stability experimental + * @todo api */ ol.BrowserFeature.HAS_DEVICE_ORIENTATION = 'DeviceOrientationEvent' in goog.global; @@ -153,6 +156,7 @@ ol.BrowserFeature.HAS_DOM = ol.ENABLE_DOM; * @const * @type {boolean} * @todo stability experimental + * @todo api */ ol.BrowserFeature.HAS_GEOLOCATION = 'geolocation' in goog.global.navigator; @@ -171,6 +175,7 @@ ol.BrowserFeature.HAS_JSON_PARSE = * @const * @type {boolean} * @todo stability experimental + * @todo api */ ol.BrowserFeature.HAS_TOUCH = ol.ASSUME_TOUCH || 'ontouchstart' in goog.global; diff --git a/src/ol/collection.exports b/src/ol/collection.exports deleted file mode 100644 index afd0bd9b97..0000000000 --- a/src/ol/collection.exports +++ /dev/null @@ -1,13 +0,0 @@ -@exportSymbol ol.Collection -@exportProperty ol.Collection.prototype.clear -@exportProperty ol.Collection.prototype.extend -@exportProperty ol.Collection.prototype.forEach -@exportProperty ol.Collection.prototype.getArray -@exportProperty ol.Collection.prototype.getAt -@exportProperty ol.Collection.prototype.getLength -@exportProperty ol.Collection.prototype.insertAt -@exportProperty ol.Collection.prototype.pop -@exportProperty ol.Collection.prototype.push -@exportProperty ol.Collection.prototype.remove -@exportProperty ol.Collection.prototype.removeAt -@exportProperty ol.Collection.prototype.setAt diff --git a/src/ol/collection.js b/src/ol/collection.js index 6d0fa3e96c..6c44ac50c5 100644 --- a/src/ol/collection.js +++ b/src/ol/collection.js @@ -72,6 +72,7 @@ ol.CollectionProperty = { * @param {Array=} opt_array Array. * @todo stability experimental * @todo observable length {number} readonly the length of the array + * @todo api */ ol.Collection = function(opt_array) { @@ -92,6 +93,7 @@ goog.inherits(ol.Collection, ol.Object); /** * Remove all elements from the collection. * @todo stability experimental + * @todo api */ ol.Collection.prototype.clear = function() { while (this.getLength() > 0) { @@ -104,6 +106,7 @@ ol.Collection.prototype.clear = function() { * @param {Array} arr Array. * @return {ol.Collection} This collection. * @todo stability experimental + * @todo api */ ol.Collection.prototype.extend = function(arr) { var i, ii; @@ -122,6 +125,7 @@ ol.Collection.prototype.extend = function(arr) { * @param {S=} opt_this The object to use as `this` in `f`. * @template T,S * @todo stability experimental + * @todo api */ ol.Collection.prototype.forEach = function(f, opt_this) { goog.array.forEach(this.array_, f, opt_this); @@ -135,6 +139,7 @@ ol.Collection.prototype.forEach = function(f, opt_this) { * of the array. * @return {Array} Array. * @todo stability experimental + * @todo api */ ol.Collection.prototype.getArray = function() { return this.array_; @@ -146,6 +151,7 @@ ol.Collection.prototype.getArray = function() { * @param {number} index Index. * @return {*} Element. * @todo stability experimental + * @todo api */ ol.Collection.prototype.getAt = function(index) { return this.array_[index]; @@ -156,6 +162,7 @@ ol.Collection.prototype.getAt = function(index) { * Get the length of this collection. * @return {number} Length. * @todo stability experimental + * @todo api */ ol.Collection.prototype.getLength = function() { return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH)); @@ -167,6 +174,7 @@ ol.Collection.prototype.getLength = function() { * @param {number} index Index. * @param {*} elem Element. * @todo stability experimental + * @todo api */ ol.Collection.prototype.insertAt = function(index, elem) { goog.array.insertAt(this.array_, elem, index); @@ -180,6 +188,7 @@ ol.Collection.prototype.insertAt = function(index, elem) { * Remove the last element of the collection. * @return {*} Element. * @todo stability experimental + * @todo api */ ol.Collection.prototype.pop = function() { return this.removeAt(this.getLength() - 1); @@ -191,6 +200,7 @@ ol.Collection.prototype.pop = function() { * @param {*} elem Element. * @return {number} Length. * @todo stability experimental + * @todo api */ ol.Collection.prototype.push = function(elem) { var n = this.array_.length; @@ -204,6 +214,7 @@ ol.Collection.prototype.push = function(elem) { * @param {*} elem Element. * @return {*} The removed element or undefined if elem was not found. * @todo stability experimental + * @todo api */ ol.Collection.prototype.remove = function(elem) { var arr = this.array_; @@ -222,6 +233,7 @@ ol.Collection.prototype.remove = function(elem) { * @param {number} index Index. * @return {*} Value. * @todo stability experimental + * @todo api */ ol.Collection.prototype.removeAt = function(index) { var prev = this.array_[index]; @@ -238,6 +250,7 @@ ol.Collection.prototype.removeAt = function(index) { * @param {number} index Index. * @param {*} elem Element. * @todo stability experimental + * @todo api */ ol.Collection.prototype.setAt = function(index, elem) { var n = this.getLength(); diff --git a/src/ol/color/color.exports b/src/ol/color/color.exports deleted file mode 100644 index cc1d37a73a..0000000000 --- a/src/ol/color/color.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.color.asArray -@exportSymbol ol.color.asString diff --git a/src/ol/color/color.js b/src/ol/color/color.js index a0befe3df5..b33768ca52 100644 --- a/src/ol/color/color.js +++ b/src/ol/color/color.js @@ -103,6 +103,7 @@ ol.color.blend = function(dst, src, opt_color) { /** * @param {ol.Color|string} color Color. * @return {ol.Color} Color. + * @todo api */ ol.color.asArray = function(color) { if (goog.isArray(color)) { @@ -117,6 +118,7 @@ ol.color.asArray = function(color) { /** * @param {ol.Color|string} color Color. * @return {string} String. + * @todo api */ ol.color.asString = function(color) { if (goog.isString(color)) { diff --git a/src/ol/control/attributioncontrol.exports b/src/ol/control/attributioncontrol.exports deleted file mode 100644 index a9fa893101..0000000000 --- a/src/ol/control/attributioncontrol.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.control.Attribution -@exportProperty ol.control.Attribution.prototype.setMap diff --git a/src/ol/control/attributioncontrol.js b/src/ol/control/attributioncontrol.js index 109faf06f9..7992201ed9 100644 --- a/src/ol/control/attributioncontrol.js +++ b/src/ol/control/attributioncontrol.js @@ -22,6 +22,7 @@ goog.require('ol.css'); * @extends {ol.control.Control} * @param {olx.control.AttributionOptions=} opt_options Attribution options. * @todo stability experimental + * @todo api */ ol.control.Attribution = function(opt_options) { diff --git a/src/ol/control/control.exports b/src/ol/control/control.exports deleted file mode 100644 index 1d184d239e..0000000000 --- a/src/ol/control/control.exports +++ /dev/null @@ -1,3 +0,0 @@ -@exportSymbol ol.control.Control -@exportProperty ol.control.Control.prototype.getMap -@exportProperty ol.control.Control.prototype.setMap diff --git a/src/ol/control/control.js b/src/ol/control/control.js index 7b668dd4ac..2fa119057a 100644 --- a/src/ol/control/control.js +++ b/src/ol/control/control.js @@ -17,6 +17,7 @@ goog.require('ol.Object'); * @implements {oli.control.Control} * @param {olx.control.ControlOptions} options Control options. * @todo stability stable + * @todo api */ ol.control.Control = function(options) { @@ -64,6 +65,7 @@ ol.control.Control.prototype.disposeInternal = function() { * Get the map associated with this control. * @return {ol.Map} Map. * @todo stability experimental + * @todo api */ ol.control.Control.prototype.getMap = function() { return this.map_; @@ -85,6 +87,7 @@ ol.control.Control.prototype.handleMapPostrender = goog.nullFunction; * the map here. * @param {ol.Map} map Map. * @todo stability stable + * @todo api */ ol.control.Control.prototype.setMap = function(map) { if (!goog.isNull(this.map_)) { diff --git a/src/ol/control/controldefaults.exports b/src/ol/control/controldefaults.exports deleted file mode 100644 index a9c4315ac3..0000000000 --- a/src/ol/control/controldefaults.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.control.defaults diff --git a/src/ol/control/controldefaults.js b/src/ol/control/controldefaults.js index 9a771c14ab..89360eb0c9 100644 --- a/src/ol/control/controldefaults.js +++ b/src/ol/control/controldefaults.js @@ -10,6 +10,7 @@ goog.require('ol.control.Zoom'); * @param {olx.control.DefaultsOptions=} opt_options Defaults options. * @return {ol.Collection} Controls. * @todo stability experimental + * @todo api */ ol.control.defaults = function(opt_options) { diff --git a/src/ol/control/fullscreencontrol.exports b/src/ol/control/fullscreencontrol.exports deleted file mode 100644 index 6b8c9b566c..0000000000 --- a/src/ol/control/fullscreencontrol.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.control.FullScreen diff --git a/src/ol/control/fullscreencontrol.js b/src/ol/control/fullscreencontrol.js index 4b8e42a7c4..50e473e1c7 100644 --- a/src/ol/control/fullscreencontrol.js +++ b/src/ol/control/fullscreencontrol.js @@ -25,6 +25,7 @@ goog.require('ol.pointer.PointerEventHandler'); * @extends {ol.control.Control} * @param {olx.control.FullScreenOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.control.FullScreen = function(opt_options) { diff --git a/src/ol/control/logocontrol.exports b/src/ol/control/logocontrol.exports deleted file mode 100644 index ccae41d4aa..0000000000 --- a/src/ol/control/logocontrol.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.control.Logo -@exportProperty ol.control.Logo.prototype.setMap diff --git a/src/ol/control/logocontrol.js b/src/ol/control/logocontrol.js index bb140f314d..42f82b33c0 100644 --- a/src/ol/control/logocontrol.js +++ b/src/ol/control/logocontrol.js @@ -18,6 +18,7 @@ goog.require('ol.css'); * @extends {ol.control.Control} * @param {olx.control.LogoOptions=} opt_options Logo options. * @todo stability experimental + * @todo api */ ol.control.Logo = function(opt_options) { diff --git a/src/ol/control/mousepositioncontrol.exports b/src/ol/control/mousepositioncontrol.exports deleted file mode 100644 index 73f28771eb..0000000000 --- a/src/ol/control/mousepositioncontrol.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.control.MousePosition -@exportProperty ol.control.MousePosition.prototype.setMap diff --git a/src/ol/control/mousepositioncontrol.js b/src/ol/control/mousepositioncontrol.js index c103e9ad84..e22055450e 100644 --- a/src/ol/control/mousepositioncontrol.js +++ b/src/ol/control/mousepositioncontrol.js @@ -43,6 +43,7 @@ ol.control.MousePositionProperty = { * mouse position in * @todo observable coordinateFormat {ol.CoordinateFormatType} the format to * render the current position in + * @todo api */ ol.control.MousePosition = function(opt_options) { @@ -184,6 +185,7 @@ ol.control.MousePosition.prototype.handleMouseOut = function(browserEvent) { /** * @inheritDoc + * @todo api */ ol.control.MousePosition.prototype.setMap = function(map) { goog.base(this, 'setMap', map); diff --git a/src/ol/control/scalelinecontrol.exports b/src/ol/control/scalelinecontrol.exports deleted file mode 100644 index 4493ffde49..0000000000 --- a/src/ol/control/scalelinecontrol.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.control.ScaleLine -@exportProperty ol.control.ScaleLine.prototype.setMap diff --git a/src/ol/control/scalelinecontrol.js b/src/ol/control/scalelinecontrol.js index b09110fd5c..c27023074c 100644 --- a/src/ol/control/scalelinecontrol.js +++ b/src/ol/control/scalelinecontrol.js @@ -52,6 +52,7 @@ ol.control.ScaleLineUnits = { * @todo stability experimental * @todo observable units {ol.control.ScaleLineUnits} the units to use in the * scale line + * @todo api */ ol.control.ScaleLine = function(opt_options) { diff --git a/src/ol/control/zoomcontrol.exports b/src/ol/control/zoomcontrol.exports deleted file mode 100644 index 8d8123f761..0000000000 --- a/src/ol/control/zoomcontrol.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.control.Zoom -@exportProperty ol.control.Zoom.prototype.setMap diff --git a/src/ol/control/zoomcontrol.js b/src/ol/control/zoomcontrol.js index 7eb552c8a9..d77f6d222a 100644 --- a/src/ol/control/zoomcontrol.js +++ b/src/ol/control/zoomcontrol.js @@ -24,6 +24,7 @@ goog.require('ol.pointer.PointerEventHandler'); * @extends {ol.control.Control} * @param {olx.control.ZoomOptions=} opt_options Zoom options. * @todo stability experimental + * @todo api */ ol.control.Zoom = function(opt_options) { diff --git a/src/ol/control/zoomslidercontrol.exports b/src/ol/control/zoomslidercontrol.exports deleted file mode 100644 index 3be7924ba6..0000000000 --- a/src/ol/control/zoomslidercontrol.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.control.ZoomSlider diff --git a/src/ol/control/zoomslidercontrol.js b/src/ol/control/zoomslidercontrol.js index c2cf84481e..6714321150 100644 --- a/src/ol/control/zoomslidercontrol.js +++ b/src/ol/control/zoomslidercontrol.js @@ -39,6 +39,7 @@ ol.control.ZOOMSLIDER_ANIMATION_DURATION = 200; * @extends {ol.control.Control} * @param {olx.control.ZoomSliderOptions=} opt_options Zoom slider options. * @todo stability experimental + * @todo api */ ol.control.ZoomSlider = function(opt_options) { diff --git a/src/ol/control/zoomtoextentcontrol.exports b/src/ol/control/zoomtoextentcontrol.exports deleted file mode 100644 index 485e551f42..0000000000 --- a/src/ol/control/zoomtoextentcontrol.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.control.ZoomToExtent diff --git a/src/ol/control/zoomtoextentcontrol.js b/src/ol/control/zoomtoextentcontrol.js index 404a2efdf7..f1942df12c 100644 --- a/src/ol/control/zoomtoextentcontrol.js +++ b/src/ol/control/zoomtoextentcontrol.js @@ -21,6 +21,7 @@ goog.require('ol.pointer.PointerEventHandler'); * @extends {ol.control.Control} * @param {olx.control.ZoomToExtentOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.control.ZoomToExtent = function(opt_options) { var options = goog.isDef(opt_options) ? opt_options : {}; diff --git a/src/ol/coordinate.exports b/src/ol/coordinate.exports deleted file mode 100644 index e4536ab28f..0000000000 --- a/src/ol/coordinate.exports +++ /dev/null @@ -1,7 +0,0 @@ -@exportSymbol ol.coordinate.add -@exportSymbol ol.coordinate.createStringXY -@exportSymbol ol.coordinate.format -@exportSymbol ol.coordinate.fromProjectedArray -@exportSymbol ol.coordinate.rotate -@exportSymbol ol.coordinate.toStringHDMS -@exportSymbol ol.coordinate.toStringXY diff --git a/src/ol/coordinate.js b/src/ol/coordinate.js index c34247c41f..0f779f342a 100644 --- a/src/ol/coordinate.js +++ b/src/ol/coordinate.js @@ -36,6 +36,7 @@ ol.CoordinateArray; * @param {ol.Coordinate} coordinate Coordinate. * @param {ol.Coordinate} delta Delta. * @return {ol.Coordinate} Coordinate. + * @todo api */ ol.coordinate.add = function(coordinate, delta) { coordinate[0] += delta[0]; @@ -88,6 +89,7 @@ ol.coordinate.closestOnSegment = function(coordinate, segment) { * after the decimal point. Default is `0`. * @return {ol.CoordinateFormatType} Coordinate format. * @todo stability experimental + * @todo api */ ol.coordinate.createStringXY = function(opt_fractionDigits) { return ( @@ -125,6 +127,7 @@ ol.coordinate.degreesToStringHDMS_ = function(degrees, hemispheres) { * after the decimal point. Default is `0`. * @return {string} Formated coordinate. * @todo stability experimental + * @todo api */ ol.coordinate.format = function(coordinate, template, opt_fractionDigits) { if (goog.isDef(coordinate)) { @@ -158,6 +161,7 @@ ol.coordinate.equals = function(coordinate1, coordinate2) { * @param {ol.Coordinate} coordinate Coordinate. * @param {number} angle Angle. * @return {ol.Coordinate} Coordinate. + * @todo api */ ol.coordinate.rotate = function(coordinate, angle) { var cosAngle = Math.cos(angle); @@ -223,6 +227,7 @@ ol.coordinate.squaredDistanceToSegment = function(coordinate, segment) { * @param {ol.Coordinate|undefined} coordinate Coordinate. * @return {string} Hemisphere, degrees, minutes and seconds. * @todo stability experimental + * @todo api */ ol.coordinate.toStringHDMS = function(coordinate) { if (goog.isDef(coordinate)) { @@ -240,6 +245,7 @@ ol.coordinate.toStringHDMS = function(coordinate) { * after the decimal point. Default is `0`. * @return {string} XY. * @todo stability experimental + * @todo api */ ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) { return ol.coordinate.format(coordinate, '{x}, {y}', opt_fractionDigits); @@ -252,6 +258,7 @@ ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) { * @param {string} axis the axis info. * @return {ol.Coordinate} The coordinate created. * @todo stability experimental + * @todo api */ ol.coordinate.fromProjectedArray = function(array, axis) { var firstAxis = axis.charAt(0); diff --git a/src/ol/deviceorientation.exports b/src/ol/deviceorientation.exports deleted file mode 100644 index 4496aa24b9..0000000000 --- a/src/ol/deviceorientation.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.DeviceOrientation diff --git a/src/ol/deviceorientation.js b/src/ol/deviceorientation.js index 58bc29ef58..ae0e09bf60 100644 --- a/src/ol/deviceorientation.js +++ b/src/ol/deviceorientation.js @@ -80,6 +80,7 @@ ol.DeviceOrientationProperty = { * device from the planar Y axis * @todo observable tracking {boolean} the status of tracking changes to alpha, * beta and gamma. If true, changes are tracked and reported immediately. + * @todo api */ ol.DeviceOrientation = function(opt_options) { diff --git a/src/ol/dom/input.exports b/src/ol/dom/input.exports deleted file mode 100644 index 0b6e668625..0000000000 --- a/src/ol/dom/input.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.dom.Input diff --git a/src/ol/dom/input.js b/src/ol/dom/input.js index 45ab97ff5b..44c1713212 100644 --- a/src/ol/dom/input.js +++ b/src/ol/dom/input.js @@ -32,6 +32,7 @@ ol.dom.InputProperty = { * @todo stability experimental * @todo observable value {string} the value of the Input * @todo observable checked {boolean} the checked state of the Input + * @todo api */ ol.dom.Input = function(target) { goog.base(this); diff --git a/src/ol/easing.exports b/src/ol/easing.exports deleted file mode 100644 index d8653acfe3..0000000000 --- a/src/ol/easing.exports +++ /dev/null @@ -1,7 +0,0 @@ -@exportSymbol ol.easing.bounce -@exportSymbol ol.easing.easeIn -@exportSymbol ol.easing.easeOut -@exportSymbol ol.easing.elastic -@exportSymbol ol.easing.inAndOut -@exportSymbol ol.easing.linear -@exportSymbol ol.easing.upAndDown diff --git a/src/ol/easing.js b/src/ol/easing.js index 9e829f3a93..179f948805 100644 --- a/src/ol/easing.js +++ b/src/ol/easing.js @@ -7,6 +7,7 @@ goog.require('goog.fx.easing'); * from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. + * @todo api */ ol.easing.bounce = function(t) { var s = 7.5625, p = 2.75, l; @@ -33,6 +34,7 @@ ol.easing.bounce = function(t) { /** * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. + * @todo api */ ol.easing.easeIn = goog.fx.easing.easeIn; @@ -40,6 +42,7 @@ ol.easing.easeIn = goog.fx.easing.easeIn; /** * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. + * @todo api */ ol.easing.easeOut = goog.fx.easing.easeOut; @@ -48,6 +51,7 @@ ol.easing.easeOut = goog.fx.easing.easeOut; * from https://raw.github.com/DmitryBaranovskiy/raphael/master/raphael.js * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. + * @todo api */ ol.easing.elastic = function(t) { return Math.pow(2, -10 * t) * Math.sin((t - 0.075) * (2 * Math.PI) / 0.3) + 1; @@ -57,6 +61,7 @@ ol.easing.elastic = function(t) { /** * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. + * @todo api */ ol.easing.inAndOut = goog.fx.easing.inAndOut; @@ -64,6 +69,7 @@ ol.easing.inAndOut = goog.fx.easing.inAndOut; /** * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. + * @todo api */ ol.easing.linear = function(t) { return t; @@ -73,6 +79,7 @@ ol.easing.linear = function(t) { /** * @param {number} t Input between 0 and 1. * @return {number} Output between 0 and 1. + * @todo api */ ol.easing.upAndDown = function(t) { if (t < 0.5) { diff --git a/src/ol/events/condition.exports b/src/ol/events/condition.exports deleted file mode 100644 index 500c747bb9..0000000000 --- a/src/ol/events/condition.exports +++ /dev/null @@ -1,8 +0,0 @@ -@exportSymbol ol.events.condition.altKeyOnly -@exportSymbol ol.events.condition.altShiftKeysOnly -@exportSymbol ol.events.condition.always -@exportSymbol ol.events.condition.never -@exportSymbol ol.events.condition.noModifierKeys -@exportSymbol ol.events.condition.platformModifierKeyOnly -@exportSymbol ol.events.condition.shiftKeyOnly -@exportSymbol ol.events.condition.targetNotEditable diff --git a/src/ol/events/condition.js b/src/ol/events/condition.js index 285298b486..937dc99c03 100644 --- a/src/ol/events/condition.js +++ b/src/ol/events/condition.js @@ -22,6 +22,7 @@ ol.events.ConditionType; * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt key is pressed. * @todo stability experimental + * @todo api */ ol.events.condition.altKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -36,6 +37,7 @@ ol.events.condition.altKeyOnly = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the alt and shift keys are pressed. * @todo stability experimental + * @todo api */ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -51,6 +53,7 @@ ol.events.condition.altShiftKeysOnly = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True. * @todo stability experimental + * @todo api */ ol.events.condition.always = goog.functions.TRUE; @@ -60,6 +63,7 @@ ol.events.condition.always = goog.functions.TRUE; * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} False. * @todo stability experimental + * @todo api */ ol.events.condition.never = goog.functions.FALSE; @@ -78,6 +82,7 @@ ol.events.condition.singleClick = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True only if there no modifier keys are pressed. * @todo stability experimental + * @todo api */ ol.events.condition.noModifierKeys = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -92,6 +97,7 @@ ol.events.condition.noModifierKeys = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the platform modifier key is pressed. * @todo stability experimental + * @todo api */ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -106,6 +112,7 @@ ol.events.condition.platformModifierKeyOnly = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True if only the shift key is pressed. * @todo stability experimental + * @todo api */ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) { var browserEvent = mapBrowserEvent.browserEvent; @@ -120,6 +127,7 @@ ol.events.condition.shiftKeyOnly = function(mapBrowserEvent) { * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} True only if the target element is not editable. * @todo stability experimental + * @todo api */ ol.events.condition.targetNotEditable = function(mapBrowserEvent) { var target = mapBrowserEvent.browserEvent.target; diff --git a/src/ol/extent.exports b/src/ol/extent.exports deleted file mode 100644 index 387a75529f..0000000000 --- a/src/ol/extent.exports +++ /dev/null @@ -1,18 +0,0 @@ -@exportSymbol ol.extent.boundingExtent -@exportSymbol ol.extent.buffer -@exportSymbol ol.extent.containsCoordinate -@exportSymbol ol.extent.containsExtent -@exportSymbol ol.extent.createEmpty -@exportSymbol ol.extent.equals -@exportSymbol ol.extent.extend -@exportSymbol ol.extent.getBottomLeft -@exportSymbol ol.extent.getBottomRight -@exportSymbol ol.extent.getCenter -@exportSymbol ol.extent.getHeight -@exportSymbol ol.extent.getSize -@exportSymbol ol.extent.getTopLeft -@exportSymbol ol.extent.getTopRight -@exportSymbol ol.extent.getWidth -@exportSymbol ol.extent.intersects -@exportSymbol ol.extent.isEmpty -@exportSymbol ol.extent.transform diff --git a/src/ol/extent.js b/src/ol/extent.js index 10f36db01d..e4e3792140 100644 --- a/src/ol/extent.js +++ b/src/ol/extent.js @@ -37,6 +37,7 @@ ol.extent.Relationship = { * @param {Array.} coordinates Coordinates. * @return {ol.Extent} Bounding extent. * @todo stability experimental + * @todo api */ ol.extent.boundingExtent = function(coordinates) { var extent = ol.extent.createEmpty(); @@ -72,6 +73,7 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) { * @param {number} value The amount by wich the extent should be buffered. * @param {ol.Extent=} opt_extent Extent. * @return {ol.Extent} Extent. + * @todo api */ ol.extent.buffer = function(extent, value, opt_extent) { if (goog.isDef(opt_extent)) { @@ -145,6 +147,7 @@ ol.extent.closestSquaredDistanceXY = function(extent, x, y) { * @param {ol.Coordinate} coordinate Coordinate. * @return {boolean} Contains. * @todo stability experimental + * @todo api */ ol.extent.containsCoordinate = function(extent, coordinate) { return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] && @@ -159,6 +162,7 @@ ol.extent.containsCoordinate = function(extent, coordinate) { * @param {ol.Extent} extent2 Extent 2. * @return {boolean} Contains. * @todo stability experimental + * @todo api */ ol.extent.containsExtent = function(extent1, extent2) { return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] && @@ -201,6 +205,7 @@ ol.extent.coordinateRelationship = function(extent, coordinate) { /** * @return {ol.Extent} Empty extent. * @todo stability experimental + * @todo api */ ol.extent.createEmpty = function() { return [Infinity, Infinity, -Infinity, -Infinity]; @@ -307,6 +312,7 @@ ol.extent.empty = function(extent) { * @param {ol.Extent} extent2 Extent 2. * @return {boolean} Equals. * @todo stability experimental + * @todo api */ ol.extent.equals = function(extent1, extent2) { return extent1[0] == extent2[0] && extent1[2] == extent2[2] && @@ -319,6 +325,7 @@ ol.extent.equals = function(extent1, extent2) { * @param {ol.Extent} extent2 Extent 2. * @return {ol.Extent} Extent. * @todo stability experimental + * @todo api */ ol.extent.extend = function(extent1, extent2) { if (extent2[0] < extent1[0]) { @@ -430,6 +437,7 @@ ol.extent.getArea = function(extent) { * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Bottom left coordinate. * @todo stability experimental + * @todo api */ ol.extent.getBottomLeft = function(extent) { return [extent[0], extent[1]]; @@ -440,6 +448,7 @@ ol.extent.getBottomLeft = function(extent) { * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Bottom right coordinate. * @todo stability experimental + * @todo api */ ol.extent.getBottomRight = function(extent) { return [extent[2], extent[1]]; @@ -450,6 +459,7 @@ ol.extent.getBottomRight = function(extent) { * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Center. * @todo stability experimental + * @todo api */ ol.extent.getCenter = function(extent) { return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2]; @@ -504,6 +514,7 @@ ol.extent.getForView2DAndSize = * @param {ol.Extent} extent Extent. * @return {number} Height. * @todo stability experimental + * @todo api */ ol.extent.getHeight = function(extent) { return extent[3] - extent[1]; @@ -537,6 +548,7 @@ ol.extent.getMargin = function(extent) { * @param {ol.Extent} extent Extent. * @return {ol.Size} Size. * @todo stability experimental + * @todo api */ ol.extent.getSize = function(extent) { return [extent[2] - extent[0], extent[3] - extent[1]]; @@ -547,6 +559,7 @@ ol.extent.getSize = function(extent) { * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Top left coordinate. * @todo stability experimental + * @todo api */ ol.extent.getTopLeft = function(extent) { return [extent[0], extent[3]]; @@ -557,6 +570,7 @@ ol.extent.getTopLeft = function(extent) { * @param {ol.Extent} extent Extent. * @return {ol.Coordinate} Top right coordinate. * @todo stability experimental + * @todo api */ ol.extent.getTopRight = function(extent) { return [extent[2], extent[3]]; @@ -567,6 +581,7 @@ ol.extent.getTopRight = function(extent) { * @param {ol.Extent} extent Extent. * @return {number} Width. * @todo stability experimental + * @todo api */ ol.extent.getWidth = function(extent) { return extent[2] - extent[0]; @@ -578,6 +593,7 @@ ol.extent.getWidth = function(extent) { * @param {ol.Extent} extent2 Extent. * @return {boolean} Intersects. * @todo stability experimental + * @todo api */ ol.extent.intersects = function(extent1, extent2) { return extent1[0] <= extent2[2] && @@ -591,6 +607,7 @@ ol.extent.intersects = function(extent1, extent2) { * @param {ol.Extent} extent Extent. * @return {boolean} Is empty. * @todo stability experimental + * @todo api */ ol.extent.isEmpty = function(extent) { return extent[2] < extent[0] || extent[3] < extent[1]; @@ -728,6 +745,7 @@ ol.extent.touches = function(extent1, extent2) { * @param {ol.Extent=} opt_extent Destination extent. * @return {ol.Extent} Extent. * @todo stability experimental + * @todo api */ ol.extent.transform = function(extent, transformFn, opt_extent) { var coordinates = [ diff --git a/src/ol/feature.exports b/src/ol/feature.exports deleted file mode 100644 index 6c1f200ea6..0000000000 --- a/src/ol/feature.exports +++ /dev/null @@ -1,8 +0,0 @@ -@exportSymbol ol.Feature -@exportProperty ol.Feature.prototype.getGeometryName -@exportProperty ol.Feature.prototype.getId -@exportProperty ol.Feature.prototype.getStyle -@exportProperty ol.Feature.prototype.getStyleFunction -@exportProperty ol.Feature.prototype.setGeometryName -@exportProperty ol.Feature.prototype.setId -@exportProperty ol.Feature.prototype.setStyle diff --git a/src/ol/feature.js b/src/ol/feature.js index 79354c03a6..e74cefd2be 100644 --- a/src/ol/feature.js +++ b/src/ol/feature.js @@ -21,6 +21,7 @@ goog.require('ol.style.Style'); * @param {ol.geom.Geometry|Object.=} opt_geometryOrValues * Values or geometry. * @todo stability experimental + * @todo api */ ol.Feature = function(opt_geometryOrValues) { @@ -81,6 +82,7 @@ goog.inherits(ol.Feature, ol.Object); /** * @return {ol.geom.Geometry|undefined} Geometry. * @todo stability experimental + * @todo api */ ol.Feature.prototype.getGeometry = function() { return /** @type {ol.geom.Geometry|undefined} */ ( @@ -95,6 +97,7 @@ goog.exportProperty( /** * @return {number|string|undefined} Id. * @todo stability experimental + * @todo api */ ol.Feature.prototype.getId = function() { return this.id_; @@ -104,6 +107,7 @@ ol.Feature.prototype.getId = function() { /** * @return {string} Geometry property name. * @todo stability experimental + * @todo api */ ol.Feature.prototype.getGeometryName = function() { return this.geometryName_; @@ -114,6 +118,7 @@ ol.Feature.prototype.getGeometryName = function() { * @return {ol.style.Style|Array.| * ol.feature.FeatureStyleFunction} User provided style. * @todo stability experimental + * @todo api */ ol.Feature.prototype.getStyle = function() { return this.style_; @@ -123,6 +128,7 @@ ol.Feature.prototype.getStyle = function() { /** * @return {ol.feature.FeatureStyleFunction|undefined} Style function. * @todo stability experimental + * @todo api */ ol.Feature.prototype.getStyleFunction = function() { return this.styleFunction_; @@ -157,6 +163,7 @@ ol.Feature.prototype.handleGeometryChanged_ = function() { /** * @param {ol.geom.Geometry|undefined} geometry Geometry. * @todo stability experimental + * @todo api */ ol.Feature.prototype.setGeometry = function(geometry) { this.set(this.geometryName_, geometry); @@ -171,6 +178,7 @@ goog.exportProperty( * @param {ol.style.Style|Array.| * ol.feature.FeatureStyleFunction} style Feature style. * @todo stability experimental + * @todo api */ ol.Feature.prototype.setStyle = function(style) { this.style_ = style; @@ -182,6 +190,7 @@ ol.Feature.prototype.setStyle = function(style) { /** * @param {number|string|undefined} id Id. * @todo stability experimental + * @todo api */ ol.Feature.prototype.setId = function(id) { this.id_ = id; @@ -191,6 +200,7 @@ ol.Feature.prototype.setId = function(id) { /** * @param {string} name Geometry property name. * @todo stability experimental + * @todo api */ ol.Feature.prototype.setGeometryName = function(name) { goog.events.unlisten( diff --git a/src/ol/featureoverlay.exports b/src/ol/featureoverlay.exports deleted file mode 100644 index b471a281f6..0000000000 --- a/src/ol/featureoverlay.exports +++ /dev/null @@ -1,9 +0,0 @@ -@exportSymbol ol.FeatureOverlay -@exportProperty ol.FeatureOverlay.prototype.addFeature -@exportProperty ol.FeatureOverlay.prototype.getFeatures -@exportProperty ol.FeatureOverlay.prototype.getStyle -@exportProperty ol.FeatureOverlay.prototype.getStyleFunction -@exportProperty ol.FeatureOverlay.prototype.removeFeature -@exportProperty ol.FeatureOverlay.prototype.setFeatures -@exportProperty ol.FeatureOverlay.prototype.setMap -@exportProperty ol.FeatureOverlay.prototype.setStyle diff --git a/src/ol/featureoverlay.js b/src/ol/featureoverlay.js index 08fbcacf52..b64d266527 100644 --- a/src/ol/featureoverlay.js +++ b/src/ol/featureoverlay.js @@ -17,6 +17,7 @@ goog.require('ol.render.EventType'); * @constructor * @param {olx.FeatureOverlayOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.FeatureOverlay = function(opt_options) { @@ -86,6 +87,7 @@ ol.FeatureOverlay = function(opt_options) { /** * @param {ol.Feature} feature Feature. * @todo stability experimental + * @todo api */ ol.FeatureOverlay.prototype.addFeature = function(feature) { this.features_.push(feature); @@ -95,6 +97,7 @@ ol.FeatureOverlay.prototype.addFeature = function(feature) { /** * @return {ol.Collection} Features collection. * @todo stability experimental + * @todo api */ ol.FeatureOverlay.prototype.getFeatures = function() { return this.features_; @@ -168,6 +171,7 @@ ol.FeatureOverlay.prototype.handleMapPostCompose_ = function(event) { /** * @param {ol.Feature} feature Feature. * @todo stability experimental + * @todo api */ ol.FeatureOverlay.prototype.removeFeature = function(feature) { this.features_.remove(feature); @@ -187,6 +191,7 @@ ol.FeatureOverlay.prototype.render_ = function() { /** * @param {ol.Collection} features Features collection. * @todo stability experimental + * @todo api */ ol.FeatureOverlay.prototype.setFeatures = function(features) { if (!goog.isNull(this.featuresListenerKeys_)) { @@ -221,6 +226,7 @@ ol.FeatureOverlay.prototype.setFeatures = function(features) { /** * @param {ol.Map} map Map. * @todo stability experimental + * @todo api */ ol.FeatureOverlay.prototype.setMap = function(map) { if (!goog.isNull(this.postComposeListenerKey_)) { @@ -245,6 +251,7 @@ ol.FeatureOverlay.prototype.setMap = function(map) { * @param {ol.style.Style|Array.|ol.feature.StyleFunction} style * Overlay style. * @todo stability experimental + * @todo api */ ol.FeatureOverlay.prototype.setStyle = function(style) { this.style_ = style; @@ -258,6 +265,7 @@ ol.FeatureOverlay.prototype.setStyle = function(style) { * option at construction or to the `setStyle` method. * @return {ol.style.Style|Array.|ol.feature.StyleFunction} * Overlay style. + * @todo api */ ol.FeatureOverlay.prototype.getStyle = function() { return this.style_; @@ -267,6 +275,7 @@ ol.FeatureOverlay.prototype.getStyle = function() { /** * Get the style function. * @return {ol.feature.StyleFunction|undefined} Style function. + * @todo api */ ol.FeatureOverlay.prototype.getStyleFunction = function() { return this.styleFunction_; diff --git a/src/ol/format/geojsonformat.exports b/src/ol/format/geojsonformat.exports deleted file mode 100644 index 620f1bfad7..0000000000 --- a/src/ol/format/geojsonformat.exports +++ /dev/null @@ -1,8 +0,0 @@ -@exportSymbol ol.format.GeoJSON -@exportProperty ol.format.GeoJSON.prototype.readFeature -@exportProperty ol.format.GeoJSON.prototype.readFeatures -@exportProperty ol.format.GeoJSON.prototype.readGeometry -@exportProperty ol.format.GeoJSON.prototype.readProjection -@exportProperty ol.format.GeoJSON.prototype.writeFeature -@exportProperty ol.format.GeoJSON.prototype.writeFeatures -@exportProperty ol.format.GeoJSON.prototype.writeGeometry diff --git a/src/ol/format/geojsonformat.js b/src/ol/format/geojsonformat.js index a9e53bc413..42755f4e42 100644 --- a/src/ol/format/geojsonformat.js +++ b/src/ol/format/geojsonformat.js @@ -27,6 +27,7 @@ goog.require('ol.proj'); * @extends {ol.format.JSONFeature} * @param {olx.format.GeoJSONOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.format.GeoJSON = function(opt_options) { @@ -322,6 +323,7 @@ ol.format.GeoJSON.prototype.getExtensions = function() { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.Feature} Feature. + * @todo api */ ol.format.GeoJSON.prototype.readFeature; @@ -333,6 +335,7 @@ ol.format.GeoJSON.prototype.readFeature; * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {Array.} Features. + * @todo api */ ol.format.GeoJSON.prototype.readFeatures; @@ -386,6 +389,7 @@ ol.format.GeoJSON.prototype.readFeaturesFromObject = function(object) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.geom.Geometry} Geometry. + * @todo api */ ol.format.GeoJSON.prototype.readGeometry; @@ -404,6 +408,7 @@ ol.format.GeoJSON.prototype.readGeometryFromObject = function(object) { * * @param {ArrayBuffer|Document|Node|Object|string} object Source. * @return {ol.proj.Projection} Projection. + * @todo api */ ol.format.GeoJSON.prototype.readProjection = function(object) { var geoJSONObject = /** @type {GeoJSONObject} */ (object); @@ -433,6 +438,7 @@ ol.format.GeoJSON.prototype.readProjection = function(object) { * @function * @param {ol.Feature} feature Feature. * @return {ArrayBuffer|Node|Object|string} Result. + * @todo api */ ol.format.GeoJSON.prototype.writeFeature; @@ -468,6 +474,7 @@ ol.format.GeoJSON.prototype.writeFeatureObject = function(feature) { * @function * @param {Array.} features Features. * @return {ArrayBuffer|Node|Object|string} Result. + * @todo api */ ol.format.GeoJSON.prototype.writeFeatures; diff --git a/src/ol/format/gpxformat.exports b/src/ol/format/gpxformat.exports deleted file mode 100644 index ac072e55dd..0000000000 --- a/src/ol/format/gpxformat.exports +++ /dev/null @@ -1,5 +0,0 @@ -@exportSymbol ol.format.GPX -@exportProperty ol.format.GPX.prototype.readFeature -@exportProperty ol.format.GPX.prototype.readFeatures -@exportProperty ol.format.GPX.prototype.readProjection -@exportProperty ol.format.GPX.prototype.writeFeatures diff --git a/src/ol/format/gpxformat.js b/src/ol/format/gpxformat.js index e99526e163..e170e1d149 100644 --- a/src/ol/format/gpxformat.js +++ b/src/ol/format/gpxformat.js @@ -20,6 +20,7 @@ goog.require('ol.xml'); * @constructor * @extends {ol.format.XMLFeature} * @todo stability experimental + * @todo api */ ol.format.GPX = function() { goog.base(this); @@ -369,6 +370,7 @@ ol.format.GPX.WPT_PARSERS_ = ol.xml.makeParsersNS( * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.Feature} Feature. + * @todo api */ ol.format.GPX.prototype.readFeature; @@ -399,6 +401,7 @@ ol.format.GPX.prototype.readFeatureFromNode = function(node) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {Array.} Features. + * @todo api */ ol.format.GPX.prototype.readFeatures; @@ -430,6 +433,7 @@ ol.format.GPX.prototype.readFeaturesFromNode = function(node) { * * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. + * @todo api */ ol.format.GPX.prototype.readProjection; @@ -805,6 +809,7 @@ goog.inherits(ol.format.GPX.V1_1, ol.format.GPX); * @function * @param {Array.} features Features. * @return {ArrayBuffer|Node|Object|string} Result. + * @todo api */ ol.format.GPX.prototype.writeFeatures; diff --git a/src/ol/format/igcformat.exports b/src/ol/format/igcformat.exports deleted file mode 100644 index 6a6acf7e15..0000000000 --- a/src/ol/format/igcformat.exports +++ /dev/null @@ -1,4 +0,0 @@ -@exportSymbol ol.format.IGC -@exportProperty ol.format.IGC.prototype.readFeature -@exportProperty ol.format.IGC.prototype.readFeatures -@exportProperty ol.format.IGC.prototype.readProjection diff --git a/src/ol/format/igcformat.js b/src/ol/format/igcformat.js index f73902a934..ad55b4bbdc 100644 --- a/src/ol/format/igcformat.js +++ b/src/ol/format/igcformat.js @@ -26,6 +26,7 @@ ol.format.IGCZ = { * @extends {ol.format.TextFeature} * @param {olx.format.IGCOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.format.IGC = function(opt_options) { @@ -91,6 +92,7 @@ ol.format.IGC.prototype.getExtensions = function() { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.Feature} Feature. + * @todo api */ ol.format.IGC.prototype.readFeature; @@ -176,6 +178,7 @@ ol.format.IGC.prototype.readFeatureFromText = function(text) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {Array.} Features. + * @todo api */ ol.format.IGC.prototype.readFeatures; @@ -199,6 +202,7 @@ ol.format.IGC.prototype.readFeaturesFromText = function(text) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. + * @todo api */ ol.format.IGC.prototype.readProjection; diff --git a/src/ol/format/kmlformat.exports b/src/ol/format/kmlformat.exports deleted file mode 100644 index edafad12f2..0000000000 --- a/src/ol/format/kmlformat.exports +++ /dev/null @@ -1,5 +0,0 @@ -@exportSymbol ol.format.KML -@exportProperty ol.format.KML.prototype.readFeature -@exportProperty ol.format.KML.prototype.readFeatures -@exportProperty ol.format.KML.prototype.readName -@exportProperty ol.format.KML.prototype.readProjection diff --git a/src/ol/format/kmlformat.js b/src/ol/format/kmlformat.js index 78b816765f..b7f300a375 100644 --- a/src/ol/format/kmlformat.js +++ b/src/ol/format/kmlformat.js @@ -55,6 +55,7 @@ ol.format.KMLGxTrackObject_; * @extends {ol.format.XMLFeature} * @param {olx.format.KMLOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.format.KML = function(opt_options) { @@ -1450,6 +1451,7 @@ ol.format.KML.prototype.readSharedStyleMap_ = function(node, objectStack) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.Feature} Feature. + * @todo api */ ol.format.KML.prototype.readFeature; @@ -1478,6 +1480,7 @@ ol.format.KML.prototype.readFeatureFromNode = function(node) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {Array.} Features. + * @todo api */ ol.format.KML.prototype.readFeatures; @@ -1596,6 +1599,7 @@ ol.format.KML.prototype.readNameFromNode = function(node) { * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.proj.Projection} Projection. + * @todo api */ ol.format.KML.prototype.readProjection; diff --git a/src/ol/format/osmxmlformat.exports b/src/ol/format/osmxmlformat.exports deleted file mode 100644 index e9bb1a6835..0000000000 --- a/src/ol/format/osmxmlformat.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.format.OSMXML diff --git a/src/ol/format/osmxmlformat.js b/src/ol/format/osmxmlformat.js index 3b7278a093..987401104e 100644 --- a/src/ol/format/osmxmlformat.js +++ b/src/ol/format/osmxmlformat.js @@ -18,6 +18,7 @@ goog.require('ol.xml'); /** * @constructor * @extends {ol.format.XMLFeature} + * @todo api */ ol.format.OSMXML = function() { goog.base(this); diff --git a/src/ol/format/topojsonformat.exports b/src/ol/format/topojsonformat.exports deleted file mode 100644 index 367c42efb8..0000000000 --- a/src/ol/format/topojsonformat.exports +++ /dev/null @@ -1,3 +0,0 @@ -@exportSymbol ol.format.TopoJSON -@exportProperty ol.format.TopoJSON.prototype.readFeatures -@exportProperty ol.format.TopoJSON.prototype.readProjection diff --git a/src/ol/format/topojsonformat.js b/src/ol/format/topojsonformat.js index 5b484b4ca7..4b3a7de73f 100644 --- a/src/ol/format/topojsonformat.js +++ b/src/ol/format/topojsonformat.js @@ -20,6 +20,7 @@ goog.require('ol.proj'); * @extends {ol.format.JSONFeature} * @param {olx.format.TopoJSONOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.format.TopoJSON = function(opt_options) { @@ -271,6 +272,7 @@ ol.format.TopoJSON.readFeatureFromGeometry_ = function(object, arcs, * @function * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {Array.} Features. + * @todo api */ ol.format.TopoJSON.prototype.readFeatures; @@ -380,6 +382,7 @@ ol.format.TopoJSON.transformVertex_ = function(vertex, scale, translate) { * @function * @param {ArrayBuffer|Document|Node|Object|string} object Source. * @return {ol.proj.Projection} Projection. + * @todo api */ ol.format.TopoJSON.prototype.readProjection = function(object) { return this.defaultProjection_; diff --git a/src/ol/format/wfsformat.exports b/src/ol/format/wfsformat.exports deleted file mode 100644 index d37ea38997..0000000000 --- a/src/ol/format/wfsformat.exports +++ /dev/null @@ -1,6 +0,0 @@ -@exportSymbol ol.format.WFS -@exportProperty ol.format.WFS.prototype.readFeatures -@exportProperty ol.format.WFS.prototype.readTransactionResponse -@exportProperty ol.format.WFS.prototype.readFeatureCollectionMetadata -@exportProperty ol.format.WFS.prototype.writeGetFeature -@exportProperty ol.format.WFS.prototype.writeTransaction diff --git a/src/ol/format/wfsformat.js b/src/ol/format/wfsformat.js index c6a8124bb9..c9d291e562 100644 --- a/src/ol/format/wfsformat.js +++ b/src/ol/format/wfsformat.js @@ -18,6 +18,7 @@ goog.require('ol.xml'); * Optional configuration object. * @extends {ol.format.XMLFeature} * @todo stability experimental + * @todo api */ ol.format.WFS = function(opt_options) { var options = /** @type {olx.format.WFSOptions} */ @@ -92,6 +93,7 @@ ol.format.WFS.prototype.readFeaturesFromNode = function(node) { /** * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.format.WFS.TransactionResponse|undefined} Transaction response. + * @todo api */ ol.format.WFS.prototype.readTransactionResponse = function(source) { if (ol.xml.isDocument(source)) { @@ -113,6 +115,7 @@ ol.format.WFS.prototype.readTransactionResponse = function(source) { * @param {ArrayBuffer|Document|Node|Object|string} source Source. * @return {ol.format.WFS.FeatureCollectionMetadata|undefined} * FeatureCollection metadata. + * @todo api */ ol.format.WFS.prototype.readFeatureCollectionMetadata = function(source) { if (ol.xml.isDocument(source)) { @@ -549,6 +552,7 @@ ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) { /** * @param {olx.format.WFSWriteGetFeatureOptions} options Options. * @return {Node} Result. + * @todo api */ ol.format.WFS.prototype.writeGetFeature = function(options) { var node = ol.xml.createElementNS('http://www.opengis.net/wfs', @@ -600,6 +604,7 @@ ol.format.WFS.prototype.writeGetFeature = function(options) { * @param {Array.} deletes The features to delete. * @param {olx.format.WFSWriteTransactionOptions} options Write options. * @return {Node} Result. + * @todo api */ ol.format.WFS.prototype.writeTransaction = function(inserts, updates, deletes, options) { diff --git a/src/ol/format/wmscapabilitiesformat.exports b/src/ol/format/wmscapabilitiesformat.exports deleted file mode 100644 index 0b1c5a8deb..0000000000 --- a/src/ol/format/wmscapabilitiesformat.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.format.WMSCapabilities -@exportProperty ol.format.WMSCapabilities.prototype.read diff --git a/src/ol/format/wmscapabilitiesformat.js b/src/ol/format/wmscapabilitiesformat.js index 856a670153..2f0aaf44d6 100644 --- a/src/ol/format/wmscapabilitiesformat.js +++ b/src/ol/format/wmscapabilitiesformat.js @@ -15,6 +15,7 @@ goog.require('ol.xml'); /** * @constructor * @extends {ol.format.XML} + * @todo api */ ol.format.WMSCapabilities = function() { @@ -28,6 +29,17 @@ ol.format.WMSCapabilities = function() { goog.inherits(ol.format.WMSCapabilities, ol.format.XML); +/** + * Read a WMS capabilities document. + * + * @function + * @param {Document|Node|string} source The XML source. + * @return {Object} An object representing the WMS capabilities. + * @todo api + */ +ol.format.WMSCapabilities.prototype.read; + + /** * @param {Document} doc Document. * @return {Object} WMS Capability object. diff --git a/src/ol/geolocation.exports b/src/ol/geolocation.exports deleted file mode 100644 index adc26edc01..0000000000 --- a/src/ol/geolocation.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.Geolocation diff --git a/src/ol/geolocation.js b/src/ol/geolocation.js index f2a291dbab..31f2368a47 100644 --- a/src/ol/geolocation.js +++ b/src/ol/geolocation.js @@ -72,6 +72,7 @@ ol.GeolocationProperty = { * @todo observable trackingOptions {GeolocationPositionOptions} PositionOptions * as defined by the HTML5 Geolocation spec at * http://www.w3.org/TR/geolocation-API/#position_options_interface + * @todo api */ ol.Geolocation = function(opt_options) { diff --git a/src/ol/geom/circle.exports b/src/ol/geom/circle.exports deleted file mode 100644 index e08d6f83be..0000000000 --- a/src/ol/geom/circle.exports +++ /dev/null @@ -1,11 +0,0 @@ -@exportSymbol ol.geom.Circle -@exportProperty ol.geom.Circle.prototype.clone -@exportProperty ol.geom.Circle.prototype.getCenter -@exportProperty ol.geom.Circle.prototype.getExtent -@exportProperty ol.geom.Circle.prototype.getRadius -@exportProperty ol.geom.Circle.prototype.getSimplifiedGeometry -@exportProperty ol.geom.Circle.prototype.getType -@exportProperty ol.geom.Circle.prototype.setCenter -@exportProperty ol.geom.Circle.prototype.setCenterAndRadius -@exportProperty ol.geom.Circle.prototype.setRadius -@exportProperty ol.geom.Circle.prototype.transform diff --git a/src/ol/geom/circle.js b/src/ol/geom/circle.js index 72457fd35d..166607ac96 100644 --- a/src/ol/geom/circle.js +++ b/src/ol/geom/circle.js @@ -15,6 +15,7 @@ goog.require('ol.geom.flat.deflate'); * @param {number=} opt_radius Radius. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.Circle = function(center, opt_radius, opt_layout) { goog.base(this); @@ -27,6 +28,7 @@ goog.inherits(ol.geom.Circle, ol.geom.SimpleGeometry); /** * @inheritDoc + * @todo api */ ol.geom.Circle.prototype.clone = function() { var circle = new ol.geom.Circle(null); @@ -80,6 +82,7 @@ ol.geom.Circle.prototype.containsXY = function(x, y) { /** * @return {ol.geom.RawPoint} Center. * @todo stability experimental + * @todo api */ ol.geom.Circle.prototype.getCenter = function() { return this.flatCoordinates.slice(0, this.stride); @@ -88,6 +91,7 @@ ol.geom.Circle.prototype.getCenter = function() { /** * @inheritDoc + * @todo api */ ol.geom.Circle.prototype.getExtent = function(opt_extent) { if (this.extentRevision != this.getRevision()) { @@ -107,6 +111,7 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) { /** * @return {number} Radius. * @todo stability experimental + * @todo api */ ol.geom.Circle.prototype.getRadius = function() { return Math.sqrt(this.getRadiusSquared_()); @@ -126,6 +131,7 @@ ol.geom.Circle.prototype.getRadiusSquared_ = function() { /** * @inheritDoc + * @todo api */ ol.geom.Circle.prototype.getSimplifiedGeometry = function(squaredTolerance) { return this; @@ -134,6 +140,7 @@ ol.geom.Circle.prototype.getSimplifiedGeometry = function(squaredTolerance) { /** * @inheritDoc + * @todo api */ ol.geom.Circle.prototype.getType = function() { return ol.geom.GeometryType.CIRCLE; @@ -143,6 +150,7 @@ ol.geom.Circle.prototype.getType = function() { /** * @param {ol.geom.RawPoint} center Center. * @todo stability experimental + * @todo api */ ol.geom.Circle.prototype.setCenter = function(center) { var stride = this.stride; @@ -163,6 +171,7 @@ ol.geom.Circle.prototype.setCenter = function(center) { * @param {number} radius Radius. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.Circle.prototype.setCenterAndRadius = function(center, radius, opt_layout) { @@ -202,6 +211,7 @@ ol.geom.Circle.prototype.setFlatCoordinates = /** * @param {number} radius Radius. * @todo stability experimental + * @todo api */ ol.geom.Circle.prototype.setRadius = function(radius) { goog.asserts.assert(!goog.isNull(this.flatCoordinates)); diff --git a/src/ol/geom/geometry.exports b/src/ol/geom/geometry.exports deleted file mode 100644 index 4c332d46de..0000000000 --- a/src/ol/geom/geometry.exports +++ /dev/null @@ -1,3 +0,0 @@ -@exportSymbol ol.geom.Geometry -@exportProperty ol.geom.Geometry.prototype.getClosestPoint -@exportProperty ol.geom.Geometry.prototype.getType diff --git a/src/ol/geom/geometry.js b/src/ol/geom/geometry.js index 0cf308b55f..3c8f0dfa40 100644 --- a/src/ol/geom/geometry.js +++ b/src/ol/geom/geometry.js @@ -38,6 +38,7 @@ ol.geom.GeometryLayout = { * @constructor * @extends {ol.Observable} * @todo stability experimental + * @todo api */ ol.geom.Geometry = function() { @@ -99,6 +100,7 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod; * @param {ol.Coordinate=} opt_closestPoint Closest point. * @return {ol.Coordinate} Closest point. * @todo stability experimental + * @todo api */ ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) { var closestPoint = goog.isDef(opt_closestPoint) ? @@ -144,6 +146,7 @@ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod; /** * @return {ol.geom.GeometryType} Geometry type. * @todo stability experimental + * @todo api */ ol.geom.Geometry.prototype.getType = goog.abstractMethod; diff --git a/src/ol/geom/geometrycollection.exports b/src/ol/geom/geometrycollection.exports deleted file mode 100644 index 103ce2c40f..0000000000 --- a/src/ol/geom/geometrycollection.exports +++ /dev/null @@ -1,7 +0,0 @@ -@exportSymbol ol.geom.GeometryCollection -@exportProperty ol.geom.GeometryCollection.prototype.clone -@exportProperty ol.geom.GeometryCollection.prototype.getExtent -@exportProperty ol.geom.GeometryCollection.prototype.getGeometries -@exportProperty ol.geom.GeometryCollection.prototype.getSimplifiedGeometry -@exportProperty ol.geom.GeometryCollection.prototype.getType -@exportProperty ol.geom.GeometryCollection.prototype.setGeometries diff --git a/src/ol/geom/geometrycollection.js b/src/ol/geom/geometrycollection.js index 12b8f5a0b5..55bf7966da 100644 --- a/src/ol/geom/geometrycollection.js +++ b/src/ol/geom/geometrycollection.js @@ -16,6 +16,7 @@ goog.require('ol.geom.GeometryType'); * @extends {ol.geom.Geometry} * @param {Array.=} opt_geometries Geometries. * @todo stability experimental + * @todo api */ ol.geom.GeometryCollection = function(opt_geometries) { @@ -81,6 +82,7 @@ ol.geom.GeometryCollection.prototype.listenGeometriesChange_ = function() { /** * @inheritDoc + * @todo api */ ol.geom.GeometryCollection.prototype.clone = function() { var geometryCollection = new ol.geom.GeometryCollection(null); @@ -125,6 +127,7 @@ ol.geom.GeometryCollection.prototype.containsXY = function(x, y) { /** * @inheritDoc + * @todo api */ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) { if (this.extentRevision != this.getRevision()) { @@ -145,6 +148,7 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) { /** * @return {Array.} Geometries. * @todo stability experimental + * @todo api */ ol.geom.GeometryCollection.prototype.getGeometries = function() { return ol.geom.GeometryCollection.cloneGeometries_(this.geometries_); @@ -161,6 +165,7 @@ ol.geom.GeometryCollection.prototype.getGeometriesArray = function() { /** * @inheritDoc + * @todo api */ ol.geom.GeometryCollection.prototype.getSimplifiedGeometry = function(squaredTolerance) { @@ -205,6 +210,7 @@ ol.geom.GeometryCollection.prototype.getSimplifiedGeometry = /** * @inheritDoc + * @todo api */ ol.geom.GeometryCollection.prototype.getType = function() { return ol.geom.GeometryType.GEOMETRY_COLLECTION; @@ -223,6 +229,7 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() { /** * @param {Array.} geometries Geometries. * @todo stability experimental + * @todo api */ ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) { this.setGeometriesArray( diff --git a/src/ol/geom/linearring.exports b/src/ol/geom/linearring.exports deleted file mode 100644 index 568949b1bb..0000000000 --- a/src/ol/geom/linearring.exports +++ /dev/null @@ -1,6 +0,0 @@ -@exportSymbol ol.geom.LinearRing -@exportProperty ol.geom.LinearRing.prototype.clone -@exportProperty ol.geom.LinearRing.prototype.getArea -@exportProperty ol.geom.LinearRing.prototype.getCoordinates -@exportProperty ol.geom.LinearRing.prototype.getType -@exportProperty ol.geom.LinearRing.prototype.setCoordinates diff --git a/src/ol/geom/linearring.js b/src/ol/geom/linearring.js index 18250e7613..aa512db31c 100644 --- a/src/ol/geom/linearring.js +++ b/src/ol/geom/linearring.js @@ -17,6 +17,7 @@ goog.require('ol.geom.flat.simplify'); * @param {ol.geom.RawLinearRing} coordinates Coordinates. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.LinearRing = function(coordinates, opt_layout) { @@ -43,6 +44,7 @@ goog.inherits(ol.geom.LinearRing, ol.geom.SimpleGeometry); /** * @inheritDoc + * @todo api */ ol.geom.LinearRing.prototype.clone = function() { var linearRing = new ol.geom.LinearRing(null); @@ -74,6 +76,7 @@ ol.geom.LinearRing.prototype.closestPointXY = /** * @return {number} Area. * @todo stability experimental + * @todo api */ ol.geom.LinearRing.prototype.getArea = function() { return ol.geom.flat.area.linearRing( @@ -84,6 +87,7 @@ ol.geom.LinearRing.prototype.getArea = function() { /** * @return {ol.geom.RawLinearRing} Coordinates. * @todo stability experimental + * @todo api */ ol.geom.LinearRing.prototype.getCoordinates = function() { return ol.geom.flat.inflate.coordinates( @@ -109,6 +113,7 @@ ol.geom.LinearRing.prototype.getSimplifiedGeometryInternal = /** * @inheritDoc + * @todo api */ ol.geom.LinearRing.prototype.getType = function() { return ol.geom.GeometryType.LINEAR_RING; @@ -119,6 +124,7 @@ ol.geom.LinearRing.prototype.getType = function() { * @param {ol.geom.RawLinearRing} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.LinearRing.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/linestring.exports b/src/ol/geom/linestring.exports deleted file mode 100644 index f1f95ce7c1..0000000000 --- a/src/ol/geom/linestring.exports +++ /dev/null @@ -1,8 +0,0 @@ -@exportSymbol ol.geom.LineString -@exportProperty ol.geom.LineString.prototype.appendCoordinate -@exportProperty ol.geom.LineString.prototype.clone -@exportProperty ol.geom.LineString.prototype.getCoordinateAtM -@exportProperty ol.geom.LineString.prototype.getCoordinates -@exportProperty ol.geom.LineString.prototype.getLength -@exportProperty ol.geom.LineString.prototype.getType -@exportProperty ol.geom.LineString.prototype.setCoordinates diff --git a/src/ol/geom/linestring.js b/src/ol/geom/linestring.js index 92d99f5d98..db068ea4fa 100644 --- a/src/ol/geom/linestring.js +++ b/src/ol/geom/linestring.js @@ -21,6 +21,7 @@ goog.require('ol.geom.flat.simplify'); * @param {ol.geom.RawLineString} coordinates Coordinates. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.LineString = function(coordinates, opt_layout) { @@ -59,6 +60,7 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry); /** * @param {ol.Coordinate} coordinate Coordinate. + * @todo api */ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) { goog.asserts.assert(coordinate.length == this.stride); @@ -73,6 +75,7 @@ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) { /** * @inheritDoc + * @todo api */ ol.geom.LineString.prototype.clone = function() { var lineString = new ol.geom.LineString(null); @@ -113,6 +116,7 @@ ol.geom.LineString.prototype.closestPointXY = * @param {number} m M. * @param {boolean=} opt_extrapolate Extrapolate. * @return {ol.Coordinate} Coordinate. + * @todo api */ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) { if (this.layout != ol.geom.GeometryLayout.XYM && @@ -128,6 +132,7 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) { /** * @return {ol.geom.RawLineString} Coordinates. * @todo stability experimental + * @todo api */ ol.geom.LineString.prototype.getCoordinates = function() { return ol.geom.flat.inflate.coordinates( @@ -138,6 +143,7 @@ ol.geom.LineString.prototype.getCoordinates = function() { /** * @return {number} Length. * @todo stability experimental + * @todo api */ ol.geom.LineString.prototype.getLength = function() { return ol.geom.flat.length.lineString( @@ -177,6 +183,7 @@ ol.geom.LineString.prototype.getSimplifiedGeometryInternal = /** * @inheritDoc + * @todo api */ ol.geom.LineString.prototype.getType = function() { return ol.geom.GeometryType.LINE_STRING; @@ -187,6 +194,7 @@ ol.geom.LineString.prototype.getType = function() { * @param {ol.geom.RawLineString} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.LineString.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/multilinestring.exports b/src/ol/geom/multilinestring.exports deleted file mode 100644 index 9390428f2a..0000000000 --- a/src/ol/geom/multilinestring.exports +++ /dev/null @@ -1,9 +0,0 @@ -@exportSymbol ol.geom.MultiLineString -@exportProperty ol.geom.MultiLineString.prototype.appendLineString -@exportProperty ol.geom.MultiLineString.prototype.clone -@exportProperty ol.geom.MultiLineString.prototype.getCoordinateAtM -@exportProperty ol.geom.MultiLineString.prototype.getCoordinates -@exportProperty ol.geom.MultiLineString.prototype.getLineString -@exportProperty ol.geom.MultiLineString.prototype.getLineStrings -@exportProperty ol.geom.MultiLineString.prototype.getType -@exportProperty ol.geom.MultiLineString.prototype.setCoordinates diff --git a/src/ol/geom/multilinestring.js b/src/ol/geom/multilinestring.js index 895bf6472e..bd9b66308c 100644 --- a/src/ol/geom/multilinestring.js +++ b/src/ol/geom/multilinestring.js @@ -21,6 +21,7 @@ goog.require('ol.geom.flat.simplify'); * @param {ol.geom.RawMultiLineString} coordinates Coordinates. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.MultiLineString = function(coordinates, opt_layout) { @@ -53,6 +54,7 @@ goog.inherits(ol.geom.MultiLineString, ol.geom.SimpleGeometry); /** * @param {ol.geom.LineString} lineString LineString. + * @todo api */ ol.geom.MultiLineString.prototype.appendLineString = function(lineString) { goog.asserts.assert(lineString.getLayout() == this.layout); @@ -69,6 +71,7 @@ ol.geom.MultiLineString.prototype.appendLineString = function(lineString) { /** * @inheritDoc + * @todo api */ ol.geom.MultiLineString.prototype.clone = function() { var multiLineString = new ol.geom.MultiLineString(null); @@ -118,6 +121,7 @@ ol.geom.MultiLineString.prototype.closestPointXY = * @param {boolean=} opt_extrapolate Extrapolate. * @param {boolean=} opt_interpolate Interpolate. * @return {ol.Coordinate} Coordinate. + * @todo api */ ol.geom.MultiLineString.prototype.getCoordinateAtM = function(m, opt_extrapolate, opt_interpolate) { @@ -136,6 +140,7 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM = /** * @return {ol.geom.RawMultiLineString} Coordinates. * @todo stability experimental + * @todo api */ ol.geom.MultiLineString.prototype.getCoordinates = function() { return ol.geom.flat.inflate.coordinatess( @@ -154,6 +159,7 @@ ol.geom.MultiLineString.prototype.getEnds = function() { /** * @param {number} index Index. * @return {ol.geom.LineString} LineString. + * @todo api */ ol.geom.MultiLineString.prototype.getLineString = function(index) { goog.asserts.assert(0 <= index && index < this.ends_.length); @@ -170,6 +176,7 @@ ol.geom.MultiLineString.prototype.getLineString = function(index) { /** * @return {Array.} LineStrings. * @todo stability experimental + * @todo api */ ol.geom.MultiLineString.prototype.getLineStrings = function() { var flatCoordinates = this.flatCoordinates; @@ -230,6 +237,7 @@ ol.geom.MultiLineString.prototype.getSimplifiedGeometryInternal = /** * @inheritDoc + * @todo api */ ol.geom.MultiLineString.prototype.getType = function() { return ol.geom.GeometryType.MULTI_LINE_STRING; @@ -240,6 +248,7 @@ ol.geom.MultiLineString.prototype.getType = function() { * @param {ol.geom.RawMultiLineString} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.MultiLineString.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/multipoint.exports b/src/ol/geom/multipoint.exports deleted file mode 100644 index b00ddcae09..0000000000 --- a/src/ol/geom/multipoint.exports +++ /dev/null @@ -1,8 +0,0 @@ -@exportSymbol ol.geom.MultiPoint -@exportProperty ol.geom.MultiPoint.prototype.appendPoint -@exportProperty ol.geom.MultiPoint.prototype.clone -@exportProperty ol.geom.MultiPoint.prototype.getCoordinates -@exportProperty ol.geom.MultiPoint.prototype.getPoint -@exportProperty ol.geom.MultiPoint.prototype.getPoints -@exportProperty ol.geom.MultiPoint.prototype.getType -@exportProperty ol.geom.MultiPoint.prototype.setCoordinates diff --git a/src/ol/geom/multipoint.js b/src/ol/geom/multipoint.js index 1e5c12d91f..c2b31b5130 100644 --- a/src/ol/geom/multipoint.js +++ b/src/ol/geom/multipoint.js @@ -19,6 +19,7 @@ goog.require('ol.math'); * @param {ol.geom.RawMultiPoint} coordinates Coordinates. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.MultiPoint = function(coordinates, opt_layout) { goog.base(this); @@ -30,6 +31,7 @@ goog.inherits(ol.geom.MultiPoint, ol.geom.SimpleGeometry); /** * @param {ol.geom.Point} point Point. + * @todo api */ ol.geom.MultiPoint.prototype.appendPoint = function(point) { goog.asserts.assert(point.getLayout() == this.layout); @@ -44,6 +46,7 @@ ol.geom.MultiPoint.prototype.appendPoint = function(point) { /** * @inheritDoc + * @todo api */ ol.geom.MultiPoint.prototype.clone = function() { var multiPoint = new ol.geom.MultiPoint(null); @@ -82,6 +85,7 @@ ol.geom.MultiPoint.prototype.closestPointXY = /** * @return {ol.geom.RawMultiPoint} Coordinates. * @todo stability experimental + * @todo api */ ol.geom.MultiPoint.prototype.getCoordinates = function() { return ol.geom.flat.inflate.coordinates( @@ -92,6 +96,7 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() { /** * @param {number} index Index. * @return {ol.geom.Point} Point. + * @todo api */ ol.geom.MultiPoint.prototype.getPoint = function(index) { var n = goog.isNull(this.flatCoordinates) ? @@ -110,6 +115,7 @@ ol.geom.MultiPoint.prototype.getPoint = function(index) { /** * @return {Array.} Points. * @todo stability experimental + * @todo api */ ol.geom.MultiPoint.prototype.getPoints = function() { var flatCoordinates = this.flatCoordinates; @@ -129,6 +135,7 @@ ol.geom.MultiPoint.prototype.getPoints = function() { /** * @inheritDoc + * @todo api */ ol.geom.MultiPoint.prototype.getType = function() { return ol.geom.GeometryType.MULTI_POINT; @@ -139,6 +146,7 @@ ol.geom.MultiPoint.prototype.getType = function() { * @param {ol.geom.RawMultiPoint} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.MultiPoint.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/multipolygon.exports b/src/ol/geom/multipolygon.exports deleted file mode 100644 index 6f67842bc3..0000000000 --- a/src/ol/geom/multipolygon.exports +++ /dev/null @@ -1,10 +0,0 @@ -@exportSymbol ol.geom.MultiPolygon -@exportProperty ol.geom.MultiPolygon.prototype.appendPolygon -@exportProperty ol.geom.MultiPolygon.prototype.clone -@exportProperty ol.geom.MultiPolygon.prototype.getArea -@exportProperty ol.geom.MultiPolygon.prototype.getCoordinates -@exportProperty ol.geom.MultiPolygon.prototype.getInteriorPoints -@exportProperty ol.geom.MultiPolygon.prototype.getPolygon -@exportProperty ol.geom.MultiPolygon.prototype.getPolygons -@exportProperty ol.geom.MultiPolygon.prototype.getType -@exportProperty ol.geom.MultiPolygon.prototype.setCoordinates diff --git a/src/ol/geom/multipolygon.js b/src/ol/geom/multipolygon.js index 1030852894..24995bb6db 100644 --- a/src/ol/geom/multipolygon.js +++ b/src/ol/geom/multipolygon.js @@ -26,6 +26,7 @@ goog.require('ol.geom.flat.simplify'); * @param {ol.geom.RawMultiPolygon} coordinates Coordinates. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.MultiPolygon = function(coordinates, opt_layout) { @@ -82,6 +83,7 @@ goog.inherits(ol.geom.MultiPolygon, ol.geom.SimpleGeometry); /** * @param {ol.geom.Polygon} polygon Polygon. + * @todo api */ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) { goog.asserts.assert(polygon.getLayout() == this.layout); @@ -107,6 +109,7 @@ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) { /** * @inheritDoc + * @todo api */ ol.geom.MultiPolygon.prototype.clone = function() { var multiPolygon = new ol.geom.MultiPolygon(null); @@ -148,6 +151,7 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) { /** * @return {number} Area. * @todo stability experimental + * @todo api */ ol.geom.MultiPolygon.prototype.getArea = function() { return ol.geom.flat.area.linearRingss( @@ -158,6 +162,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() { /** * @return {ol.geom.RawMultiPolygon} Coordinates. * @todo stability experimental + * @todo api */ ol.geom.MultiPolygon.prototype.getCoordinates = function() { return ol.geom.flat.inflate.coordinatesss( @@ -191,6 +196,7 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() { /** * @return {ol.geom.MultiPoint} Interior points. + * @todo api */ ol.geom.MultiPolygon.prototype.getInteriorPoints = function() { var interiorPoints = new ol.geom.MultiPoint(null); @@ -242,6 +248,7 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal = /** * @param {number} index Index. * @return {ol.geom.Polygon} Polygon. + * @todo api */ ol.geom.MultiPolygon.prototype.getPolygon = function(index) { goog.asserts.assert(0 <= index && index < this.endss_.length); @@ -273,6 +280,7 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) { /** * @return {Array.} Polygons. * @todo stability experimental + * @todo api */ ol.geom.MultiPolygon.prototype.getPolygons = function() { var layout = this.layout; @@ -301,6 +309,7 @@ ol.geom.MultiPolygon.prototype.getPolygons = function() { /** * @inheritDoc + * @todo api */ ol.geom.MultiPolygon.prototype.getType = function() { return ol.geom.GeometryType.MULTI_POLYGON; @@ -311,6 +320,7 @@ ol.geom.MultiPolygon.prototype.getType = function() { * @param {ol.geom.RawMultiPolygon} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.MultiPolygon.prototype.setCoordinates = function(coordinates, opt_layout) { diff --git a/src/ol/geom/point.exports b/src/ol/geom/point.exports deleted file mode 100644 index f48a3b7a4d..0000000000 --- a/src/ol/geom/point.exports +++ /dev/null @@ -1,5 +0,0 @@ -@exportSymbol ol.geom.Point -@exportProperty ol.geom.Point.prototype.clone -@exportProperty ol.geom.Point.prototype.getCoordinates -@exportProperty ol.geom.Point.prototype.getType -@exportProperty ol.geom.Point.prototype.setCoordinates diff --git a/src/ol/geom/point.js b/src/ol/geom/point.js index fafd43f30b..56417176e5 100644 --- a/src/ol/geom/point.js +++ b/src/ol/geom/point.js @@ -15,6 +15,7 @@ goog.require('ol.math'); * @param {ol.geom.RawPoint} coordinates Coordinates. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.Point = function(coordinates, opt_layout) { goog.base(this); @@ -26,6 +27,7 @@ goog.inherits(ol.geom.Point, ol.geom.SimpleGeometry); /** * @inheritDoc + * @todo api */ ol.geom.Point.prototype.clone = function() { var point = new ol.geom.Point(null); @@ -59,6 +61,7 @@ ol.geom.Point.prototype.closestPointXY = /** * @return {ol.geom.RawPoint} Coordinates. * @todo stability experimental + * @todo api */ ol.geom.Point.prototype.getCoordinates = function() { return this.flatCoordinates.slice(); @@ -81,6 +84,7 @@ ol.geom.Point.prototype.getExtent = function(opt_extent) { /** * @inheritDoc + * @todo api */ ol.geom.Point.prototype.getType = function() { return ol.geom.GeometryType.POINT; @@ -91,6 +95,7 @@ ol.geom.Point.prototype.getType = function() { * @param {ol.geom.RawPoint} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) { if (goog.isNull(coordinates)) { diff --git a/src/ol/geom/polygon.exports b/src/ol/geom/polygon.exports deleted file mode 100644 index 214d5e02c6..0000000000 --- a/src/ol/geom/polygon.exports +++ /dev/null @@ -1,10 +0,0 @@ -@exportSymbol ol.geom.Polygon -@exportProperty ol.geom.Polygon.prototype.appendLinearRing -@exportProperty ol.geom.Polygon.prototype.clone -@exportProperty ol.geom.Polygon.prototype.getArea -@exportProperty ol.geom.Polygon.prototype.getCoordinates -@exportProperty ol.geom.Polygon.prototype.getInteriorPoint -@exportProperty ol.geom.Polygon.prototype.getLinearRing -@exportProperty ol.geom.Polygon.prototype.getLinearRings -@exportProperty ol.geom.Polygon.prototype.getType -@exportProperty ol.geom.Polygon.prototype.setCoordinates diff --git a/src/ol/geom/polygon.js b/src/ol/geom/polygon.js index a857b367fe..d90ffb6fbf 100644 --- a/src/ol/geom/polygon.js +++ b/src/ol/geom/polygon.js @@ -25,6 +25,7 @@ goog.require('ol.geom.flat.simplify'); * @param {ol.geom.RawPolygon} coordinates Coordinates. * @param {ol.geom.GeometryLayout|string=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.Polygon = function(coordinates, opt_layout) { @@ -81,6 +82,7 @@ goog.inherits(ol.geom.Polygon, ol.geom.SimpleGeometry); /** * @param {ol.geom.LinearRing} linearRing Linear ring. + * @todo api */ ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) { goog.asserts.assert(linearRing.getLayout() == this.layout); @@ -96,6 +98,7 @@ ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) { /** * @inheritDoc + * @todo api */ ol.geom.Polygon.prototype.clone = function() { var polygon = new ol.geom.Polygon(null); @@ -137,6 +140,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) { /** * @return {number} Area. * @todo stability experimental + * @todo api */ ol.geom.Polygon.prototype.getArea = function() { return ol.geom.flat.area.linearRings( @@ -147,6 +151,7 @@ ol.geom.Polygon.prototype.getArea = function() { /** * @return {ol.geom.RawPolygon} Coordinates. * @todo stability experimental + * @todo api */ ol.geom.Polygon.prototype.getCoordinates = function() { return ol.geom.flat.inflate.coordinatess( @@ -179,6 +184,7 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() { /** * @return {ol.geom.Point} Interior point. + * @todo api */ ol.geom.Polygon.prototype.getInteriorPoint = function() { return new ol.geom.Point(this.getFlatInteriorPoint()); @@ -188,6 +194,7 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() { /** * @param {number} index Index. * @return {ol.geom.LinearRing} Linear ring. + * @todo api */ ol.geom.Polygon.prototype.getLinearRing = function(index) { goog.asserts.assert(0 <= index && index < this.ends_.length); @@ -204,6 +211,7 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) { /** * @return {Array.} Linear rings. * @todo stability experimental + * @todo api */ ol.geom.Polygon.prototype.getLinearRings = function() { var layout = this.layout; @@ -264,6 +272,7 @@ ol.geom.Polygon.prototype.getSimplifiedGeometryInternal = /** * @inheritDoc + * @todo api */ ol.geom.Polygon.prototype.getType = function() { return ol.geom.GeometryType.POLYGON; @@ -274,6 +283,7 @@ ol.geom.Polygon.prototype.getType = function() { * @param {ol.geom.RawPolygon} coordinates Coordinates. * @param {ol.geom.GeometryLayout=} opt_layout Layout. * @todo stability experimental + * @todo api */ ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) { if (goog.isNull(coordinates)) { diff --git a/src/ol/geom/simplegeometry.exports b/src/ol/geom/simplegeometry.exports deleted file mode 100644 index 9ba0b04b69..0000000000 --- a/src/ol/geom/simplegeometry.exports +++ /dev/null @@ -1,7 +0,0 @@ -@exportSymbol ol.geom.SimpleGeometry -@exportProperty ol.geom.SimpleGeometry.prototype.getExtent -@exportProperty ol.geom.SimpleGeometry.prototype.getFirstCoordinate -@exportProperty ol.geom.SimpleGeometry.prototype.getLastCoordinate -@exportProperty ol.geom.SimpleGeometry.prototype.getLayout -@exportProperty ol.geom.SimpleGeometry.prototype.getSimplifiedGeometry -@exportProperty ol.geom.SimpleGeometry.prototype.transform diff --git a/src/ol/geom/simplegeometry.js b/src/ol/geom/simplegeometry.js index e1841008d3..604a9f1c70 100644 --- a/src/ol/geom/simplegeometry.js +++ b/src/ol/geom/simplegeometry.js @@ -13,6 +13,7 @@ goog.require('ol.geom.flat.transform'); * @constructor * @extends {ol.geom.Geometry} * @todo stability experimental + * @todo api */ ol.geom.SimpleGeometry = function() { @@ -86,6 +87,7 @@ ol.geom.SimpleGeometry.prototype.containsXY = goog.functions.FALSE; /** * @inheritDoc + * @todo api */ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) { if (this.extentRevision != this.getRevision()) { @@ -101,6 +103,7 @@ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) { /** * @return {ol.Coordinate} First coordinate. + * @todo api */ ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() { return this.flatCoordinates.slice(0, this.stride); @@ -117,6 +120,7 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() { /** * @return {ol.Coordinate} Last point. + * @todo api */ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() { return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride); @@ -126,6 +130,7 @@ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() { /** * @return {ol.geom.GeometryLayout} Layout. * @todo stability experimental + * @todo api */ ol.geom.SimpleGeometry.prototype.getLayout = function() { return this.layout; @@ -134,6 +139,7 @@ ol.geom.SimpleGeometry.prototype.getLayout = function() { /** * @inheritDoc + * @todo api */ ol.geom.SimpleGeometry.prototype.getSimplifiedGeometry = function(squaredTolerance) { @@ -238,6 +244,7 @@ ol.geom.SimpleGeometry.prototype.setLayout = /** * @inheritDoc + * @todo api */ ol.geom.SimpleGeometry.prototype.transform = function(transformFn) { if (!goog.isNull(this.flatCoordinates)) { diff --git a/src/ol/imagetile.exports b/src/ol/imagetile.exports deleted file mode 100644 index 25d191acba..0000000000 --- a/src/ol/imagetile.exports +++ /dev/null @@ -1 +0,0 @@ -@exportProperty ol.ImageTile.prototype.getImage diff --git a/src/ol/imagetile.js b/src/ol/imagetile.js index 1fa5c9b866..30fffd1cd8 100644 --- a/src/ol/imagetile.js +++ b/src/ol/imagetile.js @@ -69,6 +69,7 @@ goog.inherits(ol.ImageTile, ol.Tile); /** * @inheritDoc * @todo stability experimental + * @todo api */ ol.ImageTile.prototype.getImage = function(opt_context) { if (goog.isDef(opt_context)) { diff --git a/src/ol/interaction/doubleclickzoom.exports b/src/ol/interaction/doubleclickzoom.exports deleted file mode 100644 index 796868f1f1..0000000000 --- a/src/ol/interaction/doubleclickzoom.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.DoubleClickZoom diff --git a/src/ol/interaction/doubleclickzoominteraction.js b/src/ol/interaction/doubleclickzoominteraction.js index e5b019de33..4cdd19522c 100644 --- a/src/ol/interaction/doubleclickzoominteraction.js +++ b/src/ol/interaction/doubleclickzoominteraction.js @@ -16,6 +16,7 @@ goog.require('ol.interaction.Interaction'); * @extends {ol.interaction.Interaction} * @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.DoubleClickZoom = function(opt_options) { diff --git a/src/ol/interaction/draganddropinteraction.exports b/src/ol/interaction/draganddropinteraction.exports deleted file mode 100644 index 50e9fef9e3..0000000000 --- a/src/ol/interaction/draganddropinteraction.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.DragAndDrop diff --git a/src/ol/interaction/draganddropinteraction.js b/src/ol/interaction/draganddropinteraction.js index f2a62ba773..8fcc5ecb4b 100644 --- a/src/ol/interaction/draganddropinteraction.js +++ b/src/ol/interaction/draganddropinteraction.js @@ -22,6 +22,7 @@ goog.require('ol.proj'); * @fires {@link ol.interaction.DragAndDropEvent} * ol.interaction.DragAndDropEvent * @param {olx.interaction.DragAndDropOptions=} opt_options Options. + * @todo api */ ol.interaction.DragAndDrop = function(opt_options) { diff --git a/src/ol/interaction/dragboxinteraction.exports b/src/ol/interaction/dragboxinteraction.exports deleted file mode 100644 index 7b578e067a..0000000000 --- a/src/ol/interaction/dragboxinteraction.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.interaction.DragBox -@exportProperty ol.interaction.DragBox.prototype.getGeometry diff --git a/src/ol/interaction/dragboxinteraction.js b/src/ol/interaction/dragboxinteraction.js index 998fb985bd..8d2fdcf54d 100644 --- a/src/ol/interaction/dragboxinteraction.js +++ b/src/ol/interaction/dragboxinteraction.js @@ -84,6 +84,7 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event); * @fires {@link ol.DragBoxEvent} ol.DragBoxEvent * @param {olx.interaction.DragBoxOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.DragBox = function(opt_options) { @@ -135,6 +136,7 @@ ol.interaction.DragBox.prototype.handlePointerDrag = function(mapBrowserEvent) { /** * Returns geometry of last drawn box. * @return {ol.geom.Geometry} Geometry. + * @todo api */ ol.interaction.DragBox.prototype.getGeometry = function() { return this.box_.getGeometry(); diff --git a/src/ol/interaction/dragpaninteraction.exports b/src/ol/interaction/dragpaninteraction.exports deleted file mode 100644 index dbc71bf21a..0000000000 --- a/src/ol/interaction/dragpaninteraction.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.DragPan diff --git a/src/ol/interaction/dragpaninteraction.js b/src/ol/interaction/dragpaninteraction.js index 022aca8974..f370ea9613 100644 --- a/src/ol/interaction/dragpaninteraction.js +++ b/src/ol/interaction/dragpaninteraction.js @@ -19,6 +19,7 @@ goog.require('ol.interaction.Pointer'); * @extends {ol.interaction.Pointer} * @param {olx.interaction.DragPanOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.DragPan = function(opt_options) { diff --git a/src/ol/interaction/dragrotate.exports b/src/ol/interaction/dragrotate.exports deleted file mode 100644 index b17241c644..0000000000 --- a/src/ol/interaction/dragrotate.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.DragRotate diff --git a/src/ol/interaction/dragrotateandzoom.exports b/src/ol/interaction/dragrotateandzoom.exports deleted file mode 100644 index f39bc1cf2a..0000000000 --- a/src/ol/interaction/dragrotateandzoom.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.DragRotateAndZoom diff --git a/src/ol/interaction/dragrotateandzoominteraction.js b/src/ol/interaction/dragrotateandzoominteraction.js index 80b689dfa4..0ef4123137 100644 --- a/src/ol/interaction/dragrotateandzoominteraction.js +++ b/src/ol/interaction/dragrotateandzoominteraction.js @@ -32,6 +32,7 @@ ol.interaction.DRAGROTATEANDZOOM_ANIMATION_DURATION = 400; * @extends {ol.interaction.Pointer} * @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.DragRotateAndZoom = function(opt_options) { diff --git a/src/ol/interaction/dragrotateinteraction.js b/src/ol/interaction/dragrotateinteraction.js index a9304e3ccd..1f383c41f0 100644 --- a/src/ol/interaction/dragrotateinteraction.js +++ b/src/ol/interaction/dragrotateinteraction.js @@ -25,6 +25,7 @@ ol.interaction.DRAGROTATE_ANIMATION_DURATION = 250; * @constructor * @extends {ol.interaction.Pointer} * @param {olx.interaction.DragRotateOptions=} opt_options Options. + * @todo api */ ol.interaction.DragRotate = function(opt_options) { diff --git a/src/ol/interaction/dragzoominteraction.exports b/src/ol/interaction/dragzoominteraction.exports deleted file mode 100644 index 204afabe7e..0000000000 --- a/src/ol/interaction/dragzoominteraction.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.DragZoom diff --git a/src/ol/interaction/dragzoominteraction.js b/src/ol/interaction/dragzoominteraction.js index 3955158a15..1c14abb952 100644 --- a/src/ol/interaction/dragzoominteraction.js +++ b/src/ol/interaction/dragzoominteraction.js @@ -24,6 +24,7 @@ ol.interaction.DRAGZOOM_ANIMATION_DURATION = 200; * @extends {ol.interaction.DragBox} * @param {olx.interaction.DragZoomOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.DragZoom = function(opt_options) { var options = goog.isDef(opt_options) ? opt_options : {}; diff --git a/src/ol/interaction/drawinteraction.exports b/src/ol/interaction/drawinteraction.exports deleted file mode 100644 index 890ae0f515..0000000000 --- a/src/ol/interaction/drawinteraction.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.Draw diff --git a/src/ol/interaction/drawinteraction.js b/src/ol/interaction/drawinteraction.js index d7ea269531..734a90f0cb 100644 --- a/src/ol/interaction/drawinteraction.js +++ b/src/ol/interaction/drawinteraction.js @@ -72,6 +72,7 @@ goog.inherits(ol.DrawEvent, goog.events.Event); * @fires {@link ol.DrawEvent} ol.DrawEvent * @param {olx.interaction.DrawOptions} options Options. * @todo stability experimental + * @todo api */ ol.interaction.Draw = function(options) { diff --git a/src/ol/interaction/interactiondefaults.exports b/src/ol/interaction/interactiondefaults.exports deleted file mode 100644 index 6a928864a2..0000000000 --- a/src/ol/interaction/interactiondefaults.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.defaults diff --git a/src/ol/interaction/interactiondefaults.js b/src/ol/interaction/interactiondefaults.js index cebb6c1e5b..4fbe399d77 100644 --- a/src/ol/interaction/interactiondefaults.js +++ b/src/ol/interaction/interactiondefaults.js @@ -26,6 +26,7 @@ goog.require('ol.interaction.PinchZoom'); * @return {ol.Collection} A collection of interactions to be used with * the ol.Map constructor's interactions option. * @todo stability experimental + * @todo api */ ol.interaction.defaults = function(opt_options) { diff --git a/src/ol/interaction/keyboardpan.exports b/src/ol/interaction/keyboardpan.exports deleted file mode 100644 index a09f837004..0000000000 --- a/src/ol/interaction/keyboardpan.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.KeyboardPan diff --git a/src/ol/interaction/keyboardpaninteraction.js b/src/ol/interaction/keyboardpaninteraction.js index a500383f3a..dc95b29ba0 100644 --- a/src/ol/interaction/keyboardpaninteraction.js +++ b/src/ol/interaction/keyboardpaninteraction.js @@ -34,6 +34,7 @@ ol.interaction.KEYBOARD_PAN_DURATION = 100; * @extends {ol.interaction.Interaction} * @param {olx.interaction.KeyboardPanOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.KeyboardPan = function(opt_options) { diff --git a/src/ol/interaction/keyboardzoom.exports b/src/ol/interaction/keyboardzoom.exports deleted file mode 100644 index 01a6a9d315..0000000000 --- a/src/ol/interaction/keyboardzoom.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.KeyboardZoom diff --git a/src/ol/interaction/keyboardzoominteraction.js b/src/ol/interaction/keyboardzoominteraction.js index 65db9890e7..7fac86d7ad 100644 --- a/src/ol/interaction/keyboardzoominteraction.js +++ b/src/ol/interaction/keyboardzoominteraction.js @@ -24,6 +24,7 @@ goog.require('ol.interaction.Interaction'); * @param {olx.interaction.KeyboardZoomOptions=} opt_options Options. * @extends {ol.interaction.Interaction} * @todo stability experimental + * @todo api */ ol.interaction.KeyboardZoom = function(opt_options) { diff --git a/src/ol/interaction/modifyinteraction.exports b/src/ol/interaction/modifyinteraction.exports deleted file mode 100644 index 60378a3759..0000000000 --- a/src/ol/interaction/modifyinteraction.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.Modify diff --git a/src/ol/interaction/modifyinteraction.js b/src/ol/interaction/modifyinteraction.js index dd4a589960..2aff57d691 100644 --- a/src/ol/interaction/modifyinteraction.js +++ b/src/ol/interaction/modifyinteraction.js @@ -40,6 +40,7 @@ ol.interaction.SegmentDataType; * @constructor * @extends {ol.interaction.Pointer} * @param {olx.interaction.ModifyOptions} options Options. + * @todo api */ ol.interaction.Modify = function(options) { diff --git a/src/ol/interaction/mousewheelzoom.exports b/src/ol/interaction/mousewheelzoom.exports deleted file mode 100644 index bd6f492da3..0000000000 --- a/src/ol/interaction/mousewheelzoom.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.MouseWheelZoom diff --git a/src/ol/interaction/mousewheelzoominteraction.js b/src/ol/interaction/mousewheelzoominteraction.js index 43834a5db2..ebd2e0ee1c 100644 --- a/src/ol/interaction/mousewheelzoominteraction.js +++ b/src/ol/interaction/mousewheelzoominteraction.js @@ -29,6 +29,7 @@ ol.interaction.MOUSEWHEELZOOM_TIMEOUT_DURATION = 80; * @extends {ol.interaction.Interaction} * @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.MouseWheelZoom = function(opt_options) { diff --git a/src/ol/interaction/pinchrotateinteraction.exports b/src/ol/interaction/pinchrotateinteraction.exports deleted file mode 100644 index 91c10d7b0f..0000000000 --- a/src/ol/interaction/pinchrotateinteraction.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.PinchRotate diff --git a/src/ol/interaction/pinchrotateinteraction.js b/src/ol/interaction/pinchrotateinteraction.js index 3ae73f0a42..e6838e49bd 100644 --- a/src/ol/interaction/pinchrotateinteraction.js +++ b/src/ol/interaction/pinchrotateinteraction.js @@ -24,6 +24,7 @@ ol.interaction.ROTATE_ANIMATION_DURATION = 250; * @extends {ol.interaction.Pointer} * @param {olx.interaction.PinchRotateOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.PinchRotate = function(opt_options) { diff --git a/src/ol/interaction/pinchzoominteraction.exports b/src/ol/interaction/pinchzoominteraction.exports deleted file mode 100644 index 4636cdfad8..0000000000 --- a/src/ol/interaction/pinchzoominteraction.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.interaction.PinchZoom diff --git a/src/ol/interaction/pinchzoominteraction.js b/src/ol/interaction/pinchzoominteraction.js index 06f3f45fd6..6d5a380b04 100644 --- a/src/ol/interaction/pinchzoominteraction.js +++ b/src/ol/interaction/pinchzoominteraction.js @@ -18,6 +18,7 @@ goog.require('ol.interaction.Pointer'); * @extends {ol.interaction.Pointer} * @param {olx.interaction.PinchZoomOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.PinchZoom = function(opt_options) { diff --git a/src/ol/interaction/selectinteraction.exports b/src/ol/interaction/selectinteraction.exports deleted file mode 100644 index eeccc7e10a..0000000000 --- a/src/ol/interaction/selectinteraction.exports +++ /dev/null @@ -1,3 +0,0 @@ -@exportSymbol ol.interaction.Select -@exportProperty ol.interaction.Select.prototype.getFeatures -@exportProperty ol.interaction.Select.prototype.setMap diff --git a/src/ol/interaction/selectinteraction.js b/src/ol/interaction/selectinteraction.js index 30bad1a3a3..fd26a10abb 100644 --- a/src/ol/interaction/selectinteraction.js +++ b/src/ol/interaction/selectinteraction.js @@ -19,6 +19,7 @@ goog.require('ol.interaction.Interaction'); * @extends {ol.interaction.Interaction} * @param {olx.interaction.SelectOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.interaction.Select = function(opt_options) { @@ -101,6 +102,7 @@ goog.inherits(ol.interaction.Select, ol.interaction.Interaction); /** * @return {ol.Collection} Features collection. * @todo stability experimental + * @todo api */ ol.interaction.Select.prototype.getFeatures = function() { return this.featureOverlay_.getFeatures(); @@ -171,6 +173,7 @@ ol.interaction.Select.prototype.handleMapBrowserEvent = /** * @inheritDoc + * @todo api */ ol.interaction.Select.prototype.setMap = function(map) { var currentMap = this.getMap(); diff --git a/src/ol/kinetic.exports b/src/ol/kinetic.exports deleted file mode 100644 index aa3f543286..0000000000 --- a/src/ol/kinetic.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.Kinetic diff --git a/src/ol/kinetic.js b/src/ol/kinetic.js index 6be0b123f9..840a809fb0 100644 --- a/src/ol/kinetic.js +++ b/src/ol/kinetic.js @@ -14,6 +14,7 @@ goog.require('ol.animation'); * initial values (milliseconds). * @struct * @todo stability experimental + * @todo api */ ol.Kinetic = function(decay, minVelocity, delay) { diff --git a/src/ol/layer/heatmaplayer.exports b/src/ol/layer/heatmaplayer.exports deleted file mode 100644 index be2de928b7..0000000000 --- a/src/ol/layer/heatmaplayer.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.layer.Heatmap diff --git a/src/ol/layer/heatmaplayer.js b/src/ol/layer/heatmaplayer.js index 6ddd2b9120..82d31f72b6 100644 --- a/src/ol/layer/heatmaplayer.js +++ b/src/ol/layer/heatmaplayer.js @@ -26,6 +26,7 @@ ol.layer.HeatmapLayerProperty = { * @fires {@link ol.render.Event} ol.render.Event * @param {olx.layer.HeatmapOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.layer.Heatmap = function(opt_options) { var options = goog.isDef(opt_options) ? opt_options : {}; diff --git a/src/ol/layer/imagelayer.exports b/src/ol/layer/imagelayer.exports deleted file mode 100644 index 0027269144..0000000000 --- a/src/ol/layer/imagelayer.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.layer.Image diff --git a/src/ol/layer/imagelayer.js b/src/ol/layer/imagelayer.js index dfa37cfe40..4f3b1730db 100644 --- a/src/ol/layer/imagelayer.js +++ b/src/ol/layer/imagelayer.js @@ -10,6 +10,7 @@ goog.require('ol.layer.Layer'); * @fires {@link ol.render.Event} ol.render.Event * @param {olx.layer.LayerOptions} options Layer options. * @todo stability experimental + * @todo api */ ol.layer.Image = function(options) { goog.base(this, options); diff --git a/src/ol/layer/layer.exports b/src/ol/layer/layer.exports deleted file mode 100644 index 1bc8b440a7..0000000000 --- a/src/ol/layer/layer.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.layer.Layer -@exportProperty ol.layer.Layer.prototype.getSource diff --git a/src/ol/layer/layer.js b/src/ol/layer/layer.js index 55850bafb5..3ec8706822 100644 --- a/src/ol/layer/layer.js +++ b/src/ol/layer/layer.js @@ -23,6 +23,7 @@ goog.require('ol.source.Source'); * @todo observable visible {boolean} the visiblity of the layer * @todo observable maxResolution {number} the maximum resolution of the layer * @todo observable minResolution {number} the minimum resolution of the layer + * @todo api */ ol.layer.Layer = function(options) { @@ -67,6 +68,7 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) { /** * @return {ol.source.Source} Source. * @todo stability experimental + * @todo api */ ol.layer.Layer.prototype.getSource = function() { return this.source_; diff --git a/src/ol/layer/layergroup.exports b/src/ol/layer/layergroup.exports deleted file mode 100644 index 54bd439663..0000000000 --- a/src/ol/layer/layergroup.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.layer.Group diff --git a/src/ol/layer/layergroup.js b/src/ol/layer/layergroup.js index d814571de3..7f1c6e2f9c 100644 --- a/src/ol/layer/layergroup.js +++ b/src/ol/layer/layergroup.js @@ -31,6 +31,7 @@ ol.layer.GroupProperty = { * @todo stability experimental * @todo observable layers {ol.Collection} collection of layers that are part * of this group + * @todo api */ ol.layer.Group = function(opt_options) { diff --git a/src/ol/layer/tilelayer.exports b/src/ol/layer/tilelayer.exports deleted file mode 100644 index 941be6ffc8..0000000000 --- a/src/ol/layer/tilelayer.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.layer.Tile diff --git a/src/ol/layer/tilelayer.js b/src/ol/layer/tilelayer.js index 0d4cfa3ce2..2b650eedd9 100644 --- a/src/ol/layer/tilelayer.js +++ b/src/ol/layer/tilelayer.js @@ -20,6 +20,7 @@ ol.layer.TileProperty = { * @param {olx.layer.TileOptions} options Tile layer options. * @todo stability experimental * @todo observable preload {number} the level to preload tiles up to + * @todo api */ ol.layer.Tile = function(options) { goog.base(this, options); diff --git a/src/ol/layer/vectorlayer.exports b/src/ol/layer/vectorlayer.exports deleted file mode 100644 index be493b810d..0000000000 --- a/src/ol/layer/vectorlayer.exports +++ /dev/null @@ -1,4 +0,0 @@ -@exportSymbol ol.layer.Vector -@exportProperty ol.layer.Vector.prototype.getStyle -@exportProperty ol.layer.Vector.prototype.getStyleFunction -@exportProperty ol.layer.Vector.prototype.setStyle diff --git a/src/ol/layer/vectorlayer.js b/src/ol/layer/vectorlayer.js index 5b457dff48..20365cb1a6 100644 --- a/src/ol/layer/vectorlayer.js +++ b/src/ol/layer/vectorlayer.js @@ -22,6 +22,7 @@ ol.layer.VectorProperty = { * @fires {@link ol.render.Event} ol.render.Event * @param {olx.layer.VectorOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.layer.Vector = function(opt_options) { @@ -70,6 +71,7 @@ ol.layer.Vector.prototype.getRenderOrder = function() { * option at construction or to the `setStyle` method. * @return {ol.style.Style|Array.|ol.feature.StyleFunction} * Layer style. + * @todo api */ ol.layer.Vector.prototype.getStyle = function() { return this.style_; @@ -80,6 +82,7 @@ ol.layer.Vector.prototype.getStyle = function() { * Get the style function. * @return {ol.feature.StyleFunction|undefined} Layer style function. * @todo stability experimental + * @todo api */ ol.layer.Vector.prototype.getStyleFunction = function() { return this.styleFunction_; @@ -102,6 +105,7 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) { * @param {ol.style.Style|Array.|ol.feature.StyleFunction} style * Layer style. * @todo stability experimental + * @todo api */ ol.layer.Vector.prototype.setStyle = function(style) { this.style_ = style; diff --git a/src/ol/loadingstrategy.exports b/src/ol/loadingstrategy.exports deleted file mode 100644 index 711262d776..0000000000 --- a/src/ol/loadingstrategy.exports +++ /dev/null @@ -1,3 +0,0 @@ -@exportSymbol ol.loadingstrategy.all -@exportSymbol ol.loadingstrategy.bbox -@exportSymbol ol.loadingstrategy.createTile diff --git a/src/ol/loadingstrategy.js b/src/ol/loadingstrategy.js index 58a5dd4b3b..a6af39a671 100644 --- a/src/ol/loadingstrategy.js +++ b/src/ol/loadingstrategy.js @@ -7,6 +7,7 @@ goog.require('ol.TileCoord'); * @param {ol.Extent} extent Extent. * @param {number} resolution Resolution. * @return {Array.} Extents. + * @todo api */ ol.loadingstrategy.all = function(extent, resolution) { return [[-Infinity, -Infinity, Infinity, Infinity]]; @@ -17,6 +18,7 @@ ol.loadingstrategy.all = function(extent, resolution) { * @param {ol.Extent} extent Extent. * @param {number} resolution Resolution. * @return {Array.} Extents. + * @todo api */ ol.loadingstrategy.bbox = function(extent, resolution) { return [extent]; @@ -26,6 +28,7 @@ ol.loadingstrategy.bbox = function(extent, resolution) { /** * @param {ol.tilegrid.TileGrid} tileGrid Tile grid. * @return {function(ol.Extent, number): Array.} Loading strategy. + * @todo api */ ol.loadingstrategy.createTile = function(tileGrid) { return ( diff --git a/src/ol/map.exports b/src/ol/map.exports deleted file mode 100644 index 53dcfd0a63..0000000000 --- a/src/ol/map.exports +++ /dev/null @@ -1,23 +0,0 @@ -@exportSymbol ol.Map -@exportProperty ol.Map.prototype.addControl -@exportProperty ol.Map.prototype.addInteraction -@exportProperty ol.Map.prototype.addLayer -@exportProperty ol.Map.prototype.addOverlay -@exportProperty ol.Map.prototype.beforeRender -@exportProperty ol.Map.prototype.forEachFeatureAtPixel -@exportProperty ol.Map.prototype.getControls -@exportProperty ol.Map.prototype.getCoordinateFromPixel -@exportProperty ol.Map.prototype.getEventCoordinate -@exportProperty ol.Map.prototype.getEventPixel -@exportProperty ol.Map.prototype.getInteractions -@exportProperty ol.Map.prototype.getLayers -@exportProperty ol.Map.prototype.getOverlays -@exportProperty ol.Map.prototype.getPixelFromCoordinate -@exportProperty ol.Map.prototype.getViewport -@exportProperty ol.Map.prototype.removeControl -@exportProperty ol.Map.prototype.removeInteraction -@exportProperty ol.Map.prototype.removeLayer -@exportProperty ol.Map.prototype.removeOverlay -@exportProperty ol.Map.prototype.render -@exportProperty ol.Map.prototype.renderSync -@exportProperty ol.Map.prototype.updateSize diff --git a/src/ol/map.js b/src/ol/map.js index de4181a09b..fb8cbcdf80 100644 --- a/src/ol/map.js +++ b/src/ol/map.js @@ -165,6 +165,7 @@ ol.MapProperty = { * @todo observable target {string|Element} the Element or id of the Element * that the map is rendered in. * @todo observable view {ol.IView} the view that controls this map + * @todo api */ ol.Map = function(options) { @@ -466,6 +467,7 @@ goog.inherits(ol.Map, ol.Object); * Add the given control to the map. * @param {ol.control.Control} control Control. * @todo stability experimental + * @todo api */ ol.Map.prototype.addControl = function(control) { var controls = this.getControls(); @@ -477,6 +479,7 @@ ol.Map.prototype.addControl = function(control) { /** * Add the given interaction to the map. * @param {ol.interaction.Interaction} interaction Interaction to add. + * @todo api */ ol.Map.prototype.addInteraction = function(interaction) { var interactions = this.getInteractions(); @@ -489,6 +492,7 @@ ol.Map.prototype.addInteraction = function(interaction) { * Adds the given layer to the top of this map. * @param {ol.layer.Base} layer Layer. * @todo stability experimental + * @todo api */ ol.Map.prototype.addLayer = function(layer) { var layers = this.getLayerGroup().getLayers(); @@ -501,6 +505,7 @@ ol.Map.prototype.addLayer = function(layer) { * Add the given overlay to the map. * @param {ol.Overlay} overlay Overlay. * @todo stability experimental + * @todo api */ ol.Map.prototype.addOverlay = function(overlay) { var overlays = this.getOverlays(); @@ -515,6 +520,7 @@ ol.Map.prototype.addOverlay = function(overlay) { * namespace provides several static methods for creating prerender functions. * @param {...ol.PreRenderFunction} var_args Any number of pre-render functions. * @todo stability experimental + * @todo api */ ol.Map.prototype.beforeRender = function(var_args) { this.render(); @@ -553,6 +559,7 @@ ol.Map.prototype.disposeInternal = function() { * @param {U=} opt_this2 Value to use as `this` when executing `layerFilter`. * @return {T|undefined} Callback result. * @template S,T,U + * @todo api */ ol.Map.prototype.forEachFeatureAtPixel = function(pixel, callback, opt_this, opt_layerFilter, opt_this2) { @@ -575,6 +582,7 @@ ol.Map.prototype.forEachFeatureAtPixel = * @param {Event} event Event. * @return {ol.Coordinate} Coordinate. * @todo stability experimental + * @todo api */ ol.Map.prototype.getEventCoordinate = function(event) { return this.getCoordinateFromPixel(this.getEventPixel(event)); @@ -586,6 +594,7 @@ ol.Map.prototype.getEventCoordinate = function(event) { * @param {Event} event Event. * @return {ol.Pixel} Pixel. * @todo stability experimental + * @todo api */ ol.Map.prototype.getEventPixel = function(event) { // goog.style.getRelativePosition is based on event.targetTouches, @@ -627,6 +636,7 @@ goog.exportProperty( /** * @param {ol.Pixel} pixel Pixel. * @return {ol.Coordinate} Coordinate. + * @todo api */ ol.Map.prototype.getCoordinateFromPixel = function(pixel) { var frameState = this.frameState_; @@ -642,6 +652,7 @@ ol.Map.prototype.getCoordinateFromPixel = function(pixel) { /** * @return {ol.Collection} Controls. * @todo stability experimental + * @todo api */ ol.Map.prototype.getControls = function() { return this.controls_; @@ -651,6 +662,7 @@ ol.Map.prototype.getControls = function() { /** * @return {ol.Collection} Overlays. * @todo stability experimental + * @todo api */ ol.Map.prototype.getOverlays = function() { return this.overlays_; @@ -666,6 +678,7 @@ ol.Map.prototype.getOverlays = function() { * Interactions are used for e.g. pan, zoom and rotate. * @return {ol.Collection} Interactions. * @todo stability experimental + * @todo api */ ol.Map.prototype.getInteractions = function() { return this.interactions_; @@ -691,6 +704,7 @@ goog.exportProperty( * Get the collection of layers associated with this map. * @return {ol.Collection|undefined} Layers. * @todo stability experimental + * @todo api */ ol.Map.prototype.getLayers = function() { var layerGroup = this.getLayerGroup(); @@ -705,6 +719,7 @@ ol.Map.prototype.getLayers = function() { /** * @param {ol.Coordinate} coordinate Coordinate. * @return {ol.Pixel} Pixel. + * @todo api */ ol.Map.prototype.getPixelFromCoordinate = function(coordinate) { var frameState = this.frameState_; @@ -749,6 +764,7 @@ goog.exportProperty( /** * @return {Element} Viewport. * @todo stability experimental + * @todo api */ ol.Map.prototype.getViewport = function() { return this.viewport_; @@ -1058,6 +1074,7 @@ ol.Map.prototype.isRendered = function() { /** * Render. + * @todo api */ ol.Map.prototype.renderSync = function() { this.animationDelay_.fire(); @@ -1066,6 +1083,7 @@ ol.Map.prototype.renderSync = function() { /** * Request that renderFrame_ be called some time in the future. + * @todo api */ ol.Map.prototype.render = function() { if (!this.animationDelay_.isActive()) { @@ -1080,6 +1098,7 @@ ol.Map.prototype.render = function() { * @return {ol.control.Control|undefined} The removed control of undefined * if the control was not found. * @todo stability experimental + * @todo api */ ol.Map.prototype.removeControl = function(control) { var controls = this.getControls(); @@ -1096,6 +1115,7 @@ ol.Map.prototype.removeControl = function(control) { * @param {ol.interaction.Interaction} interaction Interaction to remove. * @return {ol.interaction.Interaction|undefined} The removed interaction (or * undefined if the interaction was not found). + * @todo api */ ol.Map.prototype.removeInteraction = function(interaction) { var removed; @@ -1114,6 +1134,7 @@ ol.Map.prototype.removeInteraction = function(interaction) { * @return {ol.layer.Base|undefined} The removed layer or undefined if the * layer was not found. * @todo stability experimental + * @todo api */ ol.Map.prototype.removeLayer = function(layer) { var layers = this.getLayerGroup().getLayers(); @@ -1128,6 +1149,7 @@ ol.Map.prototype.removeLayer = function(layer) { * @return {ol.Overlay|undefined} The removed overlay of undefined * if the overlay was not found. * @todo stability experimental + * @todo api */ ol.Map.prototype.removeOverlay = function(overlay) { var overlays = this.getOverlays(); @@ -1316,6 +1338,7 @@ ol.Map.prototype.skipFeature = function(feature) { * Force a recalculation of the map viewport size. This should be called when * third-party code changes the size of the map viewport. * @todo stability experimental + * @todo api */ ol.Map.prototype.updateSize = function() { var target = this.getTarget(); diff --git a/src/ol/mapbrowserevent.exports b/src/ol/mapbrowserevent.exports deleted file mode 100644 index 0ad1d2a276..0000000000 --- a/src/ol/mapbrowserevent.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportProperty ol.MapBrowserEvent.prototype.preventDefault -@exportProperty ol.MapBrowserEvent.prototype.stopPropagation diff --git a/src/ol/mapbrowserevent.js b/src/ol/mapbrowserevent.js index 31b7b4f6d3..508b0f1667 100644 --- a/src/ol/mapbrowserevent.js +++ b/src/ol/mapbrowserevent.js @@ -66,6 +66,7 @@ goog.inherits(ol.MapBrowserEvent, ol.MapEvent); * @see https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault * @override * @todo stability experimental + * @todo api */ ol.MapBrowserEvent.prototype.preventDefault = function() { goog.base(this, 'preventDefault'); @@ -78,6 +79,7 @@ ol.MapBrowserEvent.prototype.preventDefault = function() { * @see https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation * @override * @todo stability experimental + * @todo api */ ol.MapBrowserEvent.prototype.stopPropagation = function() { goog.base(this, 'stopPropagation'); diff --git a/src/ol/object.exports b/src/ol/object.exports deleted file mode 100644 index 9a647cc6db..0000000000 --- a/src/ol/object.exports +++ /dev/null @@ -1,10 +0,0 @@ -@exportSymbol ol.Object -@exportProperty ol.Object.prototype.bindTo -@exportProperty ol.Object.prototype.get -@exportProperty ol.Object.prototype.getKeys -@exportProperty ol.Object.prototype.getProperties -@exportProperty ol.Object.prototype.notify -@exportProperty ol.Object.prototype.set -@exportProperty ol.Object.prototype.setValues -@exportProperty ol.Object.prototype.unbind -@exportProperty ol.Object.prototype.unbindAll diff --git a/src/ol/object.js b/src/ol/object.js index 1c27959761..10bc6981fa 100644 --- a/src/ol/object.js +++ b/src/ol/object.js @@ -111,6 +111,7 @@ ol.ObjectAccessor.prototype.transform = function(from, to) { * @param {Object.=} opt_values Values. * @fires {@link ol.ObjectEvent} ol.ObjectEvent * @todo stability experimental + * @todo api */ ol.Object = function(opt_values) { goog.base(this); @@ -244,6 +245,7 @@ ol.Object.getSetterName = function(key) { * @param {string=} opt_targetKey Target key. * @return {ol.ObjectAccessor} * @todo stability experimental + * @todo api */ ol.Object.prototype.bindTo = function(key, target, opt_targetKey) { var targetKey = opt_targetKey || key; @@ -301,6 +303,7 @@ ol.Object.prototype.createBeforeChangeListener_ = function(key, targetKey) { * @param {string} key Key name. * @return {*} Value. * @todo stability experimental + * @todo api */ ol.Object.prototype.get = function(key) { var value; @@ -328,6 +331,7 @@ ol.Object.prototype.get = function(key) { /** * Get a list of object property names. * @return {Array.} List of property names. + * @todo api */ ol.Object.prototype.getKeys = function() { var accessors = this.accessors_; @@ -360,6 +364,7 @@ ol.Object.prototype.getKeys = function() { * Get an object of all property names and values. * @return {Object.} Object. * @todo stability experimental + * @todo api */ ol.Object.prototype.getProperties = function() { var properties = {}; @@ -380,6 +385,7 @@ ol.Object.prototype.getProperties = function() { * that it is bound to. * @param {string} key Key name. * @todo stability experimental + * @todo api */ ol.Object.prototype.notify = function(key) { var accessors = this.accessors_; @@ -411,6 +417,7 @@ ol.Object.prototype.notifyInternal_ = function(key) { * @param {string} key Key name. * @param {*} value Value. * @todo stability experimental + * @todo api */ ol.Object.prototype.set = function(key, value) { this.dispatchEvent( @@ -440,6 +447,7 @@ ol.Object.prototype.set = function(key, value) { * Sets a collection of key-value pairs. * @param {Object.} values Values. * @todo stability experimental + * @todo api */ ol.Object.prototype.setValues = function(values) { var key; @@ -454,6 +462,7 @@ ol.Object.prototype.setValues = function(values) { * value. The object will not be notified, as the value has not changed. * @param {string} key Key name. * @todo stability experimental + * @todo api */ ol.Object.prototype.unbind = function(key) { var listeners = this.listeners_; @@ -478,6 +487,7 @@ ol.Object.prototype.unbind = function(key) { /** * Removes all bindings. * @todo stability experimental + * @todo api */ ol.Object.prototype.unbindAll = function() { for (var key in this.listeners_) { diff --git a/src/ol/observable.exports b/src/ol/observable.exports deleted file mode 100644 index cd9d88898b..0000000000 --- a/src/ol/observable.exports +++ /dev/null @@ -1,6 +0,0 @@ -@exportSymbol ol.Observable -@exportProperty ol.Observable.prototype.dispatchChangeEvent -@exportProperty ol.Observable.prototype.on -@exportProperty ol.Observable.prototype.once -@exportProperty ol.Observable.prototype.un -@exportProperty ol.Observable.prototype.unByKey diff --git a/src/ol/observable.js b/src/ol/observable.js index 6d1f23d44a..4028996a2c 100644 --- a/src/ol/observable.js +++ b/src/ol/observable.js @@ -15,6 +15,7 @@ goog.require('goog.events.EventType'); * @suppress {checkStructDictInheritance} * @struct * @todo stability experimental + * @todo api */ ol.Observable = function() { @@ -35,6 +36,7 @@ goog.inherits(ol.Observable, goog.events.EventTarget); * notified of changes. * @fires change * @todo stability experimental + * @todo api */ ol.Observable.prototype.dispatchChangeEvent = function() { ++this.revision_; @@ -58,6 +60,7 @@ ol.Observable.prototype.getRevision = function() { * @param {Object=} opt_this The object to use as `this` in `listener`. * @return {goog.events.Key} Unique key for the listener. * @todo stability experimental + * @todo api */ ol.Observable.prototype.on = function(type, listener, opt_this) { return goog.events.listen(this, type, listener, false, opt_this); @@ -71,6 +74,7 @@ ol.Observable.prototype.on = function(type, listener, opt_this) { * @param {Object=} opt_this The object to use as `this` in `listener`. * @return {goog.events.Key} Unique key for the listener. * @todo stability experimental + * @todo api */ ol.Observable.prototype.once = function(type, listener, opt_this) { return goog.events.listenOnce(this, type, listener, false, opt_this); @@ -83,6 +87,7 @@ ol.Observable.prototype.once = function(type, listener, opt_this) { * @param {function(?): ?} listener The listener function. * @param {Object=} opt_this The object to use as `this` in `listener`. * @todo stability experimental + * @todo api */ ol.Observable.prototype.un = function(type, listener, opt_this) { goog.events.unlisten(this, type, listener, false, opt_this); @@ -93,6 +98,7 @@ ol.Observable.prototype.un = function(type, listener, opt_this) { * Removes an event listener using the key returned by `on()` or `once()`. * @param {goog.events.Key} key Key. * @todo stability experimental + * @todo api */ ol.Observable.prototype.unByKey = function(key) { goog.events.unlistenByKey(key); diff --git a/src/ol/ol.exports b/src/ol/ol.exports deleted file mode 100644 index e6371ba44b..0000000000 --- a/src/ol/ol.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.inherits diff --git a/src/ol/ol.js b/src/ol/ol.js index 6a7e7312e6..98bc7d09b7 100644 --- a/src/ol/ol.js +++ b/src/ol/ol.js @@ -10,6 +10,7 @@ goog.provide('ol'); * * "Missing newline between constructor and goog.inherits" * @todo stability experimental + * @todo api */ ol.inherits = goog.inherits; diff --git a/src/ol/overlay.exports b/src/ol/overlay.exports deleted file mode 100644 index c2ce24085b..0000000000 --- a/src/ol/overlay.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.Overlay diff --git a/src/ol/overlay.js b/src/ol/overlay.js index 0254ad7c14..5f96a822fe 100644 --- a/src/ol/overlay.js +++ b/src/ol/overlay.js @@ -63,6 +63,7 @@ ol.OverlayPositioning = { * is anchored at * @todo observable positioning {ol.OverlayPositioning} how the overlay is * positioned relative to its point on the map + * @todo api */ ol.Overlay = function(options) { diff --git a/src/ol/proj/common.js b/src/ol/proj/common.js index 00965a28e6..d249485cce 100644 --- a/src/ol/proj/common.js +++ b/src/ol/proj/common.js @@ -7,6 +7,7 @@ goog.require('ol.proj.EPSG4326'); /** * FIXME empty description for jsdoc + * @todo api */ ol.proj.common.add = function() { // Add transformations that don't alter coordinates to convert within set of diff --git a/src/ol/proj/proj.exports b/src/ol/proj/proj.exports deleted file mode 100644 index e78ec36f9a..0000000000 --- a/src/ol/proj/proj.exports +++ /dev/null @@ -1,16 +0,0 @@ -@exportSymbol ol.proj.Projection -@exportProperty ol.proj.Projection.prototype.getCode -@exportProperty ol.proj.Projection.prototype.getExtent -@exportProperty ol.proj.Projection.prototype.getUnits - -@exportSymbol ol.proj.addProjection -@exportSymbol ol.proj.get -@exportSymbol ol.proj.getTransform -@exportSymbol ol.proj.getTransformFromProjections -@exportSymbol ol.proj.transform -@exportSymbol ol.proj.transformWithProjections -@exportSymbol ol.proj.configureProj4jsProjection - -@exportSymbol ol.proj.common.add - -@exportSymbol ol.proj.METERS_PER_UNIT diff --git a/src/ol/proj/proj.js b/src/ol/proj/proj.js index bf3ddc3882..126dddf799 100644 --- a/src/ol/proj/proj.js +++ b/src/ol/proj/proj.js @@ -51,6 +51,7 @@ ol.proj.Units = { * Meters per unit lookup table. * @const * @type {Object.} + * @todo api */ ol.proj.METERS_PER_UNIT[ol.proj.Units.DEGREES] = 2 * Math.PI * ol.sphere.NORMAL.radius / 360; @@ -64,6 +65,7 @@ ol.proj.METERS_PER_UNIT[ol.proj.Units.METERS] = 1; * @param {olx.ProjectionOptions} options Projection options. * @struct * @todo stability experimental + * @todo api */ ol.proj.Projection = function(options) { @@ -110,6 +112,7 @@ ol.proj.Projection = function(options) { /** * Get the code for this projection, e.g. 'EPSG:4326'. * @return {string} Code. + * @todo api */ ol.proj.Projection.prototype.getCode = function() { return this.code_; @@ -119,6 +122,7 @@ ol.proj.Projection.prototype.getCode = function() { /** * Get the validity extent for this projection. * @return {ol.Extent} Extent. + * @todo api */ ol.proj.Projection.prototype.getExtent = function() { return this.extent_; @@ -141,6 +145,7 @@ ol.proj.Projection.prototype.getPointResolution = goog.abstractMethod; /** * Get the units of this projection. * @return {ol.proj.Units} Units. + * @todo api */ ol.proj.Projection.prototype.getUnits = function() { return this.units_; @@ -372,6 +377,7 @@ ol.proj.addProj4jsProjection_ = function(proj4jsProjection) { /** * @param {ol.proj.Projection} projection Projection. * @todo stability experimental + * @todo api */ ol.proj.addProjection = function(projection) { var projections = ol.proj.projections_; @@ -470,6 +476,7 @@ ol.proj.removeTransform = function(source, destination) { * existing projection object, or undefined. * @return {ol.proj.Projection} Projection. * @todo stability experimental + * @todo api */ ol.proj.get = function(projectionLike) { var projection; @@ -552,6 +559,7 @@ ol.proj.equivalent = function(projection1, projection2) { * @param {ol.proj.ProjectionLike} destination Destination. * @return {ol.TransformFunction} Transform. * @todo stability experimental + * @todo api */ ol.proj.getTransform = function(source, destination) { var sourceProjection = ol.proj.get(source); @@ -569,6 +577,7 @@ ol.proj.getTransform = function(source, destination) { * @param {ol.proj.Projection} destinationProjection Destination projection. * @return {ol.TransformFunction} Transform. * @todo stability experimental + * @todo api */ ol.proj.getTransformFromProjections = function(sourceProjection, destinationProjection) { @@ -689,6 +698,7 @@ ol.proj.cloneTransform = function(input, opt_output, opt_dimension) { * @param {ol.proj.ProjectionLike} destination Destination. * @return {ol.Coordinate} Point. * @todo stability experimental + * @todo api */ ol.proj.transform = function(point, source, destination) { var transformFn = ol.proj.getTransform(source, destination); @@ -704,6 +714,7 @@ ol.proj.transform = function(point, source, destination) { * @param {ol.proj.Projection} destinationProjection Destination projection. * @return {ol.Coordinate} Point. * @todo stability experimental + * @todo api */ ol.proj.transformWithProjections = function(point, sourceProjection, destinationProjection) { @@ -717,6 +728,7 @@ ol.proj.transformWithProjections = * @param {olx.Proj4jsProjectionOptions} options Proj4js projection options. * @return {ol.proj.Projection} Proj4js projection. * @todo stability experimental + * @todo api */ ol.proj.configureProj4jsProjection = function(options) { goog.asserts.assert(!goog.object.containsKey( diff --git a/src/ol/render/canvas/canvasimmediate.exports b/src/ol/render/canvas/canvasimmediate.exports deleted file mode 100644 index 8654add64a..0000000000 --- a/src/ol/render/canvas/canvasimmediate.exports +++ /dev/null @@ -1,12 +0,0 @@ -@exportProperty ol.render.canvas.Immediate.prototype.drawAsync -@exportProperty ol.render.canvas.Immediate.prototype.drawCircleGeometry -@exportProperty ol.render.canvas.Immediate.prototype.drawFeature -@exportProperty ol.render.canvas.Immediate.prototype.drawLineStringGeometry -@exportProperty ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry -@exportProperty ol.render.canvas.Immediate.prototype.drawMultiPointGeometry -@exportProperty ol.render.canvas.Immediate.prototype.drawMultiPointGeometry -@exportProperty ol.render.canvas.Immediate.prototype.drawPointGeometry -@exportProperty ol.render.canvas.Immediate.prototype.drawPolygonGeometry -@exportProperty ol.render.canvas.Immediate.prototype.setFillStrokeStyle -@exportProperty ol.render.canvas.Immediate.prototype.setImageStyle -@exportProperty ol.render.canvas.Immediate.prototype.setTextStyle diff --git a/src/ol/render/canvas/canvasimmediate.js b/src/ol/render/canvas/canvasimmediate.js index ae805843ae..dd9216b112 100644 --- a/src/ol/render/canvas/canvasimmediate.js +++ b/src/ol/render/canvas/canvasimmediate.js @@ -380,6 +380,7 @@ ol.render.canvas.Immediate.prototype.drawRings_ = * * @param {number} zIndex Z index. * @param {function(ol.render.canvas.Immediate)} callback Callback. + * @todo api */ ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) { var zIndexKey = zIndex.toString(); @@ -399,6 +400,7 @@ ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) { * @param {ol.geom.Circle} circleGeometry Circle geometry. * @param {Object} data Opaque data object, * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawCircleGeometry = function(circleGeometry, data) { @@ -444,6 +446,7 @@ ol.render.canvas.Immediate.prototype.drawCircleGeometry = * @param {ol.Feature} feature Feature. * @param {ol.style.Style} style Style. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) { var geometry = feature.getGeometry(); @@ -497,6 +500,7 @@ ol.render.canvas.Immediate.prototype.drawGeometryCollectionGeometry = * @param {ol.geom.Point} pointGeometry Point geometry. * @param {Object} data Opaque data object. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawPointGeometry = function(pointGeometry, data) { @@ -518,6 +522,7 @@ ol.render.canvas.Immediate.prototype.drawPointGeometry = * @param {ol.geom.MultiPoint} multiPointGeometry MultiPoint geometry. * @param {Object} data Opaque data object. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawMultiPointGeometry = function(multiPointGeometry, data) { @@ -539,6 +544,7 @@ ol.render.canvas.Immediate.prototype.drawMultiPointGeometry = * @param {ol.geom.LineString} lineStringGeometry Line string geometry. * @param {Object} data Opaque data object. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawLineStringGeometry = function(lineStringGeometry, data) { @@ -569,6 +575,7 @@ ol.render.canvas.Immediate.prototype.drawLineStringGeometry = * MultiLineString geometry. * @param {Object} data Opaque data object. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry = function(multiLineStringGeometry, data) { @@ -605,6 +612,7 @@ ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry = * @param {ol.geom.Polygon} polygonGeometry Polygon geometry. * @param {Object} data Opaque data object. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawPolygonGeometry = function(polygonGeometry, data) { @@ -644,6 +652,7 @@ ol.render.canvas.Immediate.prototype.drawPolygonGeometry = * @param {ol.geom.MultiPolygon} multiPolygonGeometry MultiPolygon geometry. * @param {Object} data Opaque data object. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.drawMultiPolygonGeometry = function(multiPolygonGeometry, data) { @@ -819,6 +828,7 @@ ol.render.canvas.Immediate.prototype.setContextTextState_ = * @param {ol.style.Fill} fillStyle Fill style. * @param {ol.style.Stroke} strokeStyle Stroke style. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.setFillStrokeStyle = function(fillStyle, strokeStyle) { @@ -864,6 +874,7 @@ ol.render.canvas.Immediate.prototype.setFillStrokeStyle = * * @param {ol.style.Image} imageStyle Image style. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) { if (goog.isNull(imageStyle)) { @@ -903,6 +914,7 @@ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) { * * @param {ol.style.Text} textStyle Text style. * @todo stability experimental + * @todo api */ ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) { if (goog.isNull(textStyle)) { diff --git a/src/ol/source/bingmapssource.exports b/src/ol/source/bingmapssource.exports deleted file mode 100644 index 5f7481f7c9..0000000000 --- a/src/ol/source/bingmapssource.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.source.BingMaps -@exportProperty ol.source.BingMaps.TOS_ATTRIBUTION diff --git a/src/ol/source/bingmapssource.js b/src/ol/source/bingmapssource.js index fa93ddb4d5..11f986fb29 100644 --- a/src/ol/source/bingmapssource.js +++ b/src/ol/source/bingmapssource.js @@ -20,6 +20,7 @@ goog.require('ol.tilegrid.XYZ'); * @extends {ol.source.TileImage} * @param {olx.source.BingMapsOptions} options Bing Maps options. * @todo stability experimental + * @todo api */ ol.source.BingMaps = function(options) { @@ -55,6 +56,7 @@ goog.inherits(ol.source.BingMaps, ol.source.TileImage); /** * @const * @type {ol.Attribution} + * @todo api */ ol.source.BingMaps.TOS_ATTRIBUTION = new ol.Attribution({ html: '} Features. + * @todo api + */ +ol.source.ServerVector.prototype.readFeatures; diff --git a/src/ol/source/source.exports b/src/ol/source/source.exports deleted file mode 100644 index 1d3863d0f3..0000000000 --- a/src/ol/source/source.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportProperty ol.source.Source.prototype.getExtent -@exportProperty ol.source.Source.prototype.getState diff --git a/src/ol/source/source.js b/src/ol/source/source.js index c9039bbbf7..5283833aec 100644 --- a/src/ol/source/source.js +++ b/src/ol/source/source.js @@ -131,6 +131,7 @@ ol.source.Source.prototype.getResolutions = goog.abstractMethod; /** * @return {ol.source.State} State. + * @todo api */ ol.source.Source.prototype.getState = function() { return this.state_; diff --git a/src/ol/source/stamensource.exports b/src/ol/source/stamensource.exports deleted file mode 100644 index 697330485e..0000000000 --- a/src/ol/source/stamensource.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.source.Stamen diff --git a/src/ol/source/stamensource.js b/src/ol/source/stamensource.js index 7ed9e2ed05..55904b04b3 100644 --- a/src/ol/source/stamensource.js +++ b/src/ol/source/stamensource.js @@ -82,6 +82,7 @@ ol.source.StamenProviderConfig = { * @extends {ol.source.XYZ} * @param {olx.source.StamenOptions} options Stamen options. * @todo stability experimental + * @todo api */ ol.source.Stamen = function(options) { diff --git a/src/ol/source/staticvectorsource.exports b/src/ol/source/staticvectorsource.exports deleted file mode 100644 index 1c283475e6..0000000000 --- a/src/ol/source/staticvectorsource.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.source.StaticVector diff --git a/src/ol/source/staticvectorsource.js b/src/ol/source/staticvectorsource.js index 6ebc8ad278..05bb37d1ac 100644 --- a/src/ol/source/staticvectorsource.js +++ b/src/ol/source/staticvectorsource.js @@ -11,6 +11,7 @@ goog.require('ol.source.State'); * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent * @param {olx.source.StaticVectorOptions} options Options. * @todo stability experimental + * @todo api */ ol.source.StaticVector = function(options) { diff --git a/src/ol/source/tileimagesource.exports b/src/ol/source/tileimagesource.exports deleted file mode 100644 index e3dffc2601..0000000000 --- a/src/ol/source/tileimagesource.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.source.TileImage diff --git a/src/ol/source/tileimagesource.js b/src/ol/source/tileimagesource.js index 5ab8a69d5e..237d99cb82 100644 --- a/src/ol/source/tileimagesource.js +++ b/src/ol/source/tileimagesource.js @@ -18,6 +18,7 @@ goog.require('ol.source.Tile'); * @extends {ol.source.Tile} * @param {olx.source.TileImageOptions} options Image tile options. * @todo stability experimental + * @todo api */ ol.source.TileImage = function(options) { diff --git a/src/ol/source/tilejsonsource.exports b/src/ol/source/tilejsonsource.exports deleted file mode 100644 index 56b3f56285..0000000000 --- a/src/ol/source/tilejsonsource.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.source.TileJSON diff --git a/src/ol/source/tilejsonsource.js b/src/ol/source/tilejsonsource.js index 0cc9692395..deb26bc886 100644 --- a/src/ol/source/tilejsonsource.js +++ b/src/ol/source/tilejsonsource.js @@ -26,6 +26,7 @@ goog.require('ol.tilegrid.XYZ'); * @extends {ol.source.TileImage} * @param {olx.source.TileJSONOptions} options TileJSON options. * @todo stability experimental + * @todo api */ ol.source.TileJSON = function(options) { diff --git a/src/ol/source/tilesource.exports b/src/ol/source/tilesource.exports deleted file mode 100644 index fe7587ebea..0000000000 --- a/src/ol/source/tilesource.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.source.Tile -@exportProperty ol.source.Tile.prototype.getTileGrid diff --git a/src/ol/source/tilesource.js b/src/ol/source/tilesource.js index 732ab63d2f..b4e631831f 100644 --- a/src/ol/source/tilesource.js +++ b/src/ol/source/tilesource.js @@ -29,6 +29,7 @@ ol.source.TileOptions; * @extends {ol.source.Source} * @param {ol.source.TileOptions} options Tile source options. * @todo stability experimental + * @todo api */ ol.source.Tile = function(options) { @@ -153,6 +154,7 @@ ol.source.Tile.prototype.getTile = goog.abstractMethod; /** * @return {ol.tilegrid.TileGrid} Tile grid. + * @todo api */ ol.source.Tile.prototype.getTileGrid = function() { return this.tileGrid; diff --git a/src/ol/source/tilevectorsource.exports b/src/ol/source/tilevectorsource.exports deleted file mode 100644 index aca6bdb3e8..0000000000 --- a/src/ol/source/tilevectorsource.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.source.TileVector diff --git a/src/ol/source/tilevectorsource.js b/src/ol/source/tilevectorsource.js index cf64f35430..54461b773a 100644 --- a/src/ol/source/tilevectorsource.js +++ b/src/ol/source/tilevectorsource.js @@ -14,6 +14,7 @@ goog.require('ol.tilegrid.TileGrid'); * @constructor * @extends {ol.source.FormatVector} * @param {olx.source.TileVectorOptions} options Options. + * @todo api */ ol.source.TileVector = function(options) { diff --git a/src/ol/source/tilewmssource.exports b/src/ol/source/tilewmssource.exports deleted file mode 100644 index 93192f9d12..0000000000 --- a/src/ol/source/tilewmssource.exports +++ /dev/null @@ -1,5 +0,0 @@ -@exportSymbol ol.source.TileWMS -@exportProperty ol.source.TileWMS.prototype.getGetFeatureInfoUrl -@exportProperty ol.source.TileWMS.prototype.getParams -@exportProperty ol.source.TileWMS.prototype.getUrls -@exportProperty ol.source.TileWMS.prototype.updateParams diff --git a/src/ol/source/tilewmssource.js b/src/ol/source/tilewmssource.js index 2958b531d8..ad728d0fb9 100644 --- a/src/ol/source/tilewmssource.js +++ b/src/ol/source/tilewmssource.js @@ -24,6 +24,7 @@ goog.require('ol.source.wms.ServerType'); * @extends {ol.source.TileImage} * @param {olx.source.TileWMSOptions=} opt_options Tile WMS options. * @todo stability experimental + * @todo api */ ol.source.TileWMS = function(opt_options) { @@ -124,6 +125,7 @@ goog.inherits(ol.source.TileWMS, ol.source.TileImage); * in the `LAYERS` parameter will be used. `VERSION` should not be * specified here. * @return {string|undefined} GetFeatureInfo URL. + * @todo api */ ol.source.TileWMS.prototype.getGetFeatureInfoUrl = function(coordinate, resolution, projection, params) { @@ -206,6 +208,7 @@ ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) { * the "params" option, and possibly updated using the updateParams method. * @return {Object} Params. * @todo stability experimental + * @todo api */ ol.source.TileWMS.prototype.getParams = function() { return this.params_; @@ -306,6 +309,7 @@ ol.source.TileWMS.prototype.getTilePixelSize = * Return the URLs used for this WMS source. * @return {Array.|undefined} URLs. * @todo stability experimental + * @todo api */ ol.source.TileWMS.prototype.getUrls = function() { return this.urls_; @@ -390,6 +394,7 @@ ol.source.TileWMS.prototype.tileUrlFunction_ = * Update the user-provided params. * @param {Object} params Params. * @todo stability experimental + * @todo api */ ol.source.TileWMS.prototype.updateParams = function(params) { goog.object.extend(this.params_, params); diff --git a/src/ol/source/topojsonsource.exports b/src/ol/source/topojsonsource.exports deleted file mode 100644 index d56afa819e..0000000000 --- a/src/ol/source/topojsonsource.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.source.TopoJSON diff --git a/src/ol/source/topojsonsource.js b/src/ol/source/topojsonsource.js index cd65cf76ba..ac3c0dbb5f 100644 --- a/src/ol/source/topojsonsource.js +++ b/src/ol/source/topojsonsource.js @@ -11,6 +11,7 @@ goog.require('ol.source.StaticVector'); * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent * @param {olx.source.TopoJSONOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.source.TopoJSON = function(opt_options) { diff --git a/src/ol/source/vectorsource.exports b/src/ol/source/vectorsource.exports deleted file mode 100644 index 467542675a..0000000000 --- a/src/ol/source/vectorsource.exports +++ /dev/null @@ -1,10 +0,0 @@ -@exportSymbol ol.source.Vector -@exportProperty ol.source.Vector.prototype.addFeature -@exportProperty ol.source.Vector.prototype.addFeatures -@exportProperty ol.source.Vector.prototype.forEachFeature -@exportProperty ol.source.Vector.prototype.forEachFeatureInExtent -@exportProperty ol.source.Vector.prototype.getFeatures -@exportProperty ol.source.Vector.prototype.getFeaturesAtCoordinate -@exportProperty ol.source.Vector.prototype.getClosestFeatureToCoordinate -@exportProperty ol.source.Vector.prototype.getExtent -@exportProperty ol.source.Vector.prototype.removeFeature diff --git a/src/ol/source/vectorsource.js b/src/ol/source/vectorsource.js index 94ab64349a..fcb0c137c6 100644 --- a/src/ol/source/vectorsource.js +++ b/src/ol/source/vectorsource.js @@ -44,6 +44,7 @@ ol.source.VectorEventType = { * @fires {@link ol.source.VectorEvent} ol.source.VectorEvent * @param {olx.source.VectorOptions=} opt_options Vector source options. * @todo stability experimental + * @todo api */ ol.source.Vector = function(opt_options) { @@ -86,6 +87,7 @@ goog.inherits(ol.source.Vector, ol.source.Source); /** * @param {ol.Feature} feature Feature. * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.addFeature = function(feature) { this.addFeatureInternal(feature); @@ -124,6 +126,7 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) { /** * @param {Array.} features Features. * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.addFeatures = function(features) { this.addFeaturesInternal(features); @@ -165,6 +168,7 @@ ol.source.Vector.prototype.clear = function() { * @return {S|undefined} * @template T,S * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.forEachFeature = function(f, opt_this) { return this.rBush_.forEach(f, opt_this); @@ -201,6 +205,7 @@ ol.source.Vector.prototype.forEachFeatureAtCoordinate = * @return {S|undefined} * @template T,S * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.forEachFeatureInExtent = function(extent, f, opt_this) { @@ -226,6 +231,7 @@ ol.source.Vector.prototype.forEachFeatureInExtentAtResolution = /** * @return {Array.} Features. * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.getFeatures = function() { var features = this.rBush_.getAll(); @@ -241,6 +247,7 @@ ol.source.Vector.prototype.getFeatures = function() { * @param {ol.Coordinate} coordinate Coordinate. * @return {Array.} Features. * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.getFeaturesAtCoordinate = function(coordinate) { var features = []; @@ -265,6 +272,7 @@ ol.source.Vector.prototype.getFeaturesInExtent = function(extent) { * @param {ol.Coordinate} coordinate Coordinate. * @return {ol.Feature} Closest feature. * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.getClosestFeatureToCoordinate = function(coordinate) { @@ -311,6 +319,7 @@ ol.source.Vector.prototype.getClosestFeatureToCoordinate = /** * @return {ol.Extent} Extent. * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.getExtent = function() { return this.rBush_.getExtent(); @@ -364,6 +373,7 @@ ol.source.Vector.prototype.loadFeatures = goog.nullFunction; /** * @param {ol.Feature} feature Feature. * @todo stability experimental + * @todo api */ ol.source.Vector.prototype.removeFeature = function(feature) { var featureKey = goog.getUid(feature).toString(); diff --git a/src/ol/source/wmtssource.exports b/src/ol/source/wmtssource.exports deleted file mode 100644 index a81ed65df0..0000000000 --- a/src/ol/source/wmtssource.exports +++ /dev/null @@ -1,4 +0,0 @@ -@exportSymbol ol.source.WMTS -@exportProperty ol.source.WMTS.prototype.getDimensions -@exportProperty ol.source.WMTS.prototype.updateDimensions -@exportSymbol ol.source.WMTS.optionsFromCapabilities diff --git a/src/ol/source/wmtssource.js b/src/ol/source/wmtssource.js index c87014482d..c385706d8e 100644 --- a/src/ol/source/wmtssource.js +++ b/src/ol/source/wmtssource.js @@ -30,6 +30,7 @@ ol.source.WMTSRequestEncoding = { * @extends {ol.source.TileImage} * @param {olx.source.WMTSOptions} options WMTS options. * @todo stability experimental + * @todo api */ ol.source.WMTS = function(options) { @@ -196,6 +197,7 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage); * method. * @return {Object} Dimensions. * @todo stability experimental + * @todo api */ ol.source.WMTS.prototype.getDimensions = function() { return this.dimensions_; @@ -227,6 +229,7 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() { * Update the dimensions. * @param {Object} dimensions Dimensions. * @todo stability experimental + * @todo api */ ol.source.WMTS.prototype.updateDimensions = function(dimensions) { goog.object.extend(this.dimensions_, dimensions); @@ -240,6 +243,7 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) { * @param {string} layer The layer identifier. * @return {olx.source.WMTSOptions} WMTS source options object. * @todo stability experimental + * @todo api */ ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) { diff --git a/src/ol/source/xyzsource.exports b/src/ol/source/xyzsource.exports deleted file mode 100644 index 3968a05264..0000000000 --- a/src/ol/source/xyzsource.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.source.XYZ -@exportProperty ol.source.XYZ.prototype.setUrl diff --git a/src/ol/source/xyzsource.js b/src/ol/source/xyzsource.js index 69bfd6f49f..9c6c3a6d0f 100644 --- a/src/ol/source/xyzsource.js +++ b/src/ol/source/xyzsource.js @@ -13,6 +13,7 @@ goog.require('ol.tilegrid.XYZ'); * @extends {ol.source.TileImage} * @param {olx.source.XYZOptions} options XYZ options. * @todo stability experimental + * @todo api */ ol.source.XYZ = function(options) { @@ -70,6 +71,7 @@ ol.source.XYZ.prototype.setTileUrlFunction = function(tileUrlFunction) { /** * @param {string} url URL. * @todo stability experimental + * @todo api */ ol.source.XYZ.prototype.setUrl = function(url) { this.setTileUrlFunction(ol.TileUrlFunction.createFromTemplates( diff --git a/src/ol/source/zoomifysource.exports b/src/ol/source/zoomifysource.exports deleted file mode 100644 index 38f7c1657b..0000000000 --- a/src/ol/source/zoomifysource.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.source.Zoomify diff --git a/src/ol/source/zoomifysource.js b/src/ol/source/zoomifysource.js index 162649e33e..d0a6628f7c 100644 --- a/src/ol/source/zoomifysource.js +++ b/src/ol/source/zoomifysource.js @@ -27,6 +27,7 @@ ol.source.ZoomifyTierSizeCalculation = { * @extends {ol.source.TileImage} * @param {olx.source.ZoomifyOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.source.Zoomify = function(opt_options) { diff --git a/src/ol/sphere/sphere.exports b/src/ol/sphere/sphere.exports deleted file mode 100644 index 3d47177b3b..0000000000 --- a/src/ol/sphere/sphere.exports +++ /dev/null @@ -1 +0,0 @@ -@exportProperty ol.Sphere.prototype.circle diff --git a/src/ol/sphere/sphere.js b/src/ol/sphere/sphere.js index 3f5877bc24..ed095e7736 100644 --- a/src/ol/sphere/sphere.js +++ b/src/ol/sphere/sphere.js @@ -38,6 +38,7 @@ ol.Sphere = function(radius) { * @param {number} radius Radius. * @param {number=} opt_n N. * @return {ol.geom.Geometry} Circle geometry. + * @todo api */ ol.Sphere.prototype.circle = function(center, radius, opt_n) { var n = goog.isDef(opt_n) ? opt_n : 32; diff --git a/src/ol/sphere/wgs84sphere.exports b/src/ol/sphere/wgs84sphere.exports deleted file mode 100644 index 955afd150b..0000000000 --- a/src/ol/sphere/wgs84sphere.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.sphere.WGS84 diff --git a/src/ol/sphere/wgs84sphere.js b/src/ol/sphere/wgs84sphere.js index 19624fd6b2..dc3c5d78e4 100644 --- a/src/ol/sphere/wgs84sphere.js +++ b/src/ol/sphere/wgs84sphere.js @@ -7,5 +7,6 @@ goog.require('ol.Sphere'); * A sphere with radius equal to the semi-major axis of the WGS84 ellipsoid. * @const * @type {ol.Sphere} + * @todo api */ ol.sphere.WGS84 = new ol.Sphere(6378137); diff --git a/src/ol/style/circlestyle.exports b/src/ol/style/circlestyle.exports deleted file mode 100644 index fd4ebd1f1b..0000000000 --- a/src/ol/style/circlestyle.exports +++ /dev/null @@ -1,7 +0,0 @@ -@exportSymbol ol.style.Circle -@exportProperty ol.style.Circle.prototype.getAnchor -@exportProperty ol.style.Circle.prototype.getFill -@exportProperty ol.style.Circle.prototype.getImage -@exportProperty ol.style.Circle.prototype.getRadius -@exportProperty ol.style.Circle.prototype.getSize -@exportProperty ol.style.Circle.prototype.getStroke diff --git a/src/ol/style/circlestyle.js b/src/ol/style/circlestyle.js index 91647681db..92f8f40678 100644 --- a/src/ol/style/circlestyle.js +++ b/src/ol/style/circlestyle.js @@ -18,6 +18,7 @@ goog.require('ol.style.Stroke'); * @param {olx.style.CircleOptions=} opt_options Options. * @extends {ol.style.Image} * @todo stability experimental + * @todo api */ ol.style.Circle = function(opt_options) { @@ -82,6 +83,7 @@ goog.inherits(ol.style.Circle, ol.style.Image); /** * @inheritDoc + * @todo api */ ol.style.Circle.prototype.getAnchor = function() { return this.anchor_; @@ -90,6 +92,7 @@ ol.style.Circle.prototype.getAnchor = function() { /** * @return {ol.style.Fill} Fill style. + * @todo api */ ol.style.Circle.prototype.getFill = function() { return this.fill_; @@ -106,6 +109,7 @@ ol.style.Circle.prototype.getHitDetectionImage = function(pixelRatio) { /** * @inheritDoc + * @todo api */ ol.style.Circle.prototype.getImage = function(pixelRatio) { return this.canvas_; @@ -122,6 +126,7 @@ ol.style.Circle.prototype.getImageState = function() { /** * @return {number} Radius. + * @todo api */ ol.style.Circle.prototype.getRadius = function() { return this.radius_; @@ -130,6 +135,7 @@ ol.style.Circle.prototype.getRadius = function() { /** * @inheritDoc + * @todo api */ ol.style.Circle.prototype.getSize = function() { return this.size_; @@ -138,6 +144,7 @@ ol.style.Circle.prototype.getSize = function() { /** * @return {ol.style.Stroke} Stroke style. + * @todo api */ ol.style.Circle.prototype.getStroke = function() { return this.stroke_; diff --git a/src/ol/style/fillstyle.exports b/src/ol/style/fillstyle.exports deleted file mode 100644 index 81bb520fc8..0000000000 --- a/src/ol/style/fillstyle.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.style.Fill -@exportProperty ol.style.Fill.prototype.getColor diff --git a/src/ol/style/fillstyle.js b/src/ol/style/fillstyle.js index 25f59b0be0..f480d17893 100644 --- a/src/ol/style/fillstyle.js +++ b/src/ol/style/fillstyle.js @@ -7,6 +7,7 @@ goog.require('ol.color'); /** * @constructor * @param {olx.style.FillOptions=} opt_options Options. + * @todo api */ ol.style.Fill = function(opt_options) { @@ -22,6 +23,7 @@ ol.style.Fill = function(opt_options) { /** * @return {ol.Color|string} Color. + * @todo api */ ol.style.Fill.prototype.getColor = function() { return this.color_; diff --git a/src/ol/style/iconstyle.exports b/src/ol/style/iconstyle.exports deleted file mode 100644 index 5b7d6c6d77..0000000000 --- a/src/ol/style/iconstyle.exports +++ /dev/null @@ -1,5 +0,0 @@ -@exportSymbol ol.style.Icon -@exportProperty ol.style.Icon.prototype.getAnchor -@exportProperty ol.style.Icon.prototype.getImage -@exportProperty ol.style.Icon.prototype.getSize -@exportProperty ol.style.Icon.prototype.getSrc diff --git a/src/ol/style/iconstyle.js b/src/ol/style/iconstyle.js index f2310d1c13..d5b29b76c1 100644 --- a/src/ol/style/iconstyle.js +++ b/src/ol/style/iconstyle.js @@ -40,6 +40,7 @@ ol.style.IconAnchorUnits = { * @constructor * @param {olx.style.IconOptions=} opt_options Options. * @extends {ol.style.Image} + * @todo api */ ol.style.Icon = function(opt_options) { @@ -125,6 +126,7 @@ goog.inherits(ol.style.Icon, ol.style.Image); /** * @inheritDoc + * @todo api */ ol.style.Icon.prototype.getAnchor = function() { var anchor = this.anchor_; @@ -165,6 +167,7 @@ ol.style.Icon.prototype.getAnchor = function() { /** * @inheritDoc + * @todo api */ ol.style.Icon.prototype.getImage = function(pixelRatio) { return this.iconImage_.getImage(pixelRatio); @@ -189,6 +192,7 @@ ol.style.Icon.prototype.getHitDetectionImage = function(pixelRatio) { /** * @return {string|undefined} Image src. + * @todo api */ ol.style.Icon.prototype.getSrc = function() { return this.iconImage_.getSrc(); @@ -197,6 +201,7 @@ ol.style.Icon.prototype.getSrc = function() { /** * @inheritDoc + * @todo api */ ol.style.Icon.prototype.getSize = function() { return goog.isNull(this.size_) ? this.iconImage_.getSize() : this.size_; diff --git a/src/ol/style/imagestyle.exports b/src/ol/style/imagestyle.exports deleted file mode 100644 index 67498d3ed8..0000000000 --- a/src/ol/style/imagestyle.exports +++ /dev/null @@ -1,3 +0,0 @@ -@exportSymbol ol.style.Image -@exportProperty ol.style.Image.prototype.getRotation -@exportProperty ol.style.Image.prototype.getScale diff --git a/src/ol/style/imagestyle.js b/src/ol/style/imagestyle.js index 9b0411a22f..52f05de9c2 100644 --- a/src/ol/style/imagestyle.js +++ b/src/ol/style/imagestyle.js @@ -29,6 +29,7 @@ ol.style.ImageOptions; /** * @constructor * @param {ol.style.ImageOptions} options Options. + * @todo api */ ol.style.Image = function(options) { @@ -83,6 +84,7 @@ ol.style.Image.prototype.getRotateWithView = function() { /** * @return {number} Rotation. + * @todo api */ ol.style.Image.prototype.getRotation = function() { return this.rotation_; @@ -91,6 +93,7 @@ ol.style.Image.prototype.getRotation = function() { /** * @return {number} Scale. + * @todo api */ ol.style.Image.prototype.getScale = function() { return this.scale_; diff --git a/src/ol/style/strokestyle.exports b/src/ol/style/strokestyle.exports deleted file mode 100644 index 3e2060e9d8..0000000000 --- a/src/ol/style/strokestyle.exports +++ /dev/null @@ -1,7 +0,0 @@ -@exportSymbol ol.style.Stroke -@exportProperty ol.style.Stroke.prototype.getColor -@exportProperty ol.style.Stroke.prototype.getLineCap -@exportProperty ol.style.Stroke.prototype.getLineDash -@exportProperty ol.style.Stroke.prototype.getLineJoin -@exportProperty ol.style.Stroke.prototype.getMiterLimit -@exportProperty ol.style.Stroke.prototype.getWidth diff --git a/src/ol/style/strokestyle.js b/src/ol/style/strokestyle.js index 08bbeab522..861a155c93 100644 --- a/src/ol/style/strokestyle.js +++ b/src/ol/style/strokestyle.js @@ -7,6 +7,7 @@ goog.require('ol.color'); /** * @constructor * @param {olx.style.StrokeOptions=} opt_options Options. + * @todo api */ ol.style.Stroke = function(opt_options) { @@ -52,6 +53,7 @@ ol.style.Stroke = function(opt_options) { /** * @return {ol.Color|string} Color. + * @todo api */ ol.style.Stroke.prototype.getColor = function() { return this.color_; @@ -60,6 +62,7 @@ ol.style.Stroke.prototype.getColor = function() { /** * @return {string|undefined} Line cap. + * @todo api */ ol.style.Stroke.prototype.getLineCap = function() { return this.lineCap_; @@ -68,6 +71,7 @@ ol.style.Stroke.prototype.getLineCap = function() { /** * @return {Array.} Line dash. + * @todo api */ ol.style.Stroke.prototype.getLineDash = function() { return this.lineDash_; @@ -76,6 +80,7 @@ ol.style.Stroke.prototype.getLineDash = function() { /** * @return {string|undefined} Line join. + * @todo api */ ol.style.Stroke.prototype.getLineJoin = function() { return this.lineJoin_; @@ -84,6 +89,7 @@ ol.style.Stroke.prototype.getLineJoin = function() { /** * @return {number|undefined} Miter limit. + * @todo api */ ol.style.Stroke.prototype.getMiterLimit = function() { return this.miterLimit_; @@ -92,6 +98,7 @@ ol.style.Stroke.prototype.getMiterLimit = function() { /** * @return {number|undefined} Width. + * @todo api */ ol.style.Stroke.prototype.getWidth = function() { return this.width_; diff --git a/src/ol/style/style.exports b/src/ol/style/style.exports deleted file mode 100644 index 94767397d0..0000000000 --- a/src/ol/style/style.exports +++ /dev/null @@ -1,6 +0,0 @@ -@exportSymbol ol.style.Style -@exportProperty ol.style.Style.prototype.getFill -@exportProperty ol.style.Style.prototype.getImage -@exportProperty ol.style.Style.prototype.getStroke -@exportProperty ol.style.Style.prototype.getText -@exportProperty ol.style.Style.prototype.getZIndex diff --git a/src/ol/style/style.js b/src/ol/style/style.js index 2016ee3f54..8c41083043 100644 --- a/src/ol/style/style.js +++ b/src/ol/style/style.js @@ -9,6 +9,7 @@ goog.require('ol.style.Image'); * @constructor * @param {olx.style.StyleOptions=} opt_options Style options. * @todo stability experimental + * @todo api */ ol.style.Style = function(opt_options) { @@ -49,6 +50,7 @@ ol.style.Style = function(opt_options) { /** * @return {ol.style.Fill} Fill style. + * @todo api */ ol.style.Style.prototype.getFill = function() { return this.fill_; @@ -57,6 +59,7 @@ ol.style.Style.prototype.getFill = function() { /** * @return {ol.style.Image} Image style. + * @todo api */ ol.style.Style.prototype.getImage = function() { return this.image_; @@ -65,6 +68,7 @@ ol.style.Style.prototype.getImage = function() { /** * @return {ol.style.Stroke} Stroke style. + * @todo api */ ol.style.Style.prototype.getStroke = function() { return this.stroke_; @@ -73,6 +77,7 @@ ol.style.Style.prototype.getStroke = function() { /** * @return {ol.style.Text} Text style. + * @todo api */ ol.style.Style.prototype.getText = function() { return this.text_; @@ -81,6 +86,7 @@ ol.style.Style.prototype.getText = function() { /** * @return {number|undefined} ZIndex. + * @todo api */ ol.style.Style.prototype.getZIndex = function() { return this.zIndex_; diff --git a/src/ol/style/textstyle.exports b/src/ol/style/textstyle.exports deleted file mode 100644 index 2dc53b5f5d..0000000000 --- a/src/ol/style/textstyle.exports +++ /dev/null @@ -1,9 +0,0 @@ -@exportSymbol ol.style.Text -@exportProperty ol.style.Text.prototype.getFill -@exportProperty ol.style.Text.prototype.getFont -@exportProperty ol.style.Text.prototype.getRotation -@exportProperty ol.style.Text.prototype.getScale -@exportProperty ol.style.Text.prototype.getStroke -@exportProperty ol.style.Text.prototype.getText -@exportProperty ol.style.Text.prototype.getTextAlign -@exportProperty ol.style.Text.prototype.getTextBaseline diff --git a/src/ol/style/textstyle.js b/src/ol/style/textstyle.js index da9bedee27..2ff02394b3 100644 --- a/src/ol/style/textstyle.js +++ b/src/ol/style/textstyle.js @@ -5,6 +5,7 @@ goog.provide('ol.style.Text'); /** * @constructor * @param {olx.style.TextOptions=} opt_options Options. + * @todo api */ ol.style.Text = function(opt_options) { @@ -74,6 +75,7 @@ ol.style.Text = function(opt_options) { /** * @return {string|undefined} Font. + * @todo api */ ol.style.Text.prototype.getFont = function() { return this.font_; @@ -98,6 +100,7 @@ ol.style.Text.prototype.getOffsetY = function() { /** * @return {ol.style.Fill} Fill style. + * @todo api */ ol.style.Text.prototype.getFill = function() { return this.fill_; @@ -106,6 +109,7 @@ ol.style.Text.prototype.getFill = function() { /** * @return {number|undefined} Rotation. + * @todo api */ ol.style.Text.prototype.getRotation = function() { return this.rotation_; @@ -114,6 +118,7 @@ ol.style.Text.prototype.getRotation = function() { /** * @return {number|undefined} Scale. + * @todo api */ ol.style.Text.prototype.getScale = function() { return this.scale_; @@ -122,6 +127,7 @@ ol.style.Text.prototype.getScale = function() { /** * @return {ol.style.Stroke} Stroke style. + * @todo api */ ol.style.Text.prototype.getStroke = function() { return this.stroke_; @@ -130,6 +136,7 @@ ol.style.Text.prototype.getStroke = function() { /** * @return {string|undefined} Text. + * @todo api */ ol.style.Text.prototype.getText = function() { return this.text_; @@ -138,6 +145,7 @@ ol.style.Text.prototype.getText = function() { /** * @return {string|undefined} Text align. + * @todo api */ ol.style.Text.prototype.getTextAlign = function() { return this.textAlign_; @@ -146,6 +154,7 @@ ol.style.Text.prototype.getTextAlign = function() { /** * @return {string|undefined} Text baseline. + * @todo api */ ol.style.Text.prototype.getTextBaseline = function() { return this.textBaseline_; diff --git a/src/ol/tile.exports b/src/ol/tile.exports deleted file mode 100644 index 33b1b0fdc8..0000000000 --- a/src/ol/tile.exports +++ /dev/null @@ -1 +0,0 @@ -@exportProperty ol.Tile.prototype.getTileCoord diff --git a/src/ol/tile.js b/src/ol/tile.js index 610150083e..59654a0a14 100644 --- a/src/ol/tile.js +++ b/src/ol/tile.js @@ -73,6 +73,7 @@ ol.Tile.prototype.getKey = function() { /** * @return {ol.TileCoord} * @todo stability experimental + * @todo api */ ol.Tile.prototype.getTileCoord = function() { return this.tileCoord; diff --git a/src/ol/tilecoord.exports b/src/ol/tilecoord.exports deleted file mode 100644 index 1719d37b9b..0000000000 --- a/src/ol/tilecoord.exports +++ /dev/null @@ -1 +0,0 @@ -@exportProperty ol.TileCoord.prototype.getZXY diff --git a/src/ol/tilecoord.js b/src/ol/tilecoord.js index 013cc5af2c..8d90fd393f 100644 --- a/src/ol/tilecoord.js +++ b/src/ol/tilecoord.js @@ -118,6 +118,7 @@ ol.TileCoord.getKeyZXY = function(z, x, y) { /** * @param {Array.=} opt_result Optional array to reuse. * @return {Array.} Array of z, x, y. + * @todo api */ ol.TileCoord.prototype.getZXY = function(opt_result) { if (goog.isDef(opt_result)) { diff --git a/src/ol/tilegrid/tilegrid.exports b/src/ol/tilegrid/tilegrid.exports deleted file mode 100644 index 5e1039d79f..0000000000 --- a/src/ol/tilegrid/tilegrid.exports +++ /dev/null @@ -1,5 +0,0 @@ -@exportSymbol ol.tilegrid.TileGrid -@exportProperty ol.tilegrid.TileGrid.prototype.getMinZoom -@exportProperty ol.tilegrid.TileGrid.prototype.getOrigin -@exportProperty ol.tilegrid.TileGrid.prototype.getResolutions -@exportProperty ol.tilegrid.TileGrid.prototype.getTileSize diff --git a/src/ol/tilegrid/tilegrid.js b/src/ol/tilegrid/tilegrid.js index ac547c42b3..aaf9c4ab0e 100644 --- a/src/ol/tilegrid/tilegrid.js +++ b/src/ol/tilegrid/tilegrid.js @@ -30,6 +30,7 @@ ol.DEFAULT_MAX_ZOOM = 42; * @param {olx.tilegrid.TileGridOptions} options Tile grid options. * @struct * @todo stability experimental + * @todo api */ ol.tilegrid.TileGrid = function(options) { @@ -149,6 +150,7 @@ ol.tilegrid.TileGrid.prototype.getMaxZoom = function() { /** * @return {number} Min zoom. * @todo stability experimental + * @todo api */ ol.tilegrid.TileGrid.prototype.getMinZoom = function() { return this.minZoom; @@ -159,6 +161,7 @@ ol.tilegrid.TileGrid.prototype.getMinZoom = function() { * @param {number} z Z. * @return {ol.Coordinate} Origin. * @todo stability experimental + * @todo api */ ol.tilegrid.TileGrid.prototype.getOrigin = function(z) { if (!goog.isNull(this.origin_)) { @@ -174,6 +177,7 @@ ol.tilegrid.TileGrid.prototype.getOrigin = function(z) { /** * @param {number} z Z. * @return {number} Resolution. + * @todo api */ ol.tilegrid.TileGrid.prototype.getResolution = function(z) { goog.asserts.assert(this.minZoom <= z && z <= this.maxZoom); @@ -373,6 +377,7 @@ ol.tilegrid.TileGrid.prototype.getTileCoordResolution = function(tileCoord) { * @param {number} z Z. * @return {number} Tile size. * @todo stability experimental + * @todo api */ ol.tilegrid.TileGrid.prototype.getTileSize = function(z) { if (goog.isDef(this.tileSize_)) { diff --git a/src/ol/tilegrid/wmtstilegrid.exports b/src/ol/tilegrid/wmtstilegrid.exports deleted file mode 100644 index 654b18d9c8..0000000000 --- a/src/ol/tilegrid/wmtstilegrid.exports +++ /dev/null @@ -1,2 +0,0 @@ -@exportSymbol ol.tilegrid.WMTS -@exportProperty ol.tilegrid.WMTS.prototype.getMatrixIds diff --git a/src/ol/tilegrid/wmtstilegrid.js b/src/ol/tilegrid/wmtstilegrid.js index 5c4ad79de6..ae1f1bc01e 100644 --- a/src/ol/tilegrid/wmtstilegrid.js +++ b/src/ol/tilegrid/wmtstilegrid.js @@ -13,6 +13,7 @@ goog.require('ol.tilegrid.TileGrid'); * @param {olx.tilegrid.WMTSOptions} options WMTS options. * @struct * @todo stability experimental + * @todo api */ ol.tilegrid.WMTS = function(options) { @@ -51,6 +52,7 @@ ol.tilegrid.WMTS.prototype.getMatrixId = function(z) { /** * @return {Array.} MatrixIds. * @todo stability experimental + * @todo api */ ol.tilegrid.WMTS.prototype.getMatrixIds = function() { return this.matrixIds_; diff --git a/src/ol/tilegrid/xyztilegrid.exports b/src/ol/tilegrid/xyztilegrid.exports deleted file mode 100644 index f05509aca9..0000000000 --- a/src/ol/tilegrid/xyztilegrid.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.tilegrid.XYZ diff --git a/src/ol/tilegrid/xyztilegrid.js b/src/ol/tilegrid/xyztilegrid.js index d3bdd82d6b..009ad751a6 100644 --- a/src/ol/tilegrid/xyztilegrid.js +++ b/src/ol/tilegrid/xyztilegrid.js @@ -15,6 +15,7 @@ goog.require('ol.tilegrid.TileGrid'); * @param {olx.tilegrid.XYZOptions} options XYZ options. * @struct * @todo stability experimental + * @todo api */ ol.tilegrid.XYZ = function(options) { diff --git a/src/ol/tilegrid/zoomifytilegrid.exports b/src/ol/tilegrid/zoomifytilegrid.exports deleted file mode 100644 index afbfc424a2..0000000000 --- a/src/ol/tilegrid/zoomifytilegrid.exports +++ /dev/null @@ -1 +0,0 @@ -@exportSymbol ol.tilegrid.Zoomify diff --git a/src/ol/tilegrid/zoomifytilegrid.js b/src/ol/tilegrid/zoomifytilegrid.js index 6bf221c8fd..81c27e3c8f 100644 --- a/src/ol/tilegrid/zoomifytilegrid.js +++ b/src/ol/tilegrid/zoomifytilegrid.js @@ -12,6 +12,7 @@ goog.require('ol.tilegrid.TileGrid'); * @extends {ol.tilegrid.TileGrid} * @param {olx.tilegrid.ZoomifyOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.tilegrid.Zoomify = function(opt_options) { var options = goog.isDef(opt_options) ? opt_options : options; diff --git a/src/ol/view2d.exports b/src/ol/view2d.exports deleted file mode 100644 index e665804784..0000000000 --- a/src/ol/view2d.exports +++ /dev/null @@ -1,11 +0,0 @@ -@exportSymbol ol.View2D -@exportProperty ol.View2D.prototype.calculateExtent -@exportProperty ol.View2D.prototype.constrainResolution -@exportProperty ol.View2D.prototype.constrainRotation -@exportProperty ol.View2D.prototype.fitExtent -@exportProperty ol.View2D.prototype.fitGeometry -@exportProperty ol.View2D.prototype.centerOn -@exportProperty ol.View2D.prototype.getView2D -@exportProperty ol.View2D.prototype.getZoom -@exportProperty ol.View2D.prototype.rotate -@exportProperty ol.View2D.prototype.setZoom diff --git a/src/ol/view2d.js b/src/ol/view2d.js index 72f67bd150..6c23063dc4 100644 --- a/src/ol/view2d.js +++ b/src/ol/view2d.js @@ -91,6 +91,7 @@ ol.View2DProperty = { * @todo observable projection {ol.proj.Projection} the projection of the view * @todo observable resolution {number} the resolution of the view * @todo observable rotation {number} the rotation of the view + * @todo api */ ol.View2D = function(opt_options) { goog.base(this); @@ -197,6 +198,7 @@ ol.View2D.prototype.constrainCenter = function(center) { * @param {number=} opt_direction Direction. Default is `0`. * @return {number|undefined} Constrained resolution. * @todo stability experimental + * @todo api */ ol.View2D.prototype.constrainResolution = function( resolution, opt_delta, opt_direction) { @@ -212,6 +214,7 @@ ol.View2D.prototype.constrainResolution = function( * @param {number=} opt_delta Delta. Default is `0`. * @return {number|undefined} Constrained rotation. * @todo stability experimental + * @todo api */ ol.View2D.prototype.constrainRotation = function(rotation, opt_delta) { var delta = opt_delta || 0; @@ -238,6 +241,7 @@ goog.exportProperty( * @param {ol.Size} size Box pixel size. * @return {ol.Extent} Extent. * @todo stability experimental + * @todo api */ ol.View2D.prototype.calculateExtent = function(size) { goog.asserts.assert(this.isDef()); @@ -353,6 +357,7 @@ ol.View2D.prototype.getValueForResolutionFunction = function(opt_power) { /** * @inheritDoc + * @todo api */ ol.View2D.prototype.getView2D = function() { return this; @@ -389,6 +394,7 @@ ol.View2D.prototype.getView3D = function() { * resolution is undefined or not a "constrained resolution". * @return {number|undefined} Zoom. * @todo stability experimental + * @todo api */ ol.View2D.prototype.getZoom = function() { var zoom; @@ -415,6 +421,7 @@ ol.View2D.prototype.getZoom = function() { * @param {ol.Extent} extent Extent. * @param {ol.Size} size Box pixel size. * @todo stability experimental + * @todo api */ ol.View2D.prototype.fitExtent = function(extent, size) { if (!ol.extent.isEmpty(extent)) { @@ -437,6 +444,7 @@ ol.View2D.prototype.fitExtent = function(extent, size) { * @param {ol.Size} size Box pixel size. * @param {olx.View2D.fitGeometryOptions=} opt_options Options. * @todo stability experimental + * @todo api */ ol.View2D.prototype.fitGeometry = function(geometry, size, opt_options) { var options = goog.isDef(opt_options) ? opt_options : {}; @@ -504,6 +512,7 @@ ol.View2D.prototype.fitGeometry = function(geometry, size, opt_options) { * @param {ol.Size} size Box pixel size. * @param {ol.Pixel} position Position on the view to center on. * @todo stability experimental + * @todo api */ ol.View2D.prototype.centerOn = function(coordinate, size, position) { // calculate rotated position @@ -538,6 +547,7 @@ ol.View2D.prototype.isDef = function() { * Rotate the view around a given coordinate. * @param {number} rotation New rotation value for the view. * @param {ol.Coordinate=} opt_anchor The rotation center. + * @todo api */ ol.View2D.prototype.rotate = function(rotation, opt_anchor) { if (goog.isDef(opt_anchor)) { @@ -609,6 +619,7 @@ goog.exportProperty( * Zoom to a specific zoom level. * @param {number} zoom Zoom level. * @todo stability experimental + * @todo api */ ol.View2D.prototype.setZoom = function(zoom) { var resolution = this.constrainResolution(this.maxResolution_, zoom, 0); diff --git a/src/ol/webgl/context.exports b/src/ol/webgl/context.exports deleted file mode 100644 index 60a3eea651..0000000000 --- a/src/ol/webgl/context.exports +++ /dev/null @@ -1,3 +0,0 @@ -@exportSymbol ol.webgl.Context -@exportProperty ol.webgl.Context.prototype.getGL -@exportProperty ol.webgl.Context.prototype.useProgram diff --git a/src/ol/webgl/context.js b/src/ol/webgl/context.js index bca86a5dc2..78b98534af 100644 --- a/src/ol/webgl/context.js +++ b/src/ol/webgl/context.js @@ -23,6 +23,7 @@ ol.webgl.BufferCacheEntry; * @extends {goog.events.EventTarget} * @param {HTMLCanvasElement} canvas Canvas. * @param {WebGLRenderingContext} gl GL. + * @todo api */ ol.webgl.Context = function(canvas, gl) { @@ -159,6 +160,7 @@ ol.webgl.Context.prototype.getCanvas = function() { /** * @return {WebGLRenderingContext} GL. + * @todo api */ ol.webgl.Context.prototype.getGL = function() { return this.gl_; @@ -246,6 +248,7 @@ ol.webgl.Context.prototype.handleWebGLContextRestored = function() { /** * @param {WebGLProgram} program Program. * @return {boolean} Changed. + * @todo api */ ol.webgl.Context.prototype.useProgram = function(program) { if (program == this.currentProgram_) {