From: Regina Obe <lr@pcorp.us>
Date: Thu, 23 Aug 2012 06:31:42 +0000 (+0000)
Subject: document ST_Segmentize new geography function.  Will provide example later.
X-Git-Tag: 2.1.0beta2~688
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=393ce429828c6041523e05e9e92917f45891f989;p=postgis

document ST_Segmentize new geography function.  Will provide example later.

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

diff --git a/doc/reference_editor.xml b/doc/reference_editor.xml
index 5edbf6178..87a179de8 100644
--- a/doc/reference_editor.xml
+++ b/doc/reference_editor.xml
@@ -1218,17 +1218,22 @@ SELECT ST_AsEWKT(ST_Scale(ST_GeomFromEWKT('LINESTRING(1 2 3, 1 1 1)'), 0.5, 0.75
 		<refnamediv>
 			<refname>ST_Segmentize</refname>
 
-			<refpurpose>Return a modified geometry having no segment longer than the
+			<refpurpose>Return a modified geometry/geography having no segment longer than the
 			given distance.  Distance computation is performed in 2d
-			only.</refpurpose>
+			only. For geometry, length units are in units of spatial reference.  For geography, units are in meters.</refpurpose>
 		</refnamediv>
 
 		<refsynopsisdiv>
 			<funcsynopsis>
 			  <funcprototype>
 				<funcdef>geometry <function>ST_Segmentize</function></funcdef>
-				<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
-				<paramdef><type>float </type> <parameter>max_length</parameter></paramdef>
+				<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
+				<paramdef><type>float </type> <parameter>max_segment_length</parameter></paramdef>
+			  </funcprototype>
+			  <funcprototype>
+				<funcdef>geometry <function>ST_Segmentize</function></funcdef>
+				<paramdef><type>geography </type> <parameter>geog</parameter></paramdef>
+				<paramdef><type>float </type> <parameter>max_segment_length</parameter></paramdef>
 			  </funcprototype>
 			</funcsynopsis>
 		</refsynopsisdiv>
@@ -1237,9 +1242,10 @@ SELECT ST_AsEWKT(ST_Scale(ST_GeomFromEWKT('LINESTRING(1 2 3, 1 1 1)'), 0.5, 0.75
 			<title>Description</title>
 
 			<para>Returns a modified geometry having no segment longer than the
-			given distance. Distance computation is performed in 2d
-			only. </para>
+			given <varname>max_segment_length</varname>.  Distance computation is performed in 2d
+			only. For geometry, length units are in units of spatial reference.  For geography, units are in meters.</para>
 			<para>Availability: 1.2.2</para>
+			<para>Enhanced: 2.1.0 support for geography was introduced.</para>
 			<note><para>This will only increase segments.  It will not lengthen segments shorter than
 			max length</para></note>
 		</refsection>