Merge pull request #2614 from elemoine/tilegrid-stability

Add @api stable annotations tilegrid functions and options

externs/olx.js

@@ -4811,7 +4811,7 @@ olx.source.WMTSOptions;
 /**
  * Attributions.
  * @type {Array.<ol.Attribution>|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.attributions;
 
@@ -4819,7 +4819,7 @@ olx.source.WMTSOptions.prototype.attributions;
 /**
  * crossOrigin setting for image requests.
  * @type {string|null|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.crossOrigin;
 
@@ -4827,7 +4827,7 @@ olx.source.WMTSOptions.prototype.crossOrigin;
 /**
  * Logo.
  * @type {string|olx.LogoOptions|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.logo;
 
@@ -4835,7 +4835,7 @@ olx.source.WMTSOptions.prototype.logo;
 /**
  * Tile grid.
  * @type {ol.tilegrid.WMTS}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.tileGrid;
 
@@ -4851,7 +4851,7 @@ olx.source.WMTSOptions.prototype.projection;
 /**
  * Request encoding.
  * @type {ol.source.WMTSRequestEncoding|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.requestEncoding;
 
@@ -4859,7 +4859,7 @@ olx.source.WMTSOptions.prototype.requestEncoding;
 /**
  * Layer.
  * @type {string}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.layer;
 
@@ -4867,7 +4867,7 @@ olx.source.WMTSOptions.prototype.layer;
 /**
  * Style.
  * @type {string}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.style;
 
@@ -4886,7 +4886,7 @@ olx.source.WMTSOptions.prototype.tilePixelRatio;
 /**
  * WMTS version. Default is `1.0.0`.
  * @type {string|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.version;
 
@@ -4894,7 +4894,7 @@ olx.source.WMTSOptions.prototype.version;
 /**
  * Image format. Default is `image/jpeg`.
  * @type {string|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.format;
 
@@ -4902,7 +4902,7 @@ olx.source.WMTSOptions.prototype.format;
 /**
  * Matrix set.
  * @type {string}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.matrixSet;
 
@@ -4910,7 +4910,7 @@ olx.source.WMTSOptions.prototype.matrixSet;
 /**
  * Dimensions.
  * @type {Object|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.dimensions;
 
@@ -4918,7 +4918,7 @@ olx.source.WMTSOptions.prototype.dimensions;
 /**
  * URL.
  * @type {string|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.url;
 
@@ -4942,7 +4942,7 @@ olx.source.WMTSOptions.prototype.tileLoadFunction;
 /**
  * Urls.
  * @type {Array.<string>|undefined}
- * @api stable
+ * @api
  */
 olx.source.WMTSOptions.prototype.urls;
 
@@ -5569,7 +5569,7 @@ olx.tilegrid.TileGridOptions.prototype.minZoom;
 /**
  * Origin. Default is null.
  * @type {ol.Coordinate|undefined}
- * @api
+ * @api stable
  */
 olx.tilegrid.TileGridOptions.prototype.origin;
 
@@ -5578,7 +5578,7 @@ olx.tilegrid.TileGridOptions.prototype.origin;
  * Origins. If given, the array should match the `resolutions` array, i.e.
  * each resolution can have a different origin.
  * @type {Array.<ol.Coordinate>|undefined}
- * @api
+ * @api stable
  */
 olx.tilegrid.TileGridOptions.prototype.origins;
 
@@ -5586,7 +5586,7 @@ olx.tilegrid.TileGridOptions.prototype.origins;
 /**
  * Resolutions.
  * @type {!Array.<number>}
- * @api
+ * @api stable
  */
 olx.tilegrid.TileGridOptions.prototype.resolutions;
 
@@ -5594,7 +5594,7 @@ olx.tilegrid.TileGridOptions.prototype.resolutions;
 /**
  * Tile size. Default is 256. (Only square tiles are supported.)
  * @type {number|undefined}
- * @api
+ * @api stable
  */
 olx.tilegrid.TileGridOptions.prototype.tileSize;
 
@@ -5603,7 +5603,7 @@ olx.tilegrid.TileGridOptions.prototype.tileSize;
  * Tile sizes. If given, the array should match the `resolutions` array, i.e.
  * each resolution can have a different tile size.
  * @type {Array.<number>|undefined}
- * @api
+ * @api stable
  */
 olx.tilegrid.TileGridOptions.prototype.tileSizes;
 

src/ol/source/wmtssource.js

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

src/ol/tilegrid/tilegrid.js

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