Add @classdesc to ol.Sphere

2014-08-29 11:37:26 +02:00
parent 40fb661864
commit f452f5545a
1 changed files with 11 additions and 0 deletions
--- 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