Annotations for exports

This commit is contained in:
Tim Schaub
2014-04-08 13:40:35 -06:00
parent 457cfe851a
commit fb497f5288
243 changed files with 456 additions and 451 deletions

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.source.BingMaps
@exportProperty ol.source.BingMaps.TOS_ATTRIBUTION

View File

@@ -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: '<a class="ol-attribution-bing-tos" target="_blank" ' +

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.TileDebug

View File

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

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.GeoJSON

View File

@@ -11,6 +11,7 @@ goog.require('ol.source.StaticVector');
* @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
* @param {olx.source.GeoJSONOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.source.GeoJSON = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.GPX

View File

@@ -11,6 +11,7 @@ goog.require('ol.source.StaticVector');
* @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
* @param {olx.source.GPXOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.source.GPX = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.IGC

View File

@@ -11,6 +11,7 @@ goog.require('ol.source.StaticVector');
* @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
* @param {olx.source.IGCOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.source.IGC = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.ImageCanvas

View File

@@ -12,6 +12,7 @@ goog.require('ol.source.Image');
* @extends {ol.source.Image}
* @param {olx.source.ImageCanvasOptions} options
* @todo stability experimental
* @todo api
*/
ol.source.ImageCanvas = function(options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.ImageStatic

View File

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

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.source.ImageVector
@exportProperty ol.source.ImageVector.prototype.getSource

View File

@@ -30,6 +30,7 @@ goog.require('ol.vec.Mat4');
* @extends {ol.source.ImageCanvas}
* @param {olx.source.ImageVectorOptions} options Options.
* @todo stability experimental
* @todo api
*/
ol.source.ImageVector = function(options) {
@@ -165,7 +166,7 @@ ol.source.ImageVector.prototype.forEachFeatureAtPixel =
/**
* @return {ol.source.Vector} Source.
* @todo stability experimental
* @todo api
*/
ol.source.ImageVector.prototype.getSource = function() {
return this.source_;

View File

@@ -1,6 +0,0 @@
@exportSymbol ol.source.ImageWMS
@exportProperty ol.source.ImageWMS.prototype.getGetFeatureInfoUrl
@exportProperty ol.source.ImageWMS.prototype.getParams
@exportProperty ol.source.ImageWMS.prototype.getUrl
@exportProperty ol.source.ImageWMS.prototype.setUrl
@exportProperty ol.source.ImageWMS.prototype.updateParams

View File

@@ -20,6 +20,7 @@ goog.require('ol.source.wms.ServerType');
* @extends {ol.source.Image}
* @param {olx.source.ImageWMSOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.source.ImageWMS = function(opt_options) {
@@ -124,6 +125,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
*/
ol.source.ImageWMS.prototype.getGetFeatureInfoUrl =
function(coordinate, resolution, projection, params) {
@@ -173,6 +175,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
*/
ol.source.ImageWMS.prototype.getParams = function() {
return this.params_;
@@ -316,6 +319,7 @@ ol.source.ImageWMS.prototype.getRequestUrl_ =
* Return the URL used for this WMS source.
* @return {string|undefined} URL.
* @todo stability experimental
* @todo api
*/
ol.source.ImageWMS.prototype.getUrl = function() {
return this.url_;
@@ -324,6 +328,7 @@ ol.source.ImageWMS.prototype.getUrl = function() {
/**
* @param {string|undefined} url URL.
* @todo api
*/
ol.source.ImageWMS.prototype.setUrl = function(url) {
if (url != this.url_) {
@@ -337,6 +342,7 @@ ol.source.ImageWMS.prototype.setUrl = function(url) {
/**
* Update the user-provided params.
* @param {Object} params Params.
* @todo api
*/
ol.source.ImageWMS.prototype.updateParams = function(params) {
goog.object.extend(this.params_, params);

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.KML

View File

@@ -11,6 +11,7 @@ goog.require('ol.source.StaticVector');
* @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
* @param {olx.source.KMLOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.source.KML = function(opt_options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.MapGuide

View File

@@ -13,6 +13,7 @@ goog.require('ol.source.Image');
* @constructor
* @extends {ol.source.Image}
* @param {olx.source.MapGuideOptions} options Options.
* @todo api
*/
ol.source.MapGuide = function(options) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.MapQuest

View File

@@ -12,6 +12,7 @@ goog.require('ol.source.XYZ');
* @extends {ol.source.XYZ}
* @param {olx.source.MapQuestOptions=} opt_options MapQuest options.
* @todo stability experimental
* @todo api
*/
ol.source.MapQuest = function(opt_options) {

View File

@@ -1,3 +0,0 @@
@exportSymbol ol.source.OSM
@exportProperty ol.source.OSM.DATA_ATTRIBUTION
@exportProperty ol.source.OSM.TILE_ATTRIBUTION

View File

@@ -10,6 +10,7 @@ goog.require('ol.source.XYZ');
* @extends {ol.source.XYZ}
* @param {olx.source.OSMOptions=} opt_options Open Street Map options.
* @todo stability experimental
* @todo api
*/
ol.source.OSM = function(opt_options) {
@@ -45,6 +46,7 @@ goog.inherits(ol.source.OSM, ol.source.XYZ);
/**
* @const
* @type {ol.Attribution}
* @todo api
*/
ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution({
html: 'Data &copy; ' +
@@ -57,6 +59,7 @@ ol.source.OSM.DATA_ATTRIBUTION = new ol.Attribution({
/**
* @const
* @type {ol.Attribution}
* @todo api
*/
ol.source.OSM.TILE_ATTRIBUTION = new ol.Attribution({
html: 'Tiles &copy; ' +

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.OSMXML

View File

@@ -10,6 +10,7 @@ goog.require('ol.source.StaticVector');
* @extends {ol.source.StaticVector}
* @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
* @param {olx.source.OSMXMLOptions=} opt_options Options.
* @todo api
*/
ol.source.OSMXML = function(opt_options) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.source.ServerVector
@exportProperty ol.source.ServerVector.prototype.readFeatures

View File

@@ -13,6 +13,7 @@ goog.require('ol.structs.RBush');
* @constructor
* @extends {ol.source.FormatVector}
* @param {olx.source.ServerVectorOptions} options Options.
* @todo api
*/
ol.source.ServerVector = function(options) {
@@ -97,3 +98,12 @@ ol.source.ServerVector.prototype.loadFeatures =
}
}
};
/**
* @function
* @param {ArrayBuffer|Document|Node|Object|string} source Source.
* @return {Array.<ol.Feature>} Features.
* @todo api
*/
ol.source.ServerVector.prototype.readFeatures;

View File

@@ -1,2 +0,0 @@
@exportProperty ol.source.Source.prototype.getExtent
@exportProperty ol.source.Source.prototype.getState

View File

@@ -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_;

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.Stamen

View File

@@ -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) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.StaticVector

View File

@@ -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) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.TileImage

View File

@@ -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) {

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.TileJSON

View File

@@ -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) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.source.Tile
@exportProperty ol.source.Tile.prototype.getTileGrid

View File

@@ -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;

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.TileVector

View File

@@ -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) {

View File

@@ -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

View File

@@ -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.<string>|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);

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.TopoJSON

View File

@@ -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) {

View File

@@ -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

View File

@@ -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.<ol.Feature>} 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.<ol.Feature>} 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.<ol.Feature>} 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();

View File

@@ -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

View File

@@ -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) {

View File

@@ -1,2 +0,0 @@
@exportSymbol ol.source.XYZ
@exportProperty ol.source.XYZ.prototype.setUrl

View File

@@ -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(

View File

@@ -1 +0,0 @@
@exportSymbol ol.source.Zoomify

View File

@@ -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) {