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

[postgis-commits at postgis.refractions.net]

Author: robe
Date: 2008-09-10 04:39:01 -0700 (Wed, 10 Sep 2008)
New Revision: 2953

Modified:
   trunk/doc/reference.xml
   trunk/doc/reference_new.xml
Log:
Move over ST_Summary and provide example.

Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml	2008-09-10 11:28:37 UTC (rev 2952)
+++ trunk/doc/reference.xml	2008-09-10 11:39:01 UTC (rev 2953)
@@ -1485,15 +1485,6 @@
 
       <variablelist>
         <varlistentry>
-          <term>ST_Summary(geometry)</term>
-
-          <listitem>
-            <para>Returns a text summary of the contents of the
-            geometry.</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
           <term>ST_box2d(geometry)</term>
 
           <listitem>

Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml	2008-09-10 11:28:37 UTC (rev 2952)
+++ trunk/doc/reference_new.xml	2008-09-10 11:39:01 UTC (rev 2953)
@@ -2338,7 +2338,63 @@
       <para><xref linkend="ST_EndPoint" />, <xref linkend="ST_PointN" /></para>
     </refsection>
   </refentry>
+  
+       <varlistentry>
+          <term>ST_Summary(geometry)</term>
 
+          <listitem>
+            <para>Returns a text summary of the contents of the
+            geometry.</para>
+          </listitem>
+        </varlistentry>
+    <refentry id="ST_Summary">
+      <refnamediv>
+        <refname>ST_Summary</refname>
+    
+        <refpurpose>Returns a text summary of the contents of the
+        <varname>ST_Geometry</varname>.
+        </refpurpose>
+      </refnamediv>
+    
+      <refsynopsisdiv>
+        <funcsynopsis>
+          <funcprototype>
+            <funcdef>text <function>ST_Summary</function></funcdef>
+    
+            <paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
+          </funcprototype>
+        </funcsynopsis>
+      </refsynopsisdiv>
+    
+      <refsection>
+        <title>Description</title>
+    
+        <para>Returns a text summary of the contents of the geometry.</para>
+
+      </refsection>
+    
+      <refsection>
+        <title>Examples</title>
+    
+        <programlisting>SELECT ST_IsValid(ST_GeomFromText('LINESTRING(0 0, 1 1)')) As good_line,
+	ST_IsValid(ST_GeomFromText('POLYGON((0 0, 1 1, 1 2, 1 1, 0 0))')) As bad_poly
+--results
+      good_line       |        bad_poly
+----------------------+-------------------------
+                      |
+Line[B] with 2 points : Polygon[B] with 1 rings
+                      :    ring 0 has 5 points
+                      :
+</programlisting>
+      </refsection>
+    
+      <refsection>
+        <title>See Also</title>
+    
+        <para><xref linkend="ST_IsValid" /></para>
+      </refsection>
+    </refentry>
+
   </sect1>
   
   <sect1>