From 8d991bd638f1d496a524f20430c0d494902e114c Mon Sep 17 00:00:00 2001 From: Paul Spencer Date: Mon, 9 Jun 2014 08:51:20 -0400 Subject: [PATCH] Add @todo API and describe ol.geom.Geometry funcs The `clone()`, `getSimplifiedGeometry()` and `getType()` methods are all base class methods documented in subclasses. They should appear in ol.geom.Geometry in the API docs as well. --- src/ol/geom/geometry.js | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/ol/geom/geometry.js b/src/ol/geom/geometry.js index d814ef0336..743fb62951 100644 --- a/src/ol/geom/geometry.js +++ b/src/ol/geom/geometry.js @@ -93,8 +93,10 @@ goog.inherits(ol.geom.Geometry, ol.Observable); /** + * Make a complete copy of the geometry. * @function * @return {ol.geom.Geometry} Clone. + * @api */ ol.geom.Geometry.prototype.clone = goog.abstractMethod; @@ -151,16 +153,22 @@ ol.geom.Geometry.prototype.getExtent = goog.abstractMethod; /** + * Create a simplified version of this geometry using the Douglas Peucker + * algorithm. + * @see http://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm * @function * @param {number} squaredTolerance Squared tolerance. * @return {ol.geom.Geometry} Simplified geometry. + * @api */ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod; /** + * Get the type of this geometry. * @function * @return {ol.geom.GeometryType} Geometry type. + * @api */ ol.geom.Geometry.prototype.getType = goog.abstractMethod;