Add basic docs for geom.circle

This commit is contained in:
Marc Jansen
2015-04-22 20:59:52 +02:00
parent 46e780d1ca
commit aef73c981f
+6 -1
View File
@@ -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. * @return {ol.Coordinate} Center.
* @api * @api
*/ */
@@ -107,6 +108,7 @@ ol.geom.Circle.prototype.computeExtent = function(extent) {
/** /**
* Return the radius of the circle.
* @return {number} Radius. * @return {number} Radius.
* @api * @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. * @param {ol.Coordinate} center Center.
* @api * @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 {ol.Coordinate} center Center.
* @param {number} radius Radius. * @param {number} radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @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. * @param {number} radius Radius.
* @api * @api
*/ */