Document topology.polygonize(<toponame>)

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

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index ead3c4a92101baa9b083265942b83fa49bc16a59..dcabad886cc4e45cb9b46d553b35fefa9b521042 100644 (file)
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -763,6 +763,38 @@ faceid
                                <para><xref linkend="AddEdge"/>, <xref linkend="CreateTopology"/>, <xref linkend="spatial_ref_sys"/></para>
                        </refsection>
                </refentry>
+
+               <refentry id="TopologyPolygonize">
+                       <refnamediv>
+                               <refname>Polygonize</refname>
+                               <refpurpose>Find and register all faces defined by topology edges</refpurpose>
+                       </refnamediv>
+                       <refsynopsisdiv>
+                               <funcsynopsis>
+                                       <funcprototype>
+                                       <funcdef>text <function>Polygonize</function></funcdef>
+                                       <paramdef><type>varchar </type> <parameter>toponame</parameter></paramdef>
+                                       </funcprototype>
+                               </funcsynopsis>
+                       </refsynopsisdiv>
+               
+                       <refsection>
+                <title>Description</title>
+            
+                <para>Register all faces that can be built out a topology edge primitives.</para>
+                <para>The target topology is assumed to contain no self-intersecting edges.</para>
+                <note><para>Already known faces are recognized, so it is safe to call Polygonize multiple times on the same topology.</para></note>
+                
+                <!-- use this format if new function -->
+                <para>Availability: 2.0.0</para>
+                       </refsection>
+               
+                       <!-- Optionally add a "See Also" section -->
+                       <refsection>
+                               <title>See Also</title>
+                               <para><xref linkend="AddFace"/>, <xref linkend="ST_Polygonize"/></para>
+                       </refsection>
+               </refentry>
                
                <refentry id="AddNode">
                        <refnamediv>