]> granicus.if.org Git - postgis/commitdiff
2855: better documentation to reflect minkowski doesn't support polyhedral and tins
authorRegina Obe <lr@pcorp.us>
Sat, 23 Aug 2014 05:50:54 +0000 (05:50 +0000)
committerRegina Obe <lr@pcorp.us>
Sat, 23 Aug 2014 05:50:54 +0000 (05:50 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@12915 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference_sfcgal.xml

index ae4de1d8751d38d2266ca02985a039f8ecfbb355..2769903d59b2b8cfd7becde8f935ba25ca97be03 100644 (file)
          <refnamediv>
                <refname>ST_MinkowskiSum</refname>
 
-               <refpurpose>Perform Minkowski sum</refpurpose>
+               <refpurpose>Performs Minkowski sum</refpurpose>
          </refnamediv>
 
          <refsynopsisdiv>
          <refsection>
                <title>Description</title>
 
+                <para>This function performs a 2D minkowski sum of a point, line or polygon with a polygon.</para>
+                <para>The first parameter can be any 2D geometry (point, linestring, polygon). If a 3D geometry is passed, it will be converted to 2D by forcing Z to 0, leading to possible cases of invalidity. The second parameter must be a 2D polygon.</para>
+
                <para>Availability: 2.1.0</para>
                <para>&sfcgal_required;</para>
                <para>&Z_support;</para>
-               <para>&P_support;</para>
-               <para>&T_support;</para>
          </refsection>
 
        </refentry>