ST_AddEdgeNewFaces - still need to put in an example

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

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index 09906ee9c3435bcfc2b863f107947500fe3d08e1..51088b9d2ea090293e831a250fce6a43af71a506 100644 (file)
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -1238,6 +1238,49 @@ SELECT ST_AsText(topology.ST_GetFaceGeometry('ma_topo', 1)) As facegeomwkt;
             </abstract>
         </sect1info>
                  <title>Topology Processing Functions</title>
+                 <refentry id="ST_AddEdgeNewFaces">
+                       <refnamediv>
+                               <refname>ST_AddEdgeNewFaces</refname>
+                       
+                               <refpurpose>Add a new edge and, if in doing so it splits a face, delete the original face and replace it with two new faces.</refpurpose>
+                       </refnamediv>
+               
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                       <funcprototype>
+                                       <funcdef>integer <function>ST_AddEdgeNewFaces</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, delete the original face and replace it with two new faces.</para>
+                <para>If any arguments are null (meaning the nodes 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: 1.? </para>
+                       <para>&sqlmm_compliant; SQL-MM: Topo-Geo and Topo-Net 3: Routine Details:  X.3.12</para>
+                       </refsection>
+               
+               
+                       <refsection>
+                               <title>Examples</title>
+                               <!--TODO: Need examples -->
+                       </refsection>
+               
+                       <!-- Optionally add a "See Also" section -->
+                       <refsection>
+                               <title>See Also</title>
+                       </refsection>
+               </refentry>
                  <refentry id="ST_MoveIsoNode">
                        <refnamediv>
                                <refname>ST_MoveIsoNode</refname>