Document ST_ForceCurve (#2430)

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

diff --git a/doc/reference_editor.xml b/doc/reference_editor.xml
index 690fe6cbbd3469b17cc832f1fa9c61457e9b2bb4..7ac86bd121e8d8fd417fc0fe709cf091853ec535 100644 (file)
--- a/doc/reference_editor.xml
+++ b/doc/reference_editor.xml
@@ -621,6 +621,57 @@ GEOMETRYCOLLECTION(
                </refsection>
        </refentry>
 
+       <refentry id="ST_ForceCurve">
+               <refnamediv>
+                       <refname>ST_ForceCurve</refname>
+
+                       <refpurpose>Upcasts a geometry into its curved type, if applicable.</refpurpose>
+               </refnamediv>
+
+               <refsynopsisdiv>
+                       <funcsynopsis>
+                               <funcprototype>
+                                       <funcdef>geometry
+                                               <function>ST_ForceCurve</function></funcdef>
+                                               <paramdef><type>geometry</type> <parameter>g</parameter></paramdef>
+                               </funcprototype>
+                       </funcsynopsis>
+               </refsynopsisdiv>
+
+               <refsection>
+                       <title>Description</title>
+
+                       <para>
+                        Turns a geometry into its curved representation, if applicable:
+                        lines become compoundcurves, multilines become multicurves
+                        polygons become curvepolygons multipolygons become multisurfaces.
+                        </para>
+
+                       <para>Availability: 2.2.0</para>
+                       <para>&Z_support;</para>
+               </refsection>
+
+               <refsection>
+                       <title>Examples</title>
+
+                       <programlisting>SELECT ST_AsText(
+  ST_ForceCurve(
+       'POLYGON((0 0 2, 5 0 2, 0 5 2, 0 0 2),(1 1 2, 1 3 2, 3 1 2, 1 1 2))'
+  )
+);
+                              st_astext
+----------------------------------------------------------------------
+ CURVEPOLYGON Z ((0 0 2,5 0 2,0 5 2,0 0 2),(1 1 2,1 3 2,3 1 2,1 1 2))
+(1 row)</programlisting>
+               </refsection>
+
+               <refsection>
+                       <title>See Also</title>
+
+                       <para><xref linkend="ST_LineToCurve"/></para>
+               </refsection>
+       </refentry>
+
        <refentry id="ST_LineMerge">
                <refnamediv>
                        <refname>ST_LineMerge</refname>