From eb73b8b618b40453b6dc74135df11bec8020a548 Mon Sep 17 00:00:00 2001
From: Sandro Santilli <strk@keybit.net>
Date: Wed, 8 Feb 2012 10:06:59 +0000
Subject: [PATCH] Document topology.GetRingEdges (#959)

git-svn-id: http://svn.osgeo.org/postgis/trunk@9096 b70326c6-7e19-0410-871a-916f4a2858ee
---
 doc/extras_topology.xml | 49 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/doc/extras_topology.xml b/doc/extras_topology.xml
index 4e8709712..2778675eb 100644
--- a/doc/extras_topology.xml
+++ b/doc/extras_topology.xml
@@ -1762,7 +1762,11 @@ FROM topology.ST_GetFaceEdges('tt',1) As t(seq,edge)
 			<!-- Optionally add a "See Also" section -->
 			<refsection>
 				<title>See Also</title>
-				<para><xref linkend="AddFace"/>, <xref linkend="ST_GetFaceGeometry"/></para>
+				<para>
+<xref linkend="GetRingEdges"/>,
+<xref linkend="AddFace"/>,
+<xref linkend="ST_GetFaceGeometry"/>
+				</para>
 			</refsection>
 		</refentry>
 		
@@ -1816,6 +1820,49 @@ SELECT ST_AsText(topology.ST_GetFaceGeometry('ma_topo', 1)) As facegeomwkt;
 				<para><xref linkend="AddFace"/></para>
 			</refsection>
 		</refentry>
+
+		<refentry id="GetRingEdges">
+			<refnamediv>
+				<refname>GetRingEdges</refname>
+			
+				<refpurpose>
+Returns an ordered set of edges forming a ring with the given edge .
+				</refpurpose>
+			</refnamediv>
+		
+			<refsynopsisdiv>
+				<funcsynopsis>
+					<funcprototype>
+					<funcdef>getfaceedges_returntype <function>GetRingEdges</function></funcdef>
+					<paramdef><type>varchar </type> <parameter>atopology</parameter></paramdef>
+					<paramdef><type>integer </type> <parameter>aring</parameter></paramdef>
+					</funcprototype>
+				</funcsynopsis>
+			</refsynopsisdiv>
+		
+			<refsection>
+                <title>Description</title>
+            
+                <para>
+Returns an ordered set of edges forming a ring with the given edge.
+Each output consists of a sequence and a signed edge id.
+Sequence numbers start with value 1.
+A negative edge identifier means that the given edge is taken backward.
+You can pass a negative edge id to start walking backward.
+		</para>
+
+                
+                <!-- use this format if new function -->
+                <para>Availability: 2.0 </para>
+			</refsection>
+		
+		
+			<!-- Optionally add a "See Also" section -->
+			<refsection>
+				<title>See Also</title>
+				<para><xref linkend="ST_GetFaceEdges"/></para>
+			</refsection>
+		</refentry>
 		
 	</sect1>
 
-- 
2.40.0