From: Sandro Santilli <strk@keybit.net>
Date: Fri, 27 May 2011 14:01:19 +0000 (+0000)
Subject: Document ST_AddEdgeModFace, tweak documentation of ST_AddEdgeNewFaces [RT-SIGTA]
X-Git-Tag: 2.0.0alpha1~1540
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=aeec5fd143096b35b1fb5415e2373d25b9bcdcd6;p=postgis

Document ST_AddEdgeModFace, tweak documentation of ST_AddEdgeNewFaces [RT-SIGTA]

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

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index 209cc0f07..d813d4124 100644
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -1602,13 +1602,17 @@ SELECT ST_AsText(topology.ST_GetFaceGeometry('ma_topo', 1)) As facegeomwkt;
                 <para>
 Add a new edge and, if in doing so it splits a face, delete the original
 face and replace it with two new faces.
+Returns the id of the newly added edge.
+		</para>
+
+                <para>
 Updates all existing joined edges and relationships accordingly.
 		</para>
+
                 <para>If any arguments are null, the given nodes are unknown (must already exist in the <varname>node</varname> table of the topology schema) ,
                     the <varname>acurve</varname> is not a <varname>LINESTRING</varname>, the <varname>anode</varname> and <varname>anothernode</varname> are not the start 
                     and endpoints of <varname>acurve</varname> then an error is thrown.</para>
                 <para>If the spatial reference system (srid) of the <varname>acurve</varname> geometry is not the same as the topology an exception is thrown.</para>
-                <note><para>This is not completely implemented yet and currently always throws a NOT YET IMPLEMENTED error</para></note>
 			
                 <!-- use this format if new function -->
                 <para>Availability: 2.0 </para>
@@ -1624,6 +1628,62 @@ Updates all existing joined edges and relationships accordingly.
 			<!-- Optionally add a "See Also" section -->
 			<refsection>
 				<title>See Also</title>
+				<para><xref linkend="ST_AddEdgeModFace"/></para>
+			</refsection>
+		</refentry>
+
+	    	  <refentry id="ST_AddEdgeModFace">
+			<refnamediv>
+				<refname>ST_AddEdgeModFace</refname>
+			
+				<refpurpose>Add a new edge and, if in doing so it splits a face, modify the original face and add a new face.</refpurpose>
+			</refnamediv>
+		
+			<refsynopsisdiv>
+				<funcsynopsis>
+					<funcprototype>
+					<funcdef>integer <function>ST_AddEdgeModFace</function></funcdef>
+					<paramdef><type>varchar </type> <parameter>atopology</parameter></paramdef>
+					<paramdef><type>integer </type> <parameter>anode</parameter></paramdef>
+					<paramdef><type>integer </type> <parameter>anothernode</parameter></paramdef>
+					<paramdef><type>geometry </type> <parameter>acurve</parameter></paramdef>
+					</funcprototype>
+				</funcsynopsis>
+			</refsynopsisdiv>
+		
+			<refsection>
+                <title>Description</title>
+            
+                <para>
+Add a new edge and, if in doing so it splits a face, modify the original
+face and add a new face. Unless the face being split is the Universal Face, 
+the new edge will be on the right side of the newly added edge.
+Returns the id of the newly added edge.
+		</para>
+
+                <para>
+Updates all existing joined edges and relationships accordingly.
+		</para>
+
+                <para>If any arguments are null, the given nodes are unknown (must already exist in the <varname>node</varname> table of the topology schema) ,
+                    the <varname>acurve</varname> is not a <varname>LINESTRING</varname>, the <varname>anode</varname> and <varname>anothernode</varname> are not the start 
+                    and endpoints of <varname>acurve</varname> then an error is thrown.</para>
+                <para>If the spatial reference system (srid) of the <varname>acurve</varname> geometry is not the same as the topology an exception is thrown.</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.13</para>
+			</refsection>
+		
+		
+			<refsection>
+				<title>Examples</title>
+				<!--TODO: Need examples -->
+			</refsection>
+		
+			<!-- Optionally add a "See Also" section -->
+			<refsection>
+				<title>See Also</title>
+				<para><xref linkend="ST_AddEdgeNewFaces"/></para>
 			</refsection>
 		</refentry>