From 122b535393bbf88ff563590ee9950e03c54a2c53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Wed, 17 Sep 2014 18:21:39 +0200 Subject: [PATCH] Better docs for ol.Sphere#offset --- src/ol/sphere/sphere.js | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/ol/sphere/sphere.js b/src/ol/sphere/sphere.js index 96a7b68c2b..7dd37905d8 100644 --- a/src/ol/sphere/sphere.js +++ b/src/ol/sphere/sphere.js @@ -214,12 +214,13 @@ ol.Sphere.prototype.midpoint = function(c1, c2) { /** - * Returns the coordinate at the given distance and bearing from c. + * Returns the coordinate at the given distance and bearing from `c1`. * - * @param {ol.Coordinate} c1 Coordinate. - * @param {number} distance Distance. - * @param {number} bearing Bearing. - * @return {ol.Coordinate} Coordinate. + * @param {ol.Coordinate} c1 The origin point (`[lon, lat]` in degrees). + * @param {number} distance The great-circle distance between the origin + * point and the target point. + * @param {number} bearing The bearing (in radians). + * @return {ol.Coordinate} The target point. */ ol.Sphere.prototype.offset = function(c1, distance, bearing) { var lat1 = goog.math.toRadians(c1[1]);