Add basic docs for geom.geometry

2015-04-22 21:00:05 +02:00
parent aef73c981f
commit 6637bf0f21
1 changed files with 2 additions and 0 deletions
--- a/src/ol/geom/geometry.js
+++ b/src/ol/geom/geometry.js
@@ -112,6 +112,8 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod;


 /**
+ * Return the closest point of the geometry to the passed point as
+ * {@link ol.Coordinate coordinate}.
 * @param {ol.Coordinate} point Point.
 * @param {ol.Coordinate=} opt_closestPoint Closest point.
 * @return {ol.Coordinate} Closest point.