From: Sandro Santilli <strk@keybit.net>
Date: Tue, 16 Mar 2010 13:14:46 +0000 (+0000)
Subject: Document ST_Split
X-Git-Tag: 2.0.0alpha1~3102
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=eb5740ade386f26d01da55e58aeb9023e7280fc6;p=postgis

Document ST_Split

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

diff --git a/doc/reference_processing.xml b/doc/reference_processing.xml
index d3091531f..e1d735904 100644
--- a/doc/reference_processing.xml
+++ b/doc/reference_processing.xml
@@ -1863,4 +1863,41 @@ MULTILINESTRING((3 4,4 5),(1 2,3 4))
 		<para><xref linkend="ST_Collect" /></para>
 	  </refsection>
 	</refentry>
+
+<refentry id="ST_Split">
+  <refnamediv>
+	<refname>ST_Split</refname>
+	<refpurpose>Returns a collection of geometries resulting by splitting a geometry.</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+	<funcsynopsis>
+	  <funcprototype>
+		<funcdef>geometry <function>ST_Split</function></funcdef>
+		<paramdef><type>input geometry</type> <parameter>blade geometry</parameter></paramdef>
+	  </funcprototype>
+	</funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsection>
+	<title>Description</title>
+<para>
+The function supports splitting a line by point, a line by line, a polygon by line. The returned geometry is always a collection.
+</para>
+
+<para>
+Think of this function as the opposite of ST_Union.
+Theoretically applying ST_Union to the elements of the returned collection
+should always yeld the original geometry.
+</para>
+
+<para>Availability: 2.0.0</para>
+
+	  </refsection>
+
+	  <refsection>
+		<title>See Also</title>
+		<para><xref linkend="ST_Union" /></para>
+	  </refsection>
+	</refentry>
 </sect1>