Merge pull request #2641 from elemoine/sphere

Add @api to ol.Sphere
This commit is contained in:
Éric Lemoine
2014-08-29 12:10:00 +02:00
3 changed files with 15 additions and 3 deletions

View File

@@ -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) {

View File

@@ -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);