Updated SnapToGrid documentation

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

diff --git a/doc/postgis.xml b/doc/postgis.xml
index 9a70fbec1d8d712d08cc0412b672b0bc54b84d36..b75278d5cd7e04f2d3ff4cf2326cd5602e2fd946 100644 (file)
--- a/doc/postgis.xml
+++ b/doc/postgis.xml
@@ -4672,10 +4672,40 @@ FROM geometry_table;</literallayout>
            eventually returning NULL if output points are not
            enough to define a geometry of the given type.
            Collapsed geometries in a collection are stripped
-           from it.
-            Note that returned geometry might loose its
+           from it.</para>
+
+       <note><para>
+            The returned geometry might loose its
             simplicity (see <link linkend="IsSimple">IsSimple</link>).
+       </para></note>
+
+       <note><para>
+            Before release 1.1.0 this function always returned
+           a 2d geometry. Starting at 1.1.0 the returned geometry
+           will have same dimensionality as the input one with higher
+           dimension values untouched. Use the version taking a second
+           geometry argument to define all grid dimensions.
+       </para></note>
+
+               <para>
+                       Availability: 1.0.0RC1
+               </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>SnapToGrid(geometry, geometry, sizeX, sizeY, sizeZ, sizeM)</term>
+          <listitem>
+            <para>
+           Snap all points of the input geometry to the grid
+           defined by its origin (the second argument, must be a point)
+           and cell sizes. Specify 0 as size for any dimension you don't
+           want to snap to a grid.
            </para>
+
+               <para>
+                       Availability: 1.1.0
+               </para>
           </listitem>
         </varlistentry>