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
+14 -14
View File
@@ -12,7 +12,7 @@ goog.require('ol.proj');
* `'Polygon'`, `'MultiPoint'`, `'MultiLineString'`, `'MultiPolygon'`,
* `'GeometryCollection'`, `'Circle'`.
* @enum {string}
* @todo api
* @api
*/
ol.geom.GeometryType = {
POINT: 'Point',
@@ -32,7 +32,7 @@ ol.geom.GeometryType = {
* or measure ('M') coordinate is available. Supported values are `'XY'`,
* `'XYZ'`, `'XYM'`, `'XYZM'`.
* @enum {string}
* @todo api
* @api
*/
ol.geom.GeometryLayout = {
XY: 'XY',
@@ -52,7 +52,7 @@ ol.geom.GeometryLayout = {
* @constructor
* @extends {ol.Observable}
* @fires change Triggered when the geometry changes.
* @todo api
* @api
*/
ol.geom.Geometry = function() {
@@ -113,7 +113,7 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod;
* @param {ol.Coordinate} point Point.
* @param {ol.Coordinate=} opt_closestPoint Closest point.
* @return {ol.Coordinate} Closest point.
* @todo api
* @api
*/
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
var closestPoint = goog.isDef(opt_closestPoint) ?
@@ -145,7 +145,7 @@ ol.geom.Geometry.prototype.containsXY = goog.functions.FALSE;
* @function
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent.
* @todo api
* @api
*/
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -171,7 +171,7 @@ ol.geom.Geometry.prototype.getType = goog.abstractMethod;
* then use this function on the clone.
* @function
* @param {ol.TransformFunction} transformFn Transform.
* @todo api
* @api
*/
ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod;
@@ -188,7 +188,7 @@ ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod;
* string identifier or a {@link ol.proj.Projection} object.
* @return {ol.geom.Geometry} This geometry. Note that original geometry is
* modified in place.
* @todo api
* @api
*/
ol.geom.Geometry.prototype.transform = function(source, destination) {
this.applyTransform(ol.proj.getTransform(source, destination));
@@ -199,7 +199,7 @@ ol.geom.Geometry.prototype.transform = function(source, destination) {
/**
* Array representation of a point. Example: `[16, 48]`.
* @typedef {ol.Coordinate}
* @todo api
* @api
*/
ol.geom.RawPoint;
@@ -207,7 +207,7 @@ ol.geom.RawPoint;
/**
* Array representation of a linestring.
* @typedef {Array.<ol.Coordinate>}
* @todo api
* @api
*/
ol.geom.RawLineString;
@@ -215,7 +215,7 @@ ol.geom.RawLineString;
/**
* Array representation of a linear ring.
* @typedef {Array.<ol.Coordinate>}
* @todo api
* @api
*/
ol.geom.RawLinearRing;
@@ -223,7 +223,7 @@ ol.geom.RawLinearRing;
/**
* Array representation of a polygon.
* @typedef {Array.<ol.geom.RawLinearRing>}
* @todo api
* @api
*/
ol.geom.RawPolygon;
@@ -231,7 +231,7 @@ ol.geom.RawPolygon;
/**
* Array representation of a multipoint.
* @typedef {Array.<ol.geom.RawPoint>}
* @todo api
* @api
*/
ol.geom.RawMultiPoint;
@@ -239,7 +239,7 @@ ol.geom.RawMultiPoint;
/**
* Array representation of a multilinestring.
* @typedef {Array.<ol.geom.RawLineString>}
* @todo api
* @api
*/
ol.geom.RawMultiLineString;
@@ -247,6 +247,6 @@ ol.geom.RawMultiLineString;
/**
* Array representation of a multipolygon.
* @typedef {Array.<ol.geom.RawPolygon>}
* @todo api
* @api
*/
ol.geom.RawMultiPolygon;