From: Sandro Santilli <strk@keybit.net>
Date: Wed, 16 Feb 2011 08:34:08 +0000 (+0000)
Subject: Document ST_isValidDetail(geom, flags) variant [RT-SIGTA]
X-Git-Tag: 2.0.0alpha1~1975
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=741772b267df3d2ea9f50d27054b0eb9f6d48c3e;p=postgis

Document ST_isValidDetail(geom, flags) variant [RT-SIGTA]

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

diff --git a/doc/reference_accessor.xml b/doc/reference_accessor.xml
index 606972872..fe159e8c9 100644
--- a/doc/reference_accessor.xml
+++ b/doc/reference_accessor.xml
@@ -1190,6 +1190,11 @@ SELECT ST_IsValidReason('LINESTRING(220227 150406,2220227 150407,222020 150410)'
 			<funcdef>valid_detail <function>ST_IsValidDetail</function></funcdef>
 			<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
 		  </funcprototype>
+		  <funcprototype>
+			<funcdef>valid_detail <function>ST_IsValidDetail</function></funcdef>
+			<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
+			<paramdef><type>integer </type> <parameter>flags</parameter></paramdef>
+		  </funcprototype>
 		</funcsynopsis>
 	  </refsynopsisdiv>
 
@@ -1199,6 +1204,20 @@ SELECT ST_IsValidReason('LINESTRING(220227 150406,2220227 150407,222020 150410)'
 		<para>Returns a valid_detail row, formed by a boolean (valid) stating if a geometry is valid, a varchar (reason) stating a reason why it is invalid and a geometry (location) pointing out where it is invalid.</para>
 
 		<para>Useful to substitute and improve the combination of ST_IsValid and ST_IsValidReason to generate a detailed report of invalid geometries.</para>
+
+		<para>
+The 'flags' argument is a bitfield. It can have the following values:
+			<itemizedlist>
+				<listitem>
+<para>
+1: Consider self-intersecting rings forming holes as valid.
+   This is also know as "the ESRI flag".
+   Note that this is against the OGC model.
+</para>
+				</listitem>
+			</itemizedlist>
+		</para>
+
 		<para>Availability: 2.0.0 - requires GEOS &gt;= 3.3.0.</para>
 
 	  </refsection>