From: Regina Obe <lr@pcorp.us>
Date: Fri, 18 Nov 2011 13:58:47 +0000 (+0000)
Subject: document new ST_GeomFromGeoJSON function.  Will provide examples later once resolved... 
X-Git-Tag: 2.0.0alpha1~683
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bae31762d61d968714b16f727adf44ee05b1a023;p=postgis

document new ST_GeomFromGeoJSON function.  Will provide examples later once resolved my JSON-C compilation issues

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

diff --git a/doc/reference_constructor.xml b/doc/reference_constructor.xml
index 7fcb25474..711ebd3d6 100644
--- a/doc/reference_constructor.xml
+++ b/doc/reference_constructor.xml
@@ -581,6 +581,42 @@ SELECT ST_GeomFromEWKT('POLYHEDRALSURFACE(
 	  </refsection>
 	</refentry>
 	
+	<refentry id="ST_GeomFromGeoJSON">
+	  <refnamediv>
+		<refname>ST_GeomFromGeoJSON</refname>
+		<refpurpose>Takes as input a geojson representation of a geometry and outputs a PostGIS geometry object</refpurpose>
+	  </refnamediv>
+
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>geometry <function>ST_GeomFromGeoJSON</function></funcdef>
+			<paramdef><type>text </type> <parameter>geomjson</parameter></paramdef>
+		  </funcprototype>
+		</funcsynopsis>
+	  </refsynopsisdiv>
+
+	  <refsection>
+		<title>Description</title>
+		<para>Constructs a PostGIS geometry object from the GeoJSON representation.</para>
+		<para>ST_GeomFromGeoJSON works only for JSON Geometry fragments. It throws an error if you try to use it on a whole JSON document.</para>
+		
+		<para>Availability: 2.0.0 requires - requires JSON-C &gt;= 0.9</para>
+	  </refsection>
+ 
+	 <refsection>
+		<title>Examples</title>
+		<!-- TODO -->
+		COMING SOON
+	  </refsection>
+
+
+	  <refsection>
+		<title>See Also</title>
+		<para><xref linkend="ST_AsGeoJSON" /></para>
+	  </refsection>
+	</refentry>
+	
 	<refentry id="ST_GeomFromKML">
 	  <refnamediv>
 		<refname>ST_GeomFromKML</refname>