Add default stability level to docs of exported things.

This commit is contained in:
Paul Spencer
2013-10-24 17:07:02 -04:00
parent a13c5d30a2
commit bada596b45
108 changed files with 382 additions and 0 deletions

View File

@@ -19,6 +19,7 @@ goog.require('ol.tilegrid.XYZ');
* @constructor
* @extends {ol.source.TileImage}
* @param {ol.source.BingMapsOptions} options Bing Maps options.
* @todo stability experimental
*/
ol.source.BingMaps = function(options) {

View File

@@ -85,6 +85,7 @@ ol.DebugTile_.prototype.getImage = function(opt_context) {
* @constructor
* @extends {ol.source.Tile}
* @param {ol.source.TileDebugOptions} options Debug tile options.
* @todo stability experimental
*/
ol.source.TileDebug = function(options) {

View File

@@ -4,6 +4,7 @@ goog.provide('ol.source.FeatureInfoSource');
/**
* @interface
* @todo stability experimental
*/
ol.source.FeatureInfoSource = function() {};

View File

@@ -21,6 +21,7 @@ goog.require('ol.source.Source');
* resolutions: (Array.<number>|undefined),
* imageUrlFunction: (ol.ImageUrlFunctionType|
* undefined)}}
* @todo stability experimental
*/
ol.source.ImageOptions;
@@ -30,6 +31,7 @@ ol.source.ImageOptions;
* @constructor
* @extends {ol.source.Source}
* @param {ol.source.ImageOptions} options Single image source options.
* @todo stability experimental
*/
ol.source.Image = function(options) {

View File

@@ -12,6 +12,7 @@ goog.require('ol.source.Image');
* @constructor
* @extends {ol.source.Image}
* @param {ol.source.ImageStaticOptions} options Options.
* @todo stability experimental
*/
ol.source.ImageStatic = function(options) {

View File

@@ -16,6 +16,7 @@ goog.require('ol.source.wms');
* @extends {ol.source.Image}
* @implements {ol.source.FeatureInfoSource}
* @param {ol.source.ImageWMSOptions} options Options.
* @todo stability experimental
*/
ol.source.ImageWMS = function(options) {

View File

@@ -11,6 +11,7 @@ goog.require('ol.source.XYZ');
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
* @todo stability experimental
*/
ol.source.MapQuestOSM = function(opt_options) {
@@ -43,6 +44,7 @@ goog.inherits(ol.source.MapQuestOSM, ol.source.XYZ);
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.MapQuestOptions=} opt_options MapQuest options.
* @todo stability experimental
*/
ol.source.MapQuestOpenAerial = function(opt_options) {

View File

@@ -9,6 +9,7 @@ goog.require('ol.source.XYZ');
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.OSMOptions=} opt_options Open Street Map options.
* @todo stability experimental
*/
ol.source.OSM = function(opt_options) {

View File

@@ -24,6 +24,7 @@ ol.source.State = {
* logo: (string|undefined),
* projection: ol.proj.ProjectionLike,
* state: (ol.source.State|undefined)}}
* @todo stability experimental
*/
ol.source.SourceOptions;
@@ -33,6 +34,7 @@ ol.source.SourceOptions;
* @constructor
* @extends {goog.events.EventTarget}
* @param {ol.source.SourceOptions} options Source options.
* @todo stability experimental
*/
ol.source.Source = function(options) {

View File

@@ -81,6 +81,7 @@ ol.source.StamenProviderConfig = {
* @constructor
* @extends {ol.source.XYZ}
* @param {ol.source.StamenOptions} options Stamen options.
* @todo stability experimental
*/
ol.source.Stamen = function(options) {

View File

@@ -25,6 +25,7 @@ goog.require('ol.tilegrid.TileGrid');
* tileGrid: (ol.tilegrid.TileGrid|undefined),
* tileLoadFunction: (ol.TileLoadFunctionType|undefined),
* tileUrlFunction: (ol.TileUrlFunctionType|undefined)}}
* @todo stability experimental
*/
ol.source.TileImageOptions;
@@ -34,6 +35,7 @@ ol.source.TileImageOptions;
* @constructor
* @extends {ol.source.Tile}
* @param {ol.source.TileImageOptions} options Image tile options.
* @todo stability experimental
*/
ol.source.TileImage = function(options) {

View File

@@ -41,6 +41,7 @@ goog.exportSymbol('grid', grid);
* @constructor
* @extends {ol.source.TileImage}
* @param {ol.source.TileJSONOptions} options TileJSON options.
* @todo stability experimental
*/
ol.source.TileJSON = function(options) {

View File

@@ -18,6 +18,7 @@ goog.require('ol.tilegrid.TileGrid');
* opaque: (boolean|undefined),
* projection: ol.proj.ProjectionLike,
* tileGrid: (ol.tilegrid.TileGrid|undefined)}}
* @todo stability experimental
*/
ol.source.TileOptions;
@@ -27,6 +28,7 @@ ol.source.TileOptions;
* @constructor
* @extends {ol.source.Source}
* @param {ol.source.TileOptions} options Tile source options.
* @todo stability experimental
*/
ol.source.Tile = function(options) {

View File

@@ -20,6 +20,7 @@ goog.require('ol.source.wms');
* @extends {ol.source.TileImage}
* @implements {ol.source.FeatureInfoSource}
* @param {ol.source.TileWMSOptions} options Tile WMS options.
* @todo stability experimental
*/
ol.source.TileWMS = function(options) {
@@ -127,6 +128,7 @@ ol.source.TileWMS.prototype.getKeyZXY = function(z, x, y) {
* Get the user-provided params, i.e. those passed to the constructor through
* the "params" option, and possibly updated using the updateParams method.
* @return {Object} Params.
* @todo stability experimental
*/
ol.source.TileWMS.prototype.getParams = function() {
return this.params_;
@@ -172,6 +174,7 @@ ol.source.TileWMS.prototype.resetCoordKeyPrefix_ = function() {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @todo stability experimental
*/
ol.source.TileWMS.prototype.updateParams = function(params) {
goog.object.extend(this.params_, params);

View File

@@ -21,6 +21,7 @@ ol.source.VectorLoadState = {
* @constructor
* @extends {ol.source.Source}
* @param {ol.source.VectorOptions} options Vector source options.
* @todo stability experimental
*/
ol.source.Vector = function(options) {

View File

@@ -11,6 +11,7 @@ goog.require('ol.source.Source');
* @constructor
* @extends {ol.source.Source}
* @param {ol.source.Vector2Options} options Options.
* @todo stability experimental
*/
ol.source.Vector2 = function(options) {

View File

@@ -9,6 +9,7 @@ goog.require('goog.uri.utils');
/**
* Method to use to get WMS feature info.
* @enum {string}
* @todo stability experimental
*/
ol.source.WMSGetFeatureInfoMethod = {
/**

View File

@@ -29,6 +29,7 @@ ol.source.WMTSRequestEncoding = {
* @constructor
* @extends {ol.source.TileImage}
* @param {ol.source.WMTSOptions} options WMTS options.
* @todo stability experimental
*/
ol.source.WMTS = function(options) {
@@ -193,6 +194,7 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage);
* "dimensions" option, and possibly updated using the updateDimensions
* method.
* @return {Object} Dimensions.
* @todo stability experimental
*/
ol.source.WMTS.prototype.getDimensions = function() {
return this.dimensions_;
@@ -223,6 +225,7 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() {
/**
* Update the dimensions.
* @param {Object} dimensions Dimensions.
* @todo stability experimental
*/
ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
goog.object.extend(this.dimensions_, dimensions);
@@ -235,6 +238,7 @@ ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
* @param {Object} wmtsCap An object representing the capabilities document.
* @param {string} layer The layer identifier.
* @return {ol.source.WMTSOptions} WMTS source options object.
* @todo stability experimental
*/
ol.source.WMTS.optionsFromCapabilities = function(wmtsCap, layer) {

View File

@@ -13,6 +13,7 @@ goog.require('ol.tilegrid.XYZ');
* @constructor
* @extends {ol.source.TileImage}
* @param {ol.source.XYZOptions} options XYZ options.
* @todo stability experimental
*/
ol.source.XYZ = function(options) {
@@ -67,6 +68,7 @@ ol.source.XYZ.prototype.setTileUrlFunction = function(tileUrlFunction) {
/**
* @param {string} url URL.
* @todo stability experimental
*/
ol.source.XYZ.prototype.setUrl = function(url) {
this.setTileUrlFunction(ol.TileUrlFunction.createFromTemplates(