From f452f5545a8f971e019751dca2d413cfe5f465f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Lemoine?= Date: Fri, 29 Aug 2014 11:37:26 +0200 Subject: [PATCH] Add @classdesc to ol.Sphere --- src/ol/sphere/sphere.js | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/ol/sphere/sphere.js b/src/ol/sphere/sphere.js index a3b4799efc..96a7b68c2b 100644 --- a/src/ol/sphere/sphere.js +++ b/src/ol/sphere/sphere.js @@ -15,6 +15,17 @@ goog.require('goog.math'); /** + * @classdesc + * Class to create objects that can be used with {@link + * ol.geom.Polygon.circular}. + * + * For example to create a sphere whose radius is equal to the semi-major + * axis of the WGS84 ellipsoid: + * + * ```js + * var wgs84Sphere= new ol.Sphere(6378137); + * ``` + * * @constructor * @param {number} radius Radius. * @api