[postgis-commits] svn - r2868 - trunk/doc

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-07-17 07:16:17 -0700 (Thu, 17 Jul 2008)
New Revision: 2868

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move ST_Reverse and add example

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-07-17 12:14:54 UTC (rev 2867)
+++ trunk/doc/reference.xml	2008-07-17 14:16:17 UTC (rev 2868)
@@ -2014,14 +2014,6 @@
           </listitem>
         </varlistentry>
 
-        <varlistentry id="ST_Reverse">
-          <term>ST_Reverse(geometry)</term>
-
-          <listitem>
-            <para>Returns the geometry with vertex order reversed.</para>
-          </listitem>
-        </varlistentry>
-
         <varlistentry>
           <term>ST_ForceRHR(geometry)</term>
 

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-07-17 12:14:54 UTC (rev 2867)
+++ trunk/doc/reference_new.xml	2008-07-17 14:16:17 UTC (rev 2868)
@@ -569,18 +569,17 @@
 	GROUP BY gps.gps_track</programlisting>
 		</refsection>
 		<refsection>
-		<title>Examples: Non-Spatial Aggregate version</title>
-		
-		<para>First example is a simple one off line string composed of 2 points.  The second formulates
-			line strings from 2 points a user draws</para>
-		<programlisting>
+			<title>Examples: Non-Spatial Aggregate version</title>
+			
+			<para>First example is a simple one off line string composed of 2 points.  The second formulates
+				line strings from 2 points a user draws</para>
+			<programlisting>
 SELECT ST_AsText(ST_MakeLine(ST_MakePoint(1,2), ST_MakePoint(3,4)));
 SELECT userpoints.id, ST_MakeLine(startpoint, endpoint) As drawn_line
-FROM userpoints ;
-		</programlisting>
+	FROM userpoints ;
+			</programlisting>
 		</refsection>
-		
-		</refentry>  
+	</refentry>
   </sect1>
    
   <sect1>
@@ -683,7 +682,41 @@
   
   <sect1>
       <title>Geometry Editors</title>
-      
+	<refentry id="ST_Reverse">
+	  <refnamediv>
+		<refname>ST_Reverse</refname>
+		<refpurpose>Returns the geometry with vertex order reversed.</refpurpose>
+	  </refnamediv>
+	
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>geometry <function>ST_Reverse</function></funcdef>
+			<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
+		  </funcprototype>
+		 </funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+		<title>Description</title>
+	
+		<para>Can be used on any geometry and reverses the order of the vertexes.</para>
+	  </refsection>
+	
+	  <refsection>
+		<title>Examples</title>	
+		<programlisting>
+SELECT ST_AsText(the_geom) as line, ST_AsText(ST_Reverse(the_geom)) As reverseline
+FROM
+(SELECT ST_MakeLine(ST_MakePoint(1,2), 
+		ST_MakePoint(1,10)) As the_geom) as foo;
+--result
+        line         |     reverseline
+---------------------+----------------------
+LINESTRING(1 2,1 10) | LINESTRING(1 10,1 2)
+</programlisting>
+	  </refsection>
+	</refentry> 
     <refentry id="ST_SetSRID">
       <refnamediv>
         <refname>ST_SetSRID</refname>
@@ -1267,7 +1300,7 @@
 		</refsection>
 		<refsection>
 			<title>See Also</title>
-			<para><xref linkend="ST_Disjoint"/>ST_Disjoint</para>
+			<para><xref linkend="ST_Disjoint"/></para>
 		</refsection>
     </refentry>
 	<refentry id="ST_OrderingEquals">