Use @api annotation instead of @todo api

This commit is contained in:
Tim Schaub
2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions
+6 -6
View File
@@ -22,7 +22,7 @@ goog.require('ol.proj.Units');
* @constructor
* @param {olx.tilegrid.TileGridOptions} options Tile grid options.
* @struct
* @todo api
* @api
*/
ol.tilegrid.TileGrid = function(options) {
@@ -140,7 +140,7 @@ ol.tilegrid.TileGrid.prototype.getMaxZoom = function() {
/**
* @return {number} Min zoom.
* @todo api
* @api
*/
ol.tilegrid.TileGrid.prototype.getMinZoom = function() {
return this.minZoom;
@@ -150,7 +150,7 @@ ol.tilegrid.TileGrid.prototype.getMinZoom = function() {
/**
* @param {number} z Z.
* @return {ol.Coordinate} Origin.
* @todo api
* @api
*/
ol.tilegrid.TileGrid.prototype.getOrigin = function(z) {
if (!goog.isNull(this.origin_)) {
@@ -166,7 +166,7 @@ ol.tilegrid.TileGrid.prototype.getOrigin = function(z) {
/**
* @param {number} z Z.
* @return {number} Resolution.
* @todo api
* @api
*/
ol.tilegrid.TileGrid.prototype.getResolution = function(z) {
goog.asserts.assert(this.minZoom <= z && z <= this.maxZoom);
@@ -176,7 +176,7 @@ ol.tilegrid.TileGrid.prototype.getResolution = function(z) {
/**
* @return {Array.<number>} Resolutions.
* @todo api
* @api
*/
ol.tilegrid.TileGrid.prototype.getResolutions = function() {
return this.resolutions_;
@@ -365,7 +365,7 @@ ol.tilegrid.TileGrid.prototype.getTileCoordResolution = function(tileCoord) {
/**
* @param {number} z Z.
* @return {number} Tile size.
* @todo api
* @api
*/
ol.tilegrid.TileGrid.prototype.getTileSize = function(z) {
if (goog.isDef(this.tileSize_)) {
+2 -2
View File
@@ -15,7 +15,7 @@ goog.require('ol.tilegrid.TileGrid');
* @extends {ol.tilegrid.TileGrid}
* @param {olx.tilegrid.WMTSOptions} options WMTS options.
* @struct
* @todo api
* @api
*/
ol.tilegrid.WMTS = function(options) {
@@ -53,7 +53,7 @@ ol.tilegrid.WMTS.prototype.getMatrixId = function(z) {
/**
* @return {Array.<string>} MatrixIds.
* @todo api
* @api
*/
ol.tilegrid.WMTS.prototype.getMatrixIds = function() {
return this.matrixIds_;
+1 -1
View File
@@ -18,7 +18,7 @@ goog.require('ol.tilegrid.TileGrid');
* @extends {ol.tilegrid.TileGrid}
* @param {olx.tilegrid.XYZOptions} options XYZ options.
* @struct
* @todo api
* @api
*/
ol.tilegrid.XYZ = function(options) {
+1 -1
View File
@@ -14,7 +14,7 @@ goog.require('ol.tilegrid.TileGrid');
* @constructor
* @extends {ol.tilegrid.TileGrid}
* @param {olx.tilegrid.ZoomifyOptions=} opt_options Options.
* @todo api
* @api
*/
ol.tilegrid.Zoomify = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : options;