ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Use @api annotation instead of @todo api

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

20
src/ol/coordinate.js
View File

@@ -11,7 +11,7 @@ goog.require('goog.math');
* `{string}`.
*
* @typedef {function((ol.Coordinate|undefined)): string}
* @todo api
* @api
*/
ol.CoordinateFormatType;
@@ -19,7 +19,7 @@ ol.CoordinateFormatType;
/**
* An array of numbers representing an xy coordinate. Example: `[16, 48]`.
* @typedef {Array.<number>} ol.Coordinate
* @todo api
* @api
*/
ol.Coordinate;
@@ -27,7 +27,7 @@ ol.Coordinate;
/**
* An array of coordinate arrays.
* @typedef {Array.<ol.Coordinate>}
* @todo api
* @api
*/
ol.CoordinateArray;
@@ -39,7 +39,7 @@ ol.CoordinateArray;
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate.
* @todo api
* @api
*/
ol.coordinate.add = function(coordinate, delta) {
coordinate[0] += delta[0];
@@ -91,7 +91,7 @@ ol.coordinate.closestOnSegment = function(coordinate, segment) {
* @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`.
* @return {ol.CoordinateFormatType} Coordinate format.
* @todo api
* @api
*/
ol.coordinate.createStringXY = function(opt_fractionDigits) {
return (
@@ -128,7 +128,7 @@ ol.coordinate.degreesToStringHDMS_ = function(degrees, hemispheres) {
* @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`.
* @return {string} Formated coordinate.
* @todo api
* @api
*/
ol.coordinate.format = function(coordinate, template, opt_fractionDigits) {
if (goog.isDef(coordinate)) {
@@ -165,7 +165,7 @@ ol.coordinate.equals = function(coordinate1, coordinate2) {
* @param {ol.Coordinate} coordinate Coordinate.
* @param {number} angle Angle in radian.
* @return {ol.Coordinate} Coordinate.
* @todo api
* @api
*/
ol.coordinate.rotate = function(coordinate, angle) {
var cosAngle = Math.cos(angle);
@@ -236,7 +236,7 @@ ol.coordinate.squaredDistanceToSegment = function(coordinate, segment) {
/**
* @param {ol.Coordinate|undefined} coordinate Coordinate.
* @return {string} Hemisphere, degrees, minutes and seconds.
* @todo api
* @api
*/
ol.coordinate.toStringHDMS = function(coordinate) {
if (goog.isDef(coordinate)) {
@@ -253,7 +253,7 @@ ol.coordinate.toStringHDMS = function(coordinate) {
* @param {number=} opt_fractionDigits The number of digits to include
* after the decimal point. Default is `0`.
* @return {string} XY.
* @todo api
* @api
*/
ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
return ol.coordinate.format(coordinate, '{x}, {y}', opt_fractionDigits);
@@ -265,7 +265,7 @@ ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
* @param {Array} array The array with coordinates.
* @param {string} axis the axis info.
* @return {ol.Coordinate} The coordinate created.
* @todo api
* @api
*/
ol.coordinate.fromProjectedArray = function(array, axis) {
var firstAxis = axis.charAt(0);