Added Dump(geometry) doc

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

diff --git a/doc/postgis.xml b/doc/postgis.xml
index 780876ed9c58a239e9eedaea284a58820964885a..19687c5b3dc5564204a568bee7e481fa5acfc389 100644 (file)
--- a/doc/postgis.xml
+++ b/doc/postgis.xml
@@ -3937,6 +3937,26 @@ FROM geometry_table;</literallayout>
                  </listitem>
                </varlistentry>
 
+               <varlistentry>
+                 <term>Dump(geometry)</term>
+
+                 <listitem>
+                   <para>This is a set-returning function (SRF).
+                   It returns a set of
+                   <link linkend="geometry_dump">geometry_dump</link>
+                   rows, formed by a geometry (geom) and an array
+                   of integers (path). When the input geometry
+                   is a simple type (POINT,LINESTRING,POLYGON)
+                   a single record will be returned with an empty
+                   path array and the input geometry as geom.
+                   When the input geometry is a collection or multi
+                   it will return a record for each of the collection
+                   components, and the path will express the position
+                   of the component inside the collection.
+                   </para>
+                 </listitem>
+               </varlistentry>
+
          </variablelist>
       </sect2>