Merge pull request #2614 from elemoine/tilegrid-stability

Add @api stable annotations tilegrid functions and options
This commit is contained in:
Éric Lemoine
2014-08-28 17:16:18 +02:00
3 changed files with 26 additions and 26 deletions

View File

@@ -34,7 +34,7 @@ ol.source.WMTSRequestEncoding = {
* @constructor
* @extends {ol.source.TileImage}
* @param {olx.source.WMTSOptions} options WMTS options.
* @api stable
* @api
*/
ol.source.WMTS = function(options) {
@@ -196,7 +196,7 @@ goog.inherits(ol.source.WMTS, ol.source.TileImage);
* "dimensions" option, and possibly updated using the updateDimensions
* method.
* @return {Object} Dimensions.
* @api stable
* @api
*/
ol.source.WMTS.prototype.getDimensions = function() {
return this.dimensions_;
@@ -227,7 +227,7 @@ ol.source.WMTS.prototype.resetCoordKeyPrefix_ = function() {
/**
* Update the dimensions.
* @param {Object} dimensions Dimensions.
* @api stable
* @api
*/
ol.source.WMTS.prototype.updateDimensions = function(dimensions) {
goog.object.extend(this.dimensions_, dimensions);

View File

@@ -25,7 +25,7 @@ goog.require('ol.tilecoord');
* @constructor
* @param {olx.tilegrid.TileGridOptions} options Tile grid options.
* @struct
* @api
* @api stable
*/
ol.tilegrid.TileGrid = function(options) {
@@ -154,7 +154,7 @@ ol.tilegrid.TileGrid.prototype.getMinZoom = function() {
/**
* @param {number} z Z.
* @return {ol.Coordinate} Origin.
* @api
* @api stable
*/
ol.tilegrid.TileGrid.prototype.getOrigin = function(z) {
if (!goog.isNull(this.origin_)) {
@@ -170,7 +170,7 @@ ol.tilegrid.TileGrid.prototype.getOrigin = function(z) {
/**
* @param {number} z Z.
* @return {number} Resolution.
* @api
* @api stable
*/
ol.tilegrid.TileGrid.prototype.getResolution = function(z) {
goog.asserts.assert(this.minZoom <= z && z <= this.maxZoom);
@@ -180,7 +180,7 @@ ol.tilegrid.TileGrid.prototype.getResolution = function(z) {
/**
* @return {Array.<number>} Resolutions.
* @api
* @api stable
*/
ol.tilegrid.TileGrid.prototype.getResolutions = function() {
return this.resolutions_;
@@ -369,7 +369,7 @@ ol.tilegrid.TileGrid.prototype.getTileCoordResolution = function(tileCoord) {
/**
* @param {number} z Z.
* @return {number} Tile size.
* @api
* @api stable
*/
ol.tilegrid.TileGrid.prototype.getTileSize = function(z) {
if (goog.isDef(this.tileSize_)) {