Merge pull request #2641 from elemoine/sphere

Add @api to ol.Sphere
openlayers · Aug 29, 2014 · 5df0b4e · 5df0b4e
2 parents 91b5672 + f7f4c7b
commit 5df0b4e
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/examples/tissot.js b/examples/tissot.js
@@ -1,12 +1,12 @@
 goog.require('ol.Feature');
 goog.require('ol.Map');
+goog.require('ol.Sphere');
 goog.require('ol.View');
 goog.require('ol.geom.Polygon');
 goog.require('ol.layer.Tile');
 goog.require('ol.layer.Vector');
 goog.require('ol.source.TileWMS');
 goog.require('ol.source.Vector');
-goog.require('ol.sphere.WGS84');
 
 var vectorSource = new ol.source.Vector();
 
@@ -33,11 +33,12 @@ var map = new ol.Map({
   })
 });
 
+var wgs84Sphere = new ol.Sphere(6378137);
 
 var radius = 800000;
 for (var x = -180; x < 180; x += 30) {
   for (var y = -90; y < 90; y += 30) {
-    var circle = ol.geom.Polygon.circular(ol.sphere.WGS84, [x, y], radius, 64);
+    var circle = ol.geom.Polygon.circular(wgs84Sphere, [x, y], radius, 64);
     vectorSource.addFeature(new ol.Feature(circle));
   }
 }
diff --git a/src/ol/sphere/sphere.js b/src/ol/sphere/sphere.js
@@ -15,8 +15,20 @@ 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
  */
 ol.Sphere = function(radius) {
 

diff --git a/src/ol/sphere/wgs84sphere.js b/src/ol/sphere/wgs84sphere.js
@@ -7,6 +7,5 @@ goog.require('ol.Sphere');
  * A sphere with radius equal to the semi-major axis of the WGS84 ellipsoid.
  * @const
  * @type {ol.Sphere}
- * @api
  */
 ol.sphere.WGS84 = new ol.Sphere(6378137);