]> granicus.if.org Git - postgis/commitdiff
Move over ST_SetPoint to new section
authorRegina Obe <lr@pcorp.us>
Sun, 7 Sep 2008 08:43:29 +0000 (08:43 +0000)
committerRegina Obe <lr@pcorp.us>
Sun, 7 Sep 2008 08:43:29 +0000 (08:43 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@2942 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference.xml
doc/reference_new.xml

index cfd022a47ea5bbe7e9337e5c744eaa9bb134d7c1..98b244c230e4fc866bdd9d5a027d28aa6aa6e3c3 100644 (file)
@@ -1113,19 +1113,7 @@ GROUP BY gid, field1,field2;
             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>
 
index 0a5e4263b668edf103ab80273357c71dfdea8f6b..16e41263c082cff6e94b375e62b14867e1899b46 100644 (file)
@@ -2308,11 +2308,11 @@ postgis=# SELECT ST_StartPoint('POINT(0 1)'::geometry) IS NULL AS is_null;
                  </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 @@ UPDATE sometable
         <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 @@ FROM
 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>