All @api annotations imply stability

This commit is contained in:
Tim Schaub
2017-02-06 09:22:05 -07:00
parent ca23c7337f
commit f5aea97d3b
109 changed files with 705 additions and 747 deletions

View File

@@ -19,7 +19,7 @@ goog.require('ol.tilegrid');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.BingMapsOptions} options Bing Maps options.
* @api stable
* @api
*/
ol.source.BingMaps = function(options) {

View File

@@ -103,7 +103,7 @@ ol.inherits(ol.source.ImageArcGISRest, ol.source.Image);
* 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.
* @api stable
* @api
*/
ol.source.ImageArcGISRest.prototype.getParams = function() {
return this.params_;
@@ -225,7 +225,7 @@ ol.source.ImageArcGISRest.prototype.getRequestUrl_ = function(extent, size, pixe
/**
* Return the URL used for this ArcGIS source.
* @return {string|undefined} URL.
* @api stable
* @api
*/
ol.source.ImageArcGISRest.prototype.getUrl = function() {
return this.url_;
@@ -247,7 +247,7 @@ ol.source.ImageArcGISRest.prototype.setImageLoadFunction = function(imageLoadFun
/**
* Set the URL to use for requests.
* @param {string|undefined} url URL.
* @api stable
* @api
*/
ol.source.ImageArcGISRest.prototype.setUrl = function(url) {
if (url != this.url_) {
@@ -261,7 +261,7 @@ ol.source.ImageArcGISRest.prototype.setUrl = function(url) {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api stable
* @api
*/
ol.source.ImageArcGISRest.prototype.updateParams = function(params) {
ol.obj.assign(this.params_, params);

View File

@@ -18,7 +18,7 @@ goog.require('ol.uri');
* @fires ol.source.Image.Event
* @extends {ol.source.Image}
* @param {olx.source.ImageMapGuideOptions} options Options.
* @api stable
* @api
*/
ol.source.ImageMapGuide = function(options) {
@@ -106,7 +106,7 @@ ol.inherits(ol.source.ImageMapGuide, ol.source.Image);
* 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.
* @api stable
* @api
*/
ol.source.ImageMapGuide.prototype.getParams = function() {
return this.params_;
@@ -189,7 +189,7 @@ ol.source.ImageMapGuide.getScale = function(extent, size, metersPerUnit, dpi) {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api stable
* @api
*/
ol.source.ImageMapGuide.prototype.updateParams = function(params) {
ol.obj.assign(this.params_, params);

View File

@@ -18,7 +18,7 @@ goog.require('ol.source.Image');
* @constructor
* @extends {ol.source.Image}
* @param {olx.source.ImageStaticOptions} options Options.
* @api stable
* @api
*/
ol.source.ImageStatic = function(options) {
var imageExtent = options.imageExtent;

View File

@@ -193,7 +193,7 @@ ol.source.ImageVector.prototype.getSource = function() {
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction}
* Layer style.
* @api stable
* @api
*/
ol.source.ImageVector.prototype.getStyle = function() {
return this.style_;
@@ -203,7 +203,7 @@ ol.source.ImageVector.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.StyleFunction|undefined} Layer style function.
* @api stable
* @api
*/
ol.source.ImageVector.prototype.getStyleFunction = function() {
return this.styleFunction_;
@@ -292,7 +292,7 @@ ol.source.ImageVector.prototype.renderFeature_ = function(feature, resolution, p
* {@link ol.style} for information on the default style.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction|undefined}
* style Layer style.
* @api stable
* @api
*/
ol.source.ImageVector.prototype.setStyle = function(style) {
this.style_ = style !== undefined ? style : ol.style.Style.defaultFunction;

View File

@@ -24,7 +24,7 @@ goog.require('ol.uri');
* @fires ol.source.Image.Event
* @extends {ol.source.Image}
* @param {olx.source.ImageWMSOptions=} opt_options Options.
* @api stable
* @api
*/
ol.source.ImageWMS = function(opt_options) {
@@ -131,7 +131,7 @@ ol.source.ImageWMS.GETFEATUREINFO_IMAGE_SIZE_ = [101, 101];
* in the `LAYERS` parameter will be used. `VERSION` should not be
* specified here.
* @return {string|undefined} GetFeatureInfo URL.
* @api stable
* @api
*/
ol.source.ImageWMS.prototype.getGetFeatureInfoUrl = function(coordinate, resolution, projection, params) {
if (this.url_ === undefined) {
@@ -167,7 +167,7 @@ ol.source.ImageWMS.prototype.getGetFeatureInfoUrl = function(coordinate, resolut
* 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.
* @api stable
* @api
*/
ol.source.ImageWMS.prototype.getParams = function() {
return this.params_;
@@ -309,7 +309,7 @@ ol.source.ImageWMS.prototype.getRequestUrl_ = function(extent, size, pixelRatio,
/**
* Return the URL used for this WMS source.
* @return {string|undefined} URL.
* @api stable
* @api
*/
ol.source.ImageWMS.prototype.getUrl = function() {
return this.url_;
@@ -332,7 +332,7 @@ ol.source.ImageWMS.prototype.setImageLoadFunction = function(
/**
* Set the URL to use for requests.
* @param {string|undefined} url URL.
* @api stable
* @api
*/
ol.source.ImageWMS.prototype.setUrl = function(url) {
if (url != this.url_) {
@@ -346,7 +346,7 @@ ol.source.ImageWMS.prototype.setUrl = function(url) {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api stable
* @api
*/
ol.source.ImageWMS.prototype.updateParams = function(params) {
ol.obj.assign(this.params_, params);

View File

@@ -12,7 +12,7 @@ goog.require('ol.source.XYZ');
* @constructor
* @extends {ol.source.XYZ}
* @param {olx.source.OSMOptions=} opt_options Open Street Map options.
* @api stable
* @api
*/
ol.source.OSM = function(opt_options) {

View File

@@ -19,7 +19,7 @@ goog.require('ol.source.State');
* @abstract
* @extends {ol.Object}
* @param {ol.SourceSourceOptions} options Source options.
* @api stable
* @api
*/
ol.source.Source = function(options) {
@@ -108,7 +108,7 @@ ol.source.Source.prototype.forEachFeatureAtCoordinate = ol.nullFunction;
/**
* Get the attributions of the source.
* @return {Array.<ol.Attribution>} Attributions.
* @api stable
* @api
*/
ol.source.Source.prototype.getAttributions = function() {
return this.attributions_;
@@ -118,7 +118,7 @@ ol.source.Source.prototype.getAttributions = function() {
/**
* Get the logo of the source.
* @return {string|olx.LogoOptions|undefined} Logo.
* @api stable
* @api
*/
ol.source.Source.prototype.getLogo = function() {
return this.logo_;

View File

@@ -13,7 +13,7 @@ goog.require('ol.source.XYZ');
* @constructor
* @extends {ol.source.XYZ}
* @param {olx.source.StamenOptions} options Stamen options.
* @api stable
* @api
*/
ol.source.Stamen = function(options) {
var i = options.layer.indexOf('-');

View File

@@ -206,7 +206,7 @@ ol.source.Tile.prototype.getTile = function(z, x, y, pixelRatio, projection) {};
/**
* Return the tile grid of the tile source.
* @return {ol.tilegrid.TileGrid} Tile grid.
* @api stable
* @api
*/
ol.source.Tile.prototype.getTileGrid = function() {
return this.tileGrid;

View File

@@ -175,7 +175,7 @@ ol.source.TileArcGISRest.prototype.fixedTileUrlFunction = function(tileCoord, pi
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api stable
* @api
*/
ol.source.TileArcGISRest.prototype.updateParams = function(params) {
ol.obj.assign(this.params_, params);

View File

@@ -8,21 +8,21 @@ ol.source.TileEventType = {
/**
* Triggered when a tile starts loading.
* @event ol.source.Tile.Event#tileloadstart
* @api stable
* @api
*/
TILELOADSTART: 'tileloadstart',
/**
* Triggered when a tile finishes loading.
* @event ol.source.Tile.Event#tileloadend
* @api stable
* @api
*/
TILELOADEND: 'tileloadend',
/**
* Triggered if tile loading results in an error.
* @event ol.source.Tile.Event#tileloaderror
* @api stable
* @api
*/
TILELOADERROR: 'tileloaderror'

View File

@@ -24,7 +24,7 @@ goog.require('ol.tilegrid');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.TileJSONOptions} options TileJSON options.
* @api stable
* @api
*/
ol.source.TileJSON = function(options) {

View File

@@ -24,7 +24,7 @@ goog.require('ol.uri');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.TileWMSOptions=} opt_options Tile WMS options.
* @api stable
* @api
*/
ol.source.TileWMS = function(opt_options) {
@@ -112,7 +112,7 @@ ol.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.
* @api stable
* @api
*/
ol.source.TileWMS.prototype.getGetFeatureInfoUrl = function(coordinate, resolution, projection, params) {
var projectionObj = ol.proj.get(projection);
@@ -182,7 +182,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.
* @api stable
* @api
*/
ol.source.TileWMS.prototype.getParams = function() {
return this.params_;
@@ -363,7 +363,7 @@ ol.source.TileWMS.prototype.setUrls = function(urls) {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @api stable
* @api
*/
ol.source.TileWMS.prototype.updateParams = function(params) {
ol.obj.assign(this.params_, params);

View File

@@ -160,7 +160,7 @@ ol.source.UrlTile.prototype.setTileUrlFunction = function(tileUrlFunction, opt_k
/**
* Set the URL to use for requests.
* @param {string} url URL.
* @api stable
* @api
*/
ol.source.UrlTile.prototype.setUrl = function(url) {
var urls = this.urls = ol.TileUrlFunction.expandUrl(url);
@@ -173,7 +173,7 @@ ol.source.UrlTile.prototype.setUrl = function(url) {
/**
* Set the URLs to use for requests.
* @param {Array.<string>} urls URLs.
* @api stable
* @api
*/
ol.source.UrlTile.prototype.setUrls = function(urls) {
this.urls = urls;

View File

@@ -33,7 +33,7 @@ goog.require('ol.structs.RBush');
* @extends {ol.source.Source}
* @fires ol.source.Vector.Event
* @param {olx.source.VectorOptions=} opt_options Vector source options.
* @api stable
* @api
*/
ol.source.Vector = function(opt_options) {
@@ -159,7 +159,7 @@ ol.inherits(ol.source.Vector, ol.source.Source);
* at once, call {@link ol.source.Vector#addFeatures source.addFeatures()}
* instead.
* @param {ol.Feature} feature Feature to add.
* @api stable
* @api
*/
ol.source.Vector.prototype.addFeature = function(feature) {
this.addFeatureInternal(feature);
@@ -239,7 +239,7 @@ ol.source.Vector.prototype.addToIndex_ = function(featureKey, feature) {
/**
* Add a batch of features to the source.
* @param {Array.<ol.Feature>} features Features to add.
* @api stable
* @api
*/
ol.source.Vector.prototype.addFeatures = function(features) {
this.addFeaturesInternal(features);
@@ -337,7 +337,7 @@ ol.source.Vector.prototype.bindFeaturesCollection_ = function(collection) {
/**
* Remove all features from the source.
* @param {boolean=} opt_fast Skip dispatching of {@link removefeature} events.
* @api stable
* @api
*/
ol.source.Vector.prototype.clear = function(opt_fast) {
if (opt_fast) {
@@ -384,7 +384,7 @@ ol.source.Vector.prototype.clear = function(opt_fast) {
* @param {T=} opt_this The object to use as `this` in the callback.
* @return {S|undefined} The return value from the last call to the callback.
* @template T,S
* @api stable
* @api
*/
ol.source.Vector.prototype.forEachFeature = function(callback, opt_this) {
if (this.featuresRtree_) {
@@ -502,7 +502,7 @@ ol.source.Vector.prototype.getFeaturesCollection = function() {
/**
* Get all features on the source in random order.
* @return {Array.<ol.Feature>} Features.
* @api stable
* @api
*/
ol.source.Vector.prototype.getFeatures = function() {
var features;
@@ -523,7 +523,7 @@ ol.source.Vector.prototype.getFeatures = function() {
* Get all features whose geometry intersects the provided coordinate.
* @param {ol.Coordinate} coordinate Coordinate.
* @return {Array.<ol.Feature>} Features.
* @api stable
* @api
*/
ol.source.Vector.prototype.getFeaturesAtCoordinate = function(coordinate) {
var features = [];
@@ -560,7 +560,7 @@ ol.source.Vector.prototype.getFeaturesInExtent = function(extent) {
* The filter function will receive one argument, the {@link ol.Feature feature}
* and it should return a boolean value. By default, no filtering is made.
* @return {ol.Feature} Closest feature.
* @api stable
* @api
*/
ol.source.Vector.prototype.getClosestFeatureToCoordinate = function(coordinate, opt_filter) {
// Find the closest feature using branch and bound. We start searching an
@@ -611,7 +611,7 @@ ol.source.Vector.prototype.getClosestFeatureToCoordinate = function(coordinate,
* This method is not available when the source is configured with
* `useSpatialIndex` set to `false`.
* @return {!ol.Extent} Extent.
* @api stable
* @api
*/
ol.source.Vector.prototype.getExtent = function() {
return this.featuresRtree_.getExtent();
@@ -625,7 +625,7 @@ ol.source.Vector.prototype.getExtent = function() {
*
* @param {string|number} id Feature identifier.
* @return {ol.Feature} The feature (or `null` if not found).
* @api stable
* @api
*/
ol.source.Vector.prototype.getFeatureById = function(id) {
var feature = this.idIndex_[id.toString()];
@@ -763,7 +763,7 @@ ol.source.Vector.prototype.loadFeatures = function(
* at once, use the {@link ol.source.Vector#clear source.clear()} method
* instead.
* @param {ol.Feature} feature Feature to remove.
* @api stable
* @api
*/
ol.source.Vector.prototype.removeFeature = function(feature) {
var featureKey = ol.getUid(feature).toString();
@@ -837,7 +837,7 @@ ol.source.Vector.Event = function(type, opt_feature) {
/**
* The feature being added or removed.
* @type {ol.Feature|undefined}
* @api stable
* @api
*/
this.feature = opt_feature;

View File

@@ -7,7 +7,7 @@ ol.source.VectorEventType = {
/**
* Triggered when a feature is added to the source.
* @event ol.source.Vector.Event#addfeature
* @api stable
* @api
*/
ADDFEATURE: 'addfeature',
@@ -29,7 +29,7 @@ ol.source.VectorEventType = {
* Triggered when a feature is removed from the source.
* See {@link ol.source.Vector#clear source.clear()} for exceptions.
* @event ol.source.Vector.Event#removefeature
* @api stable
* @api
*/
REMOVEFEATURE: 'removefeature'
};

View File

@@ -19,7 +19,7 @@ goog.require('ol.uri');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.WMTSOptions} options WMTS options.
* @api stable
* @api
*/
ol.source.WMTS = function(options) {

View File

@@ -25,7 +25,7 @@ goog.require('ol.tilegrid');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.XYZOptions=} opt_options XYZ options.
* @api stable
* @api
*/
ol.source.XYZ = function(opt_options) {
var options = opt_options || {};

View File

@@ -17,7 +17,7 @@ goog.require('ol.tilegrid.TileGrid');
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.ZoomifyOptions=} opt_options Options.
* @api stable
* @api
*/
ol.source.Zoomify = function(opt_options) {