From: Sandro Santilli <strk@keybit.net>
Date: Sat, 9 Jul 2011 15:55:25 +0000 (+0000)
Subject: Clarify return code from topology.ST_ModEdgeHeal. Clean up description of ST_NewEdgeH... 
X-Git-Tag: 2.0.0alpha1~1218
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7d6114d11d224b9d81bb3fee063041ec4f7e0a9b;p=postgis

Clarify return code from topology.ST_ModEdgeHeal. Clean up description of ST_NewEdgeHeal too.

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

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index 8fb3c0a11..bfc7d07af 100644
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -1816,14 +1816,14 @@ SELECT topology.ST_ModEdgeSplit('ma_topo',  3, ST_SetSRID(ST_Point(227594,893910
 			
 				<refpurpose>
 Heal two edges by deleting the node connecting them, modifying the first edge
-and deleting the second edge.
+and deleting the second edge. Returns the id of the deleted node.
 				</refpurpose>
 			</refnamediv>
 		
 			<refsynopsisdiv>
 				<funcsynopsis>
 					<funcprototype>
-					<funcdef>text <function>ST_ModEdgeHeal</function></funcdef>
+					<funcdef>int <function>ST_ModEdgeHeal</function></funcdef>
 					<paramdef><type>varchar </type> <parameter>atopology</parameter></paramdef>
 					<paramdef><type>integer </type> <parameter>anedge</parameter></paramdef>
 					<paramdef><type>integer </type> <parameter>anotheredge</parameter></paramdef>
@@ -1837,11 +1837,10 @@ and deleting the second edge.
                 <para>
 Heal two edges by deleting the node connecting them, modifying the first edge
 and deleting the second edge.
-Returns the id of the node created that joins the new edges.
+Returns the id of the deleted node.
 Updates all existing joined edges and relationships accordingly.
 		</para>
-              
-			
+
                 <!-- use this format if new function -->
                 <para>Availability: 2.0</para>
                 <para>&sqlmm_compliant; SQL-MM: Topo-Geo and Topo-Net 3: Routine Details:  X.3.9</para>
@@ -1872,7 +1871,7 @@ edge provided.
 			<refsynopsisdiv>
 				<funcsynopsis>
 					<funcprototype>
-					<funcdef>text <function>ST_NewEdgeHeal</function></funcdef>
+					<funcdef>int <function>ST_NewEdgeHeal</function></funcdef>
 					<paramdef><type>varchar </type> <parameter>atopology</parameter></paramdef>
 					<paramdef><type>integer </type> <parameter>anedge</parameter></paramdef>
 					<paramdef><type>integer </type> <parameter>anotheredge</parameter></paramdef>