Annotations for exports

This commit is contained in:
Tim Schaub
2014-04-08 13:40:35 -06:00
parent 457cfe851a
commit fb497f5288
243 changed files with 456 additions and 451 deletions

View File

@@ -36,6 +36,7 @@ ol.CoordinateArray;
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate.
* @todo api
*/
ol.coordinate.add = function(coordinate, delta) {
coordinate[0] += delta[0];
@@ -88,6 +89,7 @@ ol.coordinate.closestOnSegment = function(coordinate, segment) {
* after the decimal point. Default is `0`.
* @return {ol.CoordinateFormatType} Coordinate format.
* @todo stability experimental
* @todo api
*/
ol.coordinate.createStringXY = function(opt_fractionDigits) {
return (
@@ -125,6 +127,7 @@ ol.coordinate.degreesToStringHDMS_ = function(degrees, hemispheres) {
* after the decimal point. Default is `0`.
* @return {string} Formated coordinate.
* @todo stability experimental
* @todo api
*/
ol.coordinate.format = function(coordinate, template, opt_fractionDigits) {
if (goog.isDef(coordinate)) {
@@ -158,6 +161,7 @@ ol.coordinate.equals = function(coordinate1, coordinate2) {
* @param {ol.Coordinate} coordinate Coordinate.
* @param {number} angle Angle.
* @return {ol.Coordinate} Coordinate.
* @todo api
*/
ol.coordinate.rotate = function(coordinate, angle) {
var cosAngle = Math.cos(angle);
@@ -223,6 +227,7 @@ ol.coordinate.squaredDistanceToSegment = function(coordinate, segment) {
* @param {ol.Coordinate|undefined} coordinate Coordinate.
* @return {string} Hemisphere, degrees, minutes and seconds.
* @todo stability experimental
* @todo api
*/
ol.coordinate.toStringHDMS = function(coordinate) {
if (goog.isDef(coordinate)) {
@@ -240,6 +245,7 @@ ol.coordinate.toStringHDMS = function(coordinate) {
* after the decimal point. Default is `0`.
* @return {string} XY.
* @todo stability experimental
* @todo api
*/
ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
return ol.coordinate.format(coordinate, '{x}, {y}', opt_fractionDigits);
@@ -252,6 +258,7 @@ ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
* @param {string} axis the axis info.
* @return {ol.Coordinate} The coordinate created.
* @todo stability experimental
* @todo api
*/
ol.coordinate.fromProjectedArray = function(array, axis) {
var firstAxis = axis.charAt(0);