Document ptarray_locate_point in header file

git-svn-id: http://svn.osgeo.org/postgis/trunk@5393 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/liblwgeom/liblwgeom.h b/liblwgeom/liblwgeom.h
index e8475380da6c6c91c909317f6e629c99cf3ad439..eba12b514444cd9b7fc6fe037fdad1e834d15739 100644 (file)
--- a/liblwgeom/liblwgeom.h
+++ b/liblwgeom/liblwgeom.h
@@ -1391,7 +1391,13 @@ extern void ptarray_reverse(POINTARRAY *pa);
 extern POINTARRAY* ptarray_flip_coordinates(POINTARRAY *pa);
 
 extern POINTARRAY *ptarray_substring(POINTARRAY *, double, double);
+
+/*
+ * Given a point, returns the location of closest point on pointarray
+ * as a fraction of total length (0: first point -- 1: last point)
+ */
 extern double ptarray_locate_point(POINTARRAY *, POINT2D *);
+
 extern void closest_point_on_segment(POINT2D *p, POINT2D *A, POINT2D *B, POINT2D *ret);
 extern LWLINE *lwline_measured_from_lwline(const LWLINE *lwline, double m_start, double m_end);
 extern LWMLINE* lwmline_measured_from_lwmline(const LWMLINE *lwmline, double m_start, double m_end);