Annotations for exports

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();