From: Sandro Santilli <strk@keybit.net>
Date: Mon, 3 May 2010 16:24:22 +0000 (+0000)
Subject: Document ST_MakeValid
X-Git-Tag: 2.0.0alpha1~3006
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8838ea732836c41b2a0ef768129e6a304427d651;p=postgis

Document ST_MakeValid

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

diff --git a/doc/reference_processing.xml b/doc/reference_processing.xml
index f36a79b69..d57c6b66d 100644
--- a/doc/reference_processing.xml
+++ b/doc/reference_processing.xml
@@ -1874,8 +1874,8 @@ MULTILINESTRING((3 4,4 5),(1 2,3 4))
 	<funcsynopsis>
 	  <funcprototype>
 		<funcdef>geometry <function>ST_Split</function></funcdef>
-		<paramdef><type>geometry</type><parameter>input</parameter></paramdef>
-		<paramdef><type>geometry</type><parameter>blade</parameter></paramdef>
+		<paramdef><type>geometry</type> <parameter>input</parameter></paramdef>
+		<paramdef><type>geometry</type> <parameter>blade</parameter></paramdef>
 	  </funcprototype>
 	</funcsynopsis>
   </refsynopsisdiv>
@@ -1901,4 +1901,56 @@ should always yeld the original geometry.
 		<para><xref linkend="ST_Union" /></para>
 	  </refsection>
 	</refentry>
+
+<refentry id="ST_MakeValid">
+  <refnamediv>
+	<refname>ST_MakeValid</refname>
+	<refpurpose>Attempts to make an invalid geometry valid w/out loosing vertices.</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+	<funcsynopsis>
+	  <funcprototype>
+		<funcdef>geometry <function>ST_MakeValid</function></funcdef>
+		<paramdef><type>geometry</type> <parameter>input</parameter></paramdef>
+	  </funcprototype>
+	</funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsection>
+	<title>Description</title>
+<para>
+The function attempts to create a valid representation of a given invalid
+geometry without loosing any of the input vertices. 
+Already-valid geometries are returned w/out further intervention.
+</para>
+
+<para>
+Supported inputs are: LINESTRINGS, MULTILINESTRINGS, POLYGONS, MULTIPOLYGONS.
+</para>
+
+<para>
+In case of full or partial dimensional collapses, the output geometry
+may be a collection of lower-to-equal dimension geometries or a
+geometry of lower dimension. 
+</para>
+
+<para>
+Single polygons may become multi-geometries in case of self-intersections.
+</para>
+
+<para>Availability: 2.0.0, requires GEOS-3.3.0 or higher.</para>
+
+<para>&Z_support;</para>
+
+	  </refsection>
+
+	  <refsection>
+		<title>See Also</title>
+		<para>
+			<xref linkend="ST_IsValid" />
+			<xref linkend="ST_CollectionExtract" />
+		</para>
+	  </refsection>
+	</refentry>
 </sect1>