From: Sandro Santilli <strk@keybit.net>
Date: Wed, 10 Feb 2010 20:54:08 +0000 (+0000)
Subject: Enhance documentation of ptarray_addPoint [RT-SIGTA]
X-Git-Tag: 2.0.0alpha1~3261
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=14bb1c251b847c711c98b4c7a6cb1f43d7d30add;p=postgis

Enhance documentation of ptarray_addPoint [RT-SIGTA]

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

diff --git a/liblwgeom/ptarray.c b/liblwgeom/ptarray.c
index 097d00fe3..5b71462c9 100644
--- a/liblwgeom/ptarray.c
+++ b/liblwgeom/ptarray.c
@@ -248,8 +248,14 @@ ptarray_same(const POINTARRAY *pa1, const POINTARRAY *pa2)
 
 /**
  * @brief Add a point in a pointarray.
- * 		'where' is the offset (starting at 0)
- * 		if 'where' == pa->npoints,  append is performed.
+ *
+ * @param pa the source POINTARRAY 
+ * @param p the point to add
+ * @param pdims number of ordinates in p (2..4)
+ * @param where to insert the point. 0 prepends, pa->npoints appends
+ *
+ * @returns a newly constructed POINTARRAY using a newly allocated buffer
+ *          for the actual points, or NULL on error. 
  */
 POINTARRAY *
 ptarray_addPoint(const POINTARRAY *pa, uchar *p, size_t pdims, unsigned int where)