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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2009-01-09 05:29:06 -0800 (Fri, 09 Jan 2009)
New Revision: 3505

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over ST_NRings

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2009-01-09 13:17:28 UTC (rev 3504)
+++ trunk/doc/reference.xml	2009-01-09 13:29:06 UTC (rev 3505)
@@ -412,17 +412,7 @@
       <title>Misc</title>
 
       <variablelist>
-
         <varlistentry>
-          <term>ST_nrings(geometry)</term>
-
-          <listitem>
-            <para>If the geometry is a polygon or multi-polygon returns the
-            number of rings.</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>ST_find_srid(varchar,varchar,varchar)</term>
 
           <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2009-01-09 13:17:28 UTC (rev 3504)
+++ trunk/doc/reference_new.xml	2009-01-09 13:29:06 UTC (rev 3505)
@@ -3686,7 +3686,57 @@
 			<para><xref linkend="ST_NumPoints" /></para>
 		</refsection>
 	</refentry>
+
+	<refentry id="ST_NRings">
+	  <refnamediv>
+	    <refname>ST_NRings</refname>
+	    <refpurpose>If the geometry is a polygon or multi-polygon returns the number of rings.</refpurpose>
+	  </refnamediv>
 	
+	  <refsynopsisdiv>
+	    <funcsynopsis>
+	      <funcprototype>
+	        <funcdef>integer <function>ST_NRings</function></funcdef>
+	        <paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
+	      </funcprototype>
+	    </funcsynopsis>
+	  </refsynopsisdiv>
+	
+	  <refsection>
+	    <title>Description</title>
+	
+	    <para>If the geometry is a polygon or multi-polygon returns the number of rings.  Unlike NumInteriorRings, it counts
+		the outer rings as well.</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>
+	  </refsection>
+	  
+	
+	  <refsection>
+	    <title>Examples</title>
+	
+	    <programlisting>SELECT ST_NRings(the_geom) As Nrings, ST_NumInteriorRings(the_geom) As ninterrings
+					FROM (SELECT ST_GeomFromText('POLYGON((1 2, 3 4, 5 6, 1 2))') As the_geom) As foo;
+	 nrings | ninterrings
+--------+-------------
+      1 |           0
+(1 row)				
+</programlisting>
+	  </refsection>
+	
+	  <!-- Optionally add a "See Also" section -->
+	  <refsection>
+	    <title>See Also</title>
+	
+	    <para><xref linkend="ST_NumInteriorRings" /></para>
+	  </refsection>
+	</refentry>
+	
 	<refentry id="ST_NumGeometries">
 		<refnamediv>
 			<refname>ST_NumGeometries</refname>
@@ -4434,7 +4484,7 @@
 	  <refsection>
 	    <title>See Also</title>
 	
-	    <para><xref linkend="ST_CoordDim" /></para>
+	    <para><xref linkend="ST_CoordDim" />, <xref linkend="ST_NDims" />, <xref linkend="ST_Dimension" /></para>
 	  </refsection>
 	</refentry>