From: Regina Obe <lr@pcorp.us>
Date: Sun, 25 Jan 2015 07:35:56 +0000 (+0000)
Subject: #3021 table to document the different error return types (was debating if this belong... 
X-Git-Tag: 2.2.0rc1~692
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=1bc4306cbf51cb20c68c5b059fae891d448c76ca;p=postgis

#3021 table to document the different error return types (was debating if this belongs in validatetopology_returntype, but guess better on VAlidateTopology page (and especially if the return type is reused by other functions)

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

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index df3e5eea6..e7cd62389 100644
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -110,6 +110,7 @@
                     <para><varname>id2</varname> is an integer: For errors that involve 2 objects denotes the secondary edge / or node</para>
                   </listitem>
                 </orderedlist>
+                
             </refsection>
 		  <!-- Optionally add a "See Also" section -->
             <refsection>
@@ -482,8 +483,65 @@ SELECT topology.AddTopoGeometryColumn('ri_topo', 'ri', 'roads', 'topo', 'LINE');
 			<refsection>
                 <title>Description</title>
             
-                <para>Returns a set of <xref linkend="validatetopology_returntype"/> objects detailing issues with topology. Refer to 
-                   <xref linkend="validatetopology_returntype"/> for listing of possible errors.</para>
+                <para>Returns a set of <xref linkend="validatetopology_returntype"/> objects detailing issues with topology. List of possible errors and what the returned ids represent are displayed below:</para>
+                   
+                  <informaltable rowsep="1" frame="all">
+                    <tgroup cols="3">
+                        <thead><row><entry>Error</entry><entry>id1</entry><entry>id2</entry></row></thead>
+                        <tbody>
+                            <row>
+                                    <entry>edge crosses node</entry>
+                                    <entry>node_id</entry>
+                                    <entry>edge_id # NOTE: should this be swapped?</entry>
+                            </row>
+                            <row>
+                                    <entry>invalid edge</entry>
+                                    <entry>edge_id</entry>
+                                    <entry>null</entry>
+                            </row>
+                            <row>
+                                    <entry>edge not simple</entry>
+                                    <entry>edge_id</entry>
+                                    <entry>null</entry>
+                            </row>
+                            <row>
+                                    <entry>edge crosses edge</entry>
+                                    <entry>edge_id</entry>
+                                    <entry>edge_id</entry>
+                            </row>
+                            <row>
+                                    <entry>edge start node geometry mis-match</entry>
+                                    <entry>edge_id</entry>
+                                    <entry>node_id</entry>
+                            </row>
+                            <row>
+                                    <entry>edge end node geometry mis-match</entry>
+                                    <entry>edge_id</entry>
+                                    <entry>node_id</entry>
+                            </row>
+                            <row>
+                                    <entry>face without edges</entry>
+                                    <entry>face_id</entry>
+                                    <entry>null</entry>
+                            </row>
+                            <row>
+                                    <entry>face has no rings</entry>
+                                    <entry>face_id</entry>
+                                    <entry>null</entry>
+                            </row>
+                            <row>
+                                    <entry>face overlaps face</entry>
+                                    <entry>face_id</entry>
+                                    <entry>face_id</entry>
+                            </row>
+                            <row>
+                                    <entry>face within face</entry>
+                                    <entry>inner face_id</entry>
+                                    <entry>outer face_id</entry>
+                            </row>
+                         </tbody>
+                        </tgroup>
+                    </informaltable>
         
                 <!-- use this format if new function -->
                 <para>Availability: 1.?</para>