From: Sandro Santilli <strk@keybit.net>
Date: Mon, 4 Jul 2011 12:29:31 +0000 (+0000)
Subject: Document memory management of lwdoubles_to_latlon and lwpoint_to_latlon
X-Git-Tag: 2.0.0alpha1~1265
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d4c4cf4d06a439ba68fbc86b7b2031336e9e961c;p=postgis

Document memory management of lwdoubles_to_latlon and lwpoint_to_latlon

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

diff --git a/liblwgeom/lwprint.c b/liblwgeom/lwprint.c
index 3e5179d47..dcf47679d 100644
--- a/liblwgeom/lwprint.c
+++ b/liblwgeom/lwprint.c
@@ -358,7 +358,9 @@ static char * lwdouble_to_dms(double val, const char *pos_dir_symbol, const char
 /* Print two doubles (lat and lon) in DMS form using the specified format.
  * First normalizes them so they will display as -90 to 90 and -180 to 180.
  * Format string may be null or 0-length, in which case a default format will be used.
- * NOTE: Format string is required to be in UTF-8. */
+ * NOTE: Format string is required to be in UTF-8.
+ * NOTE2: returned string is lwalloc'ed, caller is responsible to lwfree it up
+ */
 static char * lwdoubles_to_latlon(double lat, double lon, const char * format)
 {
 	char * lat_text;
@@ -383,7 +385,9 @@ static char * lwdoubles_to_latlon(double lat, double lon, const char * format)
  * the specified format.
  * First normalizes the values so they will display as -90 to 90 and -180 to 180.
  * Format string may be null or 0-length, in which case a default format will be used.
- * NOTE: Format string is required to be in UTF-8. */
+ * NOTE: Format string is required to be in UTF-8.
+ * NOTE2: returned string is lwalloc'ed, caller is responsible to lwfree it up
+ */
 char* lwpoint_to_latlon(const LWPOINT * pt, const char *format)
 {
 	POINT2D p;