Use @api annotation instead of @todo api

2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions
--- a/src/ol/source/bingmapssource.js
+++ b/src/ol/source/bingmapssource.js
@@ -23,7 +23,7 @@ goog.require('ol.tilegrid.XYZ');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.BingMapsOptions} options Bing Maps options.
- * @todo api
+ * @api
 */
 ol.source.BingMaps = function(options) {

@@ -59,7 +59,7 @@ goog.inherits(ol.source.BingMaps, ol.source.TileImage);
 /**
 * @const
 * @type {ol.Attribution}
- * @todo api
+ * @api
 */
 ol.source.BingMaps.TOS_ATTRIBUTION = new ol.Attribution({
  html: '<a class="ol-attribution-bing-tos" target="_blank" ' +
--- a/src/ol/source/debugtilesource.js
+++ b/src/ol/source/debugtilesource.js
@@ -77,7 +77,7 @@ ol.DebugTile_.prototype.getImage = function(opt_context) {
 * @constructor
 * @extends {ol.source.Tile}
 * @param {olx.source.TileDebugOptions} options Debug tile options.
- * @todo api
+ * @api
 */
 ol.source.TileDebug = function(options) {

--- a/src/ol/source/formatvectorsource.js
+++ b/src/ol/source/formatvectorsource.js
@@ -116,7 +116,7 @@ ol.source.FormatVector.prototype.loadFeaturesFromURL =
 /**
 * @param {ArrayBuffer|Document|Node|Object|string} source Source.
 * @return {Array.<ol.Feature>} Features.
- * @todo api
+ * @api
 */
 ol.source.FormatVector.prototype.readFeatures = function(source) {
  var format = this.format;
--- a/src/ol/source/geojsonsource.js
+++ b/src/ol/source/geojsonsource.js
@@ -13,7 +13,7 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires ol.source.VectorEvent
 * @param {olx.source.GeoJSONOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.GeoJSON = function(opt_options) {

--- a/src/ol/source/gpxsource.js
+++ b/src/ol/source/gpxsource.js
@@ -13,7 +13,7 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires ol.source.VectorEvent
 * @param {olx.source.GPXOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.GPX = function(opt_options) {

--- a/src/ol/source/igcsource.js
+++ b/src/ol/source/igcsource.js
@@ -13,7 +13,7 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires ol.source.VectorEvent
 * @param {olx.source.IGCOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.IGC = function(opt_options) {

--- a/src/ol/source/imagecanvassource.js
+++ b/src/ol/source/imagecanvassource.js
@@ -14,7 +14,7 @@ goog.require('ol.source.Image');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.ImageCanvasOptions} options
- * @todo api
+ * @api
 */
 ol.source.ImageCanvas = function(options) {

--- a/src/ol/source/imagestaticsource.js
+++ b/src/ol/source/imagestaticsource.js
@@ -15,7 +15,7 @@ goog.require('ol.source.Image');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.ImageStaticOptions} options Options.
- * @todo api
+ * @api
 */
 ol.source.ImageStatic = function(options) {

--- a/src/ol/source/imagevectorsource.js
+++ b/src/ol/source/imagevectorsource.js
@@ -30,7 +30,7 @@ goog.require('ol.vec.Mat4');
 * @constructor
 * @extends {ol.source.ImageCanvas}
 * @param {olx.source.ImageVectorOptions} options Options.
- * @todo api
+ * @api
 */
 ol.source.ImageVector = function(options) {

@@ -166,7 +166,7 @@ ol.source.ImageVector.prototype.forEachFeatureAtPixel = function(

 /**
 * @return {ol.source.Vector} Source.
- * @todo api
+ * @api
 */
 ol.source.ImageVector.prototype.getSource = function() {
  return this.source_;
--- a/src/ol/source/imagewmssource.js
+++ b/src/ol/source/imagewmssource.js
@@ -23,7 +23,7 @@ goog.require('ol.source.wms.ServerType');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.ImageWMSOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.ImageWMS = function(opt_options) {

@@ -128,7 +128,7 @@ goog.inherits(ol.source.ImageWMS, ol.source.Image);
 *     in the `LAYERS` parameter will be used. `VERSION` should not be
 *     specified here.
 * @return {string|undefined} GetFeatureInfo URL.
- * @todo api
+ * @api
 */
 ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
    function(coordinate, resolution, projection, params) {
@@ -178,7 +178,7 @@ ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
 * Get the user-provided params, i.e. those passed to the constructor through
 * the "params" option, and possibly updated using the updateParams method.
 * @return {Object} Params.
- * @todo api
+ * @api
 */
 ol.source.ImageWMS.prototype.getParams = function() {
  return this.params_;
@@ -321,7 +321,7 @@ ol.source.ImageWMS.prototype.getRequestUrl_ =
 /**
 * Return the URL used for this WMS source.
 * @return {string|undefined} URL.
- * @todo api
+ * @api
 */
 ol.source.ImageWMS.prototype.getUrl = function() {
  return this.url_;
@@ -330,7 +330,7 @@ ol.source.ImageWMS.prototype.getUrl = function() {

 /**
 * @param {string|undefined} url URL.
- * @todo api
+ * @api
 */
 ol.source.ImageWMS.prototype.setUrl = function(url) {
  if (url != this.url_) {
@@ -344,7 +344,7 @@ ol.source.ImageWMS.prototype.setUrl = function(url) {
 /**
 * Update the user-provided params.
 * @param {Object} params Params.
- * @todo api
+ * @api
 */
 ol.source.ImageWMS.prototype.updateParams = function(params) {
  goog.object.extend(this.params_, params);
--- a/src/ol/source/kmlsource.js
+++ b/src/ol/source/kmlsource.js
@@ -13,7 +13,7 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires ol.source.VectorEvent
 * @param {olx.source.KMLOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.KML = function(opt_options) {

--- a/src/ol/source/mapguidesource.js
+++ b/src/ol/source/mapguidesource.js
@@ -16,7 +16,7 @@ goog.require('ol.source.Image');
 * @constructor
 * @extends {ol.source.Image}
 * @param {olx.source.MapGuideOptions} options Options.
- * @todo api
+ * @api
 */
 ol.source.MapGuide = function(options) {

--- a/src/ol/source/mapquestsource.js
+++ b/src/ol/source/mapquestsource.js
@@ -15,7 +15,7 @@ goog.require('ol.source.XYZ');
 * @constructor
 * @extends {ol.source.XYZ}
 * @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
- * @todo api
+ * @api
 */
 ol.source.MapQuest = function(opt_options) {

--- a/src/ol/source/osmsource.js
+++ b/src/ol/source/osmsource.js
@@ -13,7 +13,7 @@ goog.require('ol.source.XYZ');
 * @constructor
 * @extends {ol.source.XYZ}
 * @param {olx.source.OSMOptions=} opt_options Open Street Map options.
- * @todo api
+ * @api
 */
 ol.source.OSM = function(opt_options) {

@@ -49,7 +49,7 @@ goog.inherits(ol.source.OSM, ol.source.XYZ);
 /**
 * @const
 * @type {ol.Attribution}
- * @todo api
+ * @api
 */
 ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution({
  html: 'Data &copy; ' +
@@ -62,7 +62,7 @@ ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution({
 /**
 * @const
 * @type {ol.Attribution}
- * @todo api
+ * @api
 */
 ol.source.OSM.TILE_ATTRIBUTION = new ol.Attribution({
  html: 'Tiles &copy; ' +
--- a/src/ol/source/osmxmlsource.js
+++ b/src/ol/source/osmxmlsource.js
@@ -13,7 +13,7 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires ol.source.VectorEvent
 * @param {olx.source.OSMXMLOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.OSMXML = function(opt_options) {

--- a/src/ol/source/servervectorsource.js
+++ b/src/ol/source/servervectorsource.js
@@ -17,7 +17,7 @@ goog.require('ol.structs.RBush');
 * @constructor
 * @extends {ol.source.FormatVector}
 * @param {olx.source.ServerVectorOptions} options Options.
- * @todo api
+ * @api
 */
 ol.source.ServerVector = function(options) {

@@ -108,6 +108,6 @@ ol.source.ServerVector.prototype.loadFeatures =
 * @function
 * @param {ArrayBuffer|Document|Node|Object|string} source Source.
 * @return {Array.<ol.Feature>} Features.
- * @todo api
+ * @api
 */
 ol.source.ServerVector.prototype.readFeatures;
--- a/src/ol/source/source.js
+++ b/src/ol/source/source.js
@@ -11,7 +11,7 @@ goog.require('ol.proj');
 /**
 * State of the source, one of 'loading', 'ready' or 'error'.
 * @enum {string}
- * @todo api
+ * @api
 */
 ol.source.State = {
  LOADING: 'loading',
@@ -138,7 +138,7 @@ ol.source.Source.prototype.getResolutions = goog.abstractMethod;

 /**
 * @return {ol.source.State} State.
- * @todo api
+ * @api
 */
 ol.source.Source.prototype.getState = function() {
  return this.state_;
--- a/src/ol/source/stamensource.js
+++ b/src/ol/source/stamensource.js
@@ -85,7 +85,7 @@ ol.source.StamenProviderConfig = {
 * @constructor
 * @extends {ol.source.XYZ}
 * @param {olx.source.StamenOptions} options Stamen options.
- * @todo api
+ * @api
 */
 ol.source.Stamen = function(options) {

--- a/src/ol/source/staticvectorsource.js
+++ b/src/ol/source/staticvectorsource.js
@@ -16,7 +16,7 @@ goog.require('ol.source.State');
 * @extends {ol.source.FormatVector}
 * @fires ol.source.VectorEvent
 * @param {olx.source.StaticVectorOptions} options Options.
- * @todo api
+ * @api
 */
 ol.source.StaticVector = function(options) {

--- a/src/ol/source/tileimagesource.js
+++ b/src/ol/source/tileimagesource.js
@@ -19,7 +19,7 @@ goog.require('ol.source.Tile');
 * @constructor
 * @extends {ol.source.Tile}
 * @param {olx.source.TileImageOptions} options Image tile options.
- * @todo api
+ * @api
 */
 ol.source.TileImage = function(options) {

@@ -124,7 +124,7 @@ ol.source.TileImage.prototype.getTile =

 /**
 * @return {ol.TileLoadFunctionType} TileLoadFunction
- * @todo api
+ * @api
 */
 ol.source.TileImage.prototype.getTileLoadFunction = function() {
  return this.tileLoadFunction;
@@ -133,7 +133,7 @@ ol.source.TileImage.prototype.getTileLoadFunction = function() {

 /**
 * @return {ol.TileUrlFunctionType} TileUrlFunction
- * @todo api
+ * @api
 */
 ol.source.TileImage.prototype.getTileUrlFunction = function() {
  return this.tileUrlFunction;
@@ -142,7 +142,7 @@ ol.source.TileImage.prototype.getTileUrlFunction = function() {

 /**
 * @param {ol.TileLoadFunctionType} tileLoadFunction Tile load function.
- * @todo api
+ * @api
 */
 ol.source.TileImage.prototype.setTileLoadFunction = function(tileLoadFunction) {
  this.tileCache.clear();
@@ -153,7 +153,7 @@ ol.source.TileImage.prototype.setTileLoadFunction = function(tileLoadFunction) {

 /**
 * @param {ol.TileUrlFunctionType} tileUrlFunction Tile URL function.
- * @todo api
+ * @api
 */
 ol.source.TileImage.prototype.setTileUrlFunction = function(tileUrlFunction) {
  // FIXME It should be possible to be more intelligent and avoid clearing the
--- a/src/ol/source/tilejsonsource.js
+++ b/src/ol/source/tilejsonsource.js
@@ -28,7 +28,7 @@ goog.require('ol.tilegrid.XYZ');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.TileJSONOptions} options TileJSON options.
- * @todo api
+ * @api
 */
 ol.source.TileJSON = function(options) {

--- a/src/ol/source/tilesource.js
+++ b/src/ol/source/tilesource.js
@@ -163,7 +163,7 @@ ol.source.Tile.prototype.getTile = goog.abstractMethod;

 /**
 * @return {ol.tilegrid.TileGrid} Tile grid.
- * @todo api
+ * @api
 */
 ol.source.Tile.prototype.getTileGrid = function() {
  return this.tileGrid;
--- a/src/ol/source/tilevectorsource.js
+++ b/src/ol/source/tilevectorsource.js
@@ -18,7 +18,7 @@ goog.require('ol.tilegrid.TileGrid');
 * @constructor
 * @extends {ol.source.FormatVector}
 * @param {olx.source.TileVectorOptions} options Options.
- * @todo api
+ * @api
 */
 ol.source.TileVector = function(options) {

--- a/src/ol/source/tilewmssource.js
+++ b/src/ol/source/tilewmssource.js
@@ -27,7 +27,7 @@ goog.require('ol.source.wms.ServerType');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.TileWMSOptions=} opt_options Tile WMS options.
- * @todo api
+ * @api
 */
 ol.source.TileWMS = function(opt_options) {

@@ -128,7 +128,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
+ * @api
 */
 ol.source.TileWMS.prototype.getGetFeatureInfoUrl =
    function(coordinate, resolution, projection, params) {
@@ -210,7 +210,7 @@ ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) {
 * Get the user-provided params, i.e. those passed to the constructor through
 * the "params" option, and possibly updated using the updateParams method.
 * @return {Object} Params.
- * @todo api
+ * @api
 */
 ol.source.TileWMS.prototype.getParams = function() {
  return this.params_;
@@ -310,7 +310,7 @@ ol.source.TileWMS.prototype.getTilePixelSize =
 /**
 * Return the URLs used for this WMS source.
 * @return {Array.<string>|undefined} URLs.
- * @todo api
+ * @api
 */
 ol.source.TileWMS.prototype.getUrls = function() {
  return this.urls_;
@@ -394,7 +394,7 @@ ol.source.TileWMS.prototype.tileUrlFunction_ =
 /**
 * Update the user-provided params.
 * @param {Object} params Params.
- * @todo api
+ * @api
 */
 ol.source.TileWMS.prototype.updateParams = function(params) {
  goog.object.extend(this.params_, params);
--- a/src/ol/source/topojsonsource.js
+++ b/src/ol/source/topojsonsource.js
@@ -13,7 +13,7 @@ goog.require('ol.source.StaticVector');
 * @extends {ol.source.StaticVector}
 * @fires ol.source.VectorEvent
 * @param {olx.source.TopoJSONOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.TopoJSON = function(opt_options) {

--- a/src/ol/source/vectorsource.js
+++ b/src/ol/source/vectorsource.js
@@ -25,13 +25,13 @@ ol.source.VectorEventType = {
  /**
   * Triggered when a feature is added to the source.
   * @event ol.source.VectorEvent#addfeature
-   * @todo api
+   * @api
   */
  ADDFEATURE: 'addfeature',
  /**
   * Triggered when a feature is removed from the source.
   * @event ol.source.VectorEvent#removefeature
-   * @todo api
+   * @api
   */
  REMOVEFEATURE: 'removefeature'
 };
@@ -46,7 +46,7 @@ ol.source.VectorEventType = {
 * @extends {ol.source.Source}
 * @fires ol.source.VectorEvent
 * @param {olx.source.VectorOptions=} opt_options Vector source options.
- * @todo api
+ * @api
 */
 ol.source.Vector = function(opt_options) {

@@ -102,7 +102,7 @@ goog.inherits(ol.source.Vector, ol.source.Source);

 /**
 * @param {ol.Feature} feature Feature.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.addFeature = function(feature) {
  this.addFeatureInternal(feature);
@@ -148,7 +148,7 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) {

 /**
 * @param {Array.<ol.Feature>} features Features.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.addFeatures = function(features) {
  this.addFeaturesInternal(features);
@@ -172,7 +172,7 @@ ol.source.Vector.prototype.addFeaturesInternal = function(features) {

 /**
 * Remove all features.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.clear = function() {
  this.rBush_.forEach(this.removeFeatureInternal, this);
@@ -190,7 +190,7 @@ ol.source.Vector.prototype.clear = function() {
 * @param {T=} opt_this The object to use as `this` in `f`.
 * @return {S|undefined}
 * @template T,S
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.forEachFeature = function(f, opt_this) {
  return this.rBush_.forEach(f, opt_this);
@@ -225,7 +225,7 @@ ol.source.Vector.prototype.forEachFeatureAtCoordinate =
 * @param {T=} opt_this The object to use as `this` in `f`.
 * @return {S|undefined}
 * @template T,S
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.forEachFeatureInExtent =
    function(extent, f, opt_this) {
@@ -249,7 +249,7 @@ ol.source.Vector.prototype.forEachFeatureInExtentAtResolution =

 /**
 * @return {Array.<ol.Feature>} Features.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.getFeatures = function() {
  var features = this.rBush_.getAll();
@@ -264,7 +264,7 @@ ol.source.Vector.prototype.getFeatures = function() {
 /**
 * @param {ol.Coordinate} coordinate Coordinate.
 * @return {Array.<ol.Feature>} Features.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.getFeaturesAtCoordinate = function(coordinate) {
  var features = [];
@@ -287,7 +287,7 @@ ol.source.Vector.prototype.getFeaturesInExtent = function(extent) {
 /**
 * @param {ol.Coordinate} coordinate Coordinate.
 * @return {ol.Feature} Closest feature.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.getClosestFeatureToCoordinate =
    function(coordinate) {
@@ -333,7 +333,7 @@ ol.source.Vector.prototype.getClosestFeatureToCoordinate =

 /**
 * @return {ol.Extent} Extent.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.getExtent = function() {
  return this.rBush_.getExtent();
@@ -347,7 +347,7 @@ ol.source.Vector.prototype.getExtent = function() {
 *
 * @param {string|number} id Feature identifier.
 * @return {ol.Feature} The feature (or `null` if not found).
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.getFeatureById = function(id) {
  var feature = this.idIndex_[id.toString()];
@@ -425,7 +425,7 @@ ol.source.Vector.prototype.loadFeatures = goog.nullFunction;

 /**
 * @param {ol.Feature} feature Feature.
- * @todo api
+ * @api
 */
 ol.source.Vector.prototype.removeFeature = function(feature) {
  var featureKey = goog.getUid(feature).toString();
@@ -496,7 +496,7 @@ ol.source.VectorEvent = function(type, opt_feature) {
  /**
   * The feature being added or removed.
   * @type {ol.Feature|undefined}
-   * @todo api
+   * @api
   */
  this.feature = opt_feature;

--- a/src/ol/source/wmssource.js
+++ b/src/ol/source/wmssource.js
@@ -7,7 +7,7 @@ goog.provide('ol.source.wms.ServerType');
 *     `'qgis'`. These are servers that have vendor parameters beyond the WMS
 *     specification that OpenLayers can make use of.
 * @enum {string}
- * @todo api
+ * @api
 */
 ol.source.wms.ServerType = {
  CARMENTA_SERVER: 'carmentaserver',
--- a/src/ol/source/wmtssource.js
+++ b/src/ol/source/wmtssource.js
@@ -32,7 +32,7 @@ ol.source.WMTSRequestEncoding = {
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.WMTSOptions} options WMTS options.
- * @todo api
+ * @api
 */
 ol.source.WMTS = function(options) {

@@ -199,7 +199,7 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage);
 * "dimensions" option, and possibly updated using the updateDimensions
 * method.
 * @return {Object} Dimensions.
- * @todo api
+ * @api
 */
 ol.source.WMTS.prototype.getDimensions = function() {
  return this.dimensions_;
@@ -230,7 +230,7 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() {
 /**
 * Update the dimensions.
 * @param {Object} dimensions Dimensions.
- * @todo api
+ * @api
 */
 ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
  goog.object.extend(this.dimensions_, dimensions);
@@ -243,7 +243,7 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
 * @param {Object} wmtsCap An object representing the capabilities document.
 * @param {string} layer The layer identifier.
 * @return {olx.source.WMTSOptions} WMTS source options object.
- * @todo api
+ * @api
 */
 ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) {

--- a/src/ol/source/xyzsource.js
+++ b/src/ol/source/xyzsource.js
@@ -15,7 +15,7 @@ goog.require('ol.tilegrid.XYZ');
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.XYZOptions} options XYZ options.
- * @todo api
+ * @api
 */
 ol.source.XYZ = function(options) {

@@ -72,7 +72,7 @@ ol.source.XYZ.prototype.setTileUrlFunction = function(tileUrlFunction) {

 /**
 * @param {string} url URL.
- * @todo api
+ * @api
 */
 ol.source.XYZ.prototype.setUrl = function(url) {
  this.setTileUrlFunction(ol.TileUrlFunction.createFromTemplates(
--- a/src/ol/source/zoomifysource.js
+++ b/src/ol/source/zoomifysource.js
@@ -29,7 +29,7 @@ ol.source.ZoomifyTierSizeCalculation = {
 * @constructor
 * @extends {ol.source.TileImage}
 * @param {olx.source.ZoomifyOptions=} opt_options Options.
- * @todo api
+ * @api
 */
 ol.source.Zoomify = function(opt_options) {