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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-09-07 01:43:29 -0700 (Sun, 07 Sep 2008)
New Revision: 2942

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over ST_SetPoint to new section

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-09-06 19:12:58 UTC (rev 2941)
+++ trunk/doc/reference.xml	2008-09-07 08:43:29 UTC (rev 2942)
@@ -1113,20 +1113,8 @@
             geometry size, but makes bounding-box based queries slower.</para>
           </listitem>
         </varlistentry>
-
-       
+		
         <varlistentry>
-          <term>ST_SetPoint(linestring, N, point)</term>
-
-          <listitem>
-            <para>Replace point N of linestring with given point. Index is
-            0-based.</para>
-
-            <para>Availability: 1.1.0</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>ST_Force_collection(geometry)</term>
 
           <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-09-06 19:12:58 UTC (rev 2941)
+++ trunk/doc/reference_new.xml	2008-09-07 08:43:29 UTC (rev 2942)
@@ -2308,11 +2308,11 @@
 		  </refsection>
 		  <refsection>
 			<title>See Also</title>
-			<para><xref linkend="ST_RemovePoint"/></para>
+			<para><xref linkend="ST_RemovePoint"/>, <xref linkend="ST_SetPoint" /></para>
 		  </refsection>
 		</refentry> 
 		
-<refentry id="ST_Multi">
+	<refentry id="ST_Multi">
 		<refnamediv>
 			<refname>ST_Multi</refname>
 			
@@ -2392,7 +2392,7 @@
         <title>See Also</title>
         <para><xref linkend="ST_AddPoint"/>, <xref linkend="ST_NPoints"/>, <xref linkend="ST_NumPoints"/></para>
       </refsection>
-	</refentry> 
+	</refentry>
 
 	<refentry id="ST_Reverse">
 	  <refnamediv>
@@ -2428,7 +2428,53 @@
 LINESTRING(1 2,1 10) | LINESTRING(1 10,1 2)
 </programlisting>
 	  </refsection>
+	</refentry>
+
+	<refentry id="ST_SetPoint">
+		  <refnamediv>
+			<refname>ST_SetPoint</refname>
+			<refpurpose>Replace point N of linestring with given point. Index is
+            0-based.</refpurpose>
+		  </refnamediv>
+		  <refsynopsisdiv>
+			<funcsynopsis>
+			  <funcprototype>
+				<funcdef>geometry <function>ST_AddPoint</function></funcdef>
+				<paramdef><type>geometry</type> <parameter>linestring</parameter></paramdef>
+				<paramdef><type>geometry</type> <parameter>point</parameter></paramdef>
+			  </funcprototype>
+			 </funcsynopsis>
+			 <funcsynopsis>
+			  <funcprototype>
+				<funcdef>geometry <function>ST_AddPoint</function></funcdef>
+				<paramdef><type>geometry</type> <parameter>linestring</parameter></paramdef>
+				<paramdef><type>geometry</type> <parameter>point</parameter></paramdef>
+				<paramdef><type>integer</type> <parameter>position</parameter></paramdef>
+			  </funcprototype>
+			 </funcsynopsis>
+		  </refsynopsisdiv>
+		
+		  <refsection>
+			<title>Description</title>
+		
+			<para>Replace point N of linestring with given point. Index is
+            0-based. 
+				This is especially useful in triggers when trying to maintain relationship of joints when one vertex moves.</para>
+			<para>Availability: 1.1.0</para>
+		  </refsection>
+		
+		  <refsection>
+			<title>Examples</title>	
+			<programlisting>
+<!-- TODO: Provide ST_SetPoint Example -->
+			</programlisting>
+		  </refsection>
+		  <refsection>
+			<title>See Also</title>
+			<para><xref linkend="ST_AddPoint"/>,<xref linkend="ST_RemovePoint"/></para>
+		  </refsection>
 	</refentry> 
+		
     <refentry id="ST_SetSRID">
       <refnamediv>
         <refname>ST_SetSRID</refname>