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

View File

@@ -22,7 +22,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.LineString = function(coordinates, opt_layout) {
@@ -61,7 +61,7 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry);
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @todo api
* @api
*/
ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
goog.asserts.assert(coordinate.length == this.stride);
@@ -76,7 +76,7 @@ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.LineString.prototype.clone = function() {
var lineString = new ol.geom.LineString(null);
@@ -117,7 +117,7 @@ ol.geom.LineString.prototype.closestPointXY =
* @param {number} m M.
* @param {boolean=} opt_extrapolate Extrapolate.
* @return {ol.Coordinate} Coordinate.
* @todo api
* @api
*/
ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
if (this.layout != ol.geom.GeometryLayout.XYM &&
@@ -132,7 +132,7 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
/**
* @return {ol.geom.RawLineString} Coordinates.
* @todo api
* @api
*/
ol.geom.LineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates(
@@ -142,7 +142,7 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/**
* @return {number} Length.
* @todo api
* @api
*/
ol.geom.LineString.prototype.getLength = function() {
return ol.geom.flat.length.lineString(
@@ -182,7 +182,7 @@ ol.geom.LineString.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.LineString.prototype.getType = function() {
return ol.geom.GeometryType.LINE_STRING;
@@ -192,7 +192,7 @@ ol.geom.LineString.prototype.getType = function() {
/**
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.LineString.prototype.setCoordinates =
function(coordinates, opt_layout) {