From: Regina Obe <lr@pcorp.us>
Date: Wed, 10 Sep 2008 11:39:01 +0000 (+0000)
Subject: Move over ST_Summary and provide example.
X-Git-Tag: 1.4.0b1~751
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2878f77ec8b63991326d77cd2c283c5c3e50d48a;p=postgis

Move over ST_Summary and provide example.

git-svn-id: http://svn.osgeo.org/postgis/trunk@2953 b70326c6-7e19-0410-871a-916f4a2858ee
---

diff --git a/doc/reference.xml b/doc/reference.xml
index 8bc9cf3e4..c9f45e688 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -1484,15 +1484,6 @@ WHERE n*100.00/length &lt; 1;
       <title>Misc</title>
 
       <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>
 
diff --git a/doc/reference_new.xml b/doc/reference_new.xml
index e9672aa79..73734b127 100644
--- a/doc/reference_new.xml
+++ b/doc/reference_new.xml
@@ -2338,6 +2338,62 @@ postgis=# SELECT ST_StartPoint('POINT(0 1)'::geometry) IS NULL AS is_null;
       <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>