Document closest_point_on_segment in header file

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

diff --git a/liblwgeom/liblwgeom.h b/liblwgeom/liblwgeom.h
index eba12b514444cd9b7fc6fe037fdad1e834d15739..2c69fe132ee5580d0a8bf5deca47b11bd96249dd 100644 (file)
--- a/liblwgeom/liblwgeom.h
+++ b/liblwgeom/liblwgeom.h
@@ -1398,7 +1398,12 @@ extern POINTARRAY *ptarray_substring(POINTARRAY *, double, double);
  */
 extern double ptarray_locate_point(POINTARRAY *, POINT2D *);
 
-extern void closest_point_on_segment(POINT2D *p, POINT2D *A, POINT2D *B, POINT2D *ret);
+/*
+ * Write into *ret the coordinates of the closest point on
+ * segment A-B to the reference input point R
+ */
+extern void closest_point_on_segment(POINT2D *R, 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);