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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-12-06 16:40:47 -0800 (Sat, 06 Dec 2008)
New Revision: 3366

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over ST_Box2D and ST_Box3D and flag ST_Accum as working with circular strings

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-12-05 19:39:33 UTC (rev 3365)
+++ trunk/doc/reference.xml	2008-12-07 00:40:47 UTC (rev 3366)
@@ -412,25 +412,7 @@
       <title>Misc</title>
 
       <variablelist>
-        <varlistentry>
-          <term>ST_box2d(geometry)</term>
 
-          <listitem>
-            <para>Returns a BOX2D representing the maximum extents of the
-            geometry.</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>ST_box3d(geometry)</term>
-
-          <listitem>
-            <para>Returns a BOX3D representing the maximum extents of the
-            geometry.</para>
-          </listitem>
-        </varlistentry>
-
-
         <varlistentry id="zmflag">
           <term>ST_zmflag(geometry)</term>
 

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-12-05 19:39:33 UTC (rev 3365)
+++ trunk/doc/reference_new.xml	2008-12-07 00:40:47 UTC (rev 3366)
@@ -11548,6 +11548,13 @@
 	          <imagedata fileref="images/check.png" />
 	        </imageobject>
 	      </inlinemediaobject> This function supports 3d and will not drop the z-index.</para>
+		  
+		<!-- Optionally mention Circular String Support -->
+			<para><inlinemediaobject>
+				<imageobject>
+				  <imagedata fileref="images/check.png" />
+				</imageobject>
+			  </inlinemediaobject> This method supports Circular Strings and curves </para>
 	  </refsection>
 	  
 	
@@ -11582,6 +11589,119 @@
 	    <para><xref linkend="ST_Collect" /></para>
 	  </refsection>
 	</refentry>
+		
+	<refentry id="ST_Box2D">
+	  <refnamediv>
+		<refname>ST_Box2D</refname>
+	
+		<refpurpose>Returns a BOX2D representing the maximum extents of the geometry.</refpurpose>
+	  </refnamediv>
+	
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>box2d <function>ST_Box2D</function></funcdef>
+			<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
+		  </funcprototype>
+		</funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+		<title>Description</title>
+	
+		<para>Returns a BOX2D representing the maximum extents of the geometry.</para>
+	
+	<!-- Optionally mention Circular String Support -->
+			<para><inlinemediaobject>
+				<imageobject>
+				  <imagedata fileref="images/check.png" />
+				</imageobject>
+			  </inlinemediaobject> This method supports Circular Strings and curves </para>
+	  </refsection>
+	  
+	
+	  <refsection>
+		<title>Examples</title>
+	
+		<programlisting>SELECT ST_Box2D(ST_GeomFromText('LINESTRING(1 2, 3 4, 5 6)'));
+	st_box2d
+	---------
+	BOX(1 2,5 6)
+	
+	SELECT ST_Box2D(ST_GeomFromText('CIRCULARSTRING(220268 150415,220227 150505,220227 150406)'));
+	st_box2d
+	--------
+	BOX(220186.984375 150406,220288.25 150506.140625)
+	</programlisting>
+	  </refsection>
+	
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+		<title>See Also</title>
+	
+		<para><xref linkend="ST_Box3D" />, <xref linkend="ST_GeomFromText" /></para>
+	  </refsection>
+	</refentry>
+	
+	<refentry id="ST_Box3D">
+	  <refnamediv>
+		<refname>ST_Box3D</refname>
+	
+		<refpurpose>Returns a BOX3D representing the maximum extents of the geometry.</refpurpose>
+	  </refnamediv>
+	
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>box3d <function>ST_Box3D</function></funcdef>
+			<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
+		  </funcprototype>
+		</funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+		<title>Description</title>
+	
+		<para>Returns a BOX3D representing the maximum extents of the geometry.</para>
+		
+		<!-- Optionally mention 3d support -->
+	    <para><inlinemediaobject>
+	        <imageobject>
+	          <imagedata fileref="images/check.png" />
+	        </imageobject>
+	      </inlinemediaobject> This function supports 3d and will not drop the z-index.</para>
+	
+		  <!-- Optionally mention Circular String Support -->
+			<para><inlinemediaobject>
+				<imageobject>
+				  <imagedata fileref="images/check.png" />
+				</imageobject>
+			  </inlinemediaobject> This method supports Circular Strings and curves </para>
+	  </refsection>
+	  
+	
+	  <refsection>
+		<title>Examples</title>
+	
+		<programlisting>SELECT ST_Box3D(ST_GeomFromEWKT('LINESTRING(1 2 3, 3 4 5, 5 6 5)'));
+	st_box3d
+	---------
+	BOX3D(1 2 3,5 6 5)
+	
+	SELECT ST_Box3D(ST_GeomFromEWKT('CIRCULARSTRING(220268 150415 1,220227 150505 1,220227 150406 1)'));
+	st_box3d
+	--------
+	BOX3D(220227 150406 1,220268 150415 1)
+	</programlisting>
+	  </refsection>
+	
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+		<title>See Also</title>
+	
+		<para><xref linkend="ST_Box2D" />, <xref linkend="ST_GeomFromEWKT" /></para>
+	  </refsection>
+	</refentry>
 			
 	<refentry id="ST_Estimated_Extent">
 	  <refnamediv>