From: Sandro Santilli <strk@keybit.net>
Date: Tue, 3 May 2011 16:56:10 +0000 (+0000)
Subject: Add examples of ST_GetFaceEdges
X-Git-Tag: 2.0.0alpha1~1723
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7c095ba74d94987955a7eac7e3cb61ce6f83d78e;p=postgis

Add examples of ST_GetFaceEdges

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

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index b8f4a3811..0c16b9aa3 100644
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -1438,7 +1438,7 @@ ERROR:  Two or more faces found</programlisting>
 			<refnamediv>
 				<refname>ST_GetFaceEdges</refname>
 			
-				<refpurpose>NOT YET IMPLEMENTED: Returns a set of ordered edges that bound <varname>aface</varname> includes the sequence order.</refpurpose>
+				<refpurpose>Returns a set of ordered edges that bound <varname>aface</varname> includes the sequence order.</refpurpose>
 			</refnamediv>
 		
 			<refsynopsisdiv>
@@ -1455,10 +1455,8 @@ ERROR:  Two or more faces found</programlisting>
                 <title>Description</title>
             
                 <para>Returns a set of ordered edges that bound <varname>aface</varname> includes the sequence order.  Each output consists of a sequence and edgeid</para>
-                <note><para>This is currently a stub function and not yet implemented.  Will either throw a NOT YET IMPLEMENTED message or SQL/MM if no topology or face is passed in.</para></note>
-                
                 <!-- use this format if new function -->
-                <para>Availability: Not yet implemented </para>
+                <para>Availability: 2.0 </para>
                 	<para>&sqlmm_compliant; SQL-MM 3 Topo-Geo and Topo-Net 3: Routine Details: X.3.5</para>
 			</refsection>
 		
@@ -1466,7 +1464,19 @@ ERROR:  Two or more faces found</programlisting>
 			<refsection>
 				<title>Examples</title>
 				<programlisting>
-<!-- TODO once implemented -->
+-- Returns the edges bounding face 1
+SELECT (topology.ST_GetFaceEdges('tt', 1)).*;
+-- result --
+ sequence | edge
+----------+------
+        1 |    5
+        2 |   -4
+        3 |   -6
+        4 |    7
+        5 |    3
+        6 |    2
+        7 |    1
+(7 rows)
  
 </programlisting>
 			</refsection>