From aef73c981f5e37432c53bbe59f777a5e621a506c Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 20:59:52 +0200 Subject: [PATCH] Add basic docs for geom.circle --- src/ol/geom/circle.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/ol/geom/circle.js b/src/ol/geom/circle.js index ee6077c7e3..8d04d541c1 100644 --- a/src/ol/geom/circle.js +++ b/src/ol/geom/circle.js @@ -85,6 +85,7 @@ ol.geom.Circle.prototype.containsXY = function(x, y) { /** + * Return the center of the circle as {@link ol.Coordinate coordinate}. * @return {ol.Coordinate} Center. * @api */ @@ -107,6 +108,7 @@ ol.geom.Circle.prototype.computeExtent = function(extent) { /** + * Return the radius of the circle. * @return {number} Radius. * @api */ @@ -136,6 +138,7 @@ ol.geom.Circle.prototype.getType = function() { /** + * Set the center of the circle as {@link ol.Coordinate coordinate}. * @param {ol.Coordinate} center Center. * @api */ @@ -155,6 +158,8 @@ ol.geom.Circle.prototype.setCenter = function(center) { /** + * Set the center (as {@link ol.Coordinate coordinate}) and the radius (as + * number) of the circle. * @param {ol.Coordinate} center Center. * @param {number} radius Radius. * @param {ol.geom.GeometryLayout=} opt_layout Layout. @@ -196,7 +201,7 @@ ol.geom.Circle.prototype.setFlatCoordinates = /** - * The radius is in the units of the projection. + * Set the radius of the circle. The radius is in the units of the projection. * @param {number} radius Radius. * @api */