From: Regina Obe <lr@pcorp.us>
Date: Thu, 1 Oct 2009 20:37:33 +0000 (+0000)
Subject: put in ST_Distance proto for geography so can test it.
X-Git-Tag: 1.5.0b1~436
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=898a8fbaf2f27656ef0086c72737100e750e5031;p=postgis

put in ST_Distance proto for geography so can test it.

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

diff --git a/doc/reference.xml b/doc/reference.xml
index 1c6d40868..99762721f 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -10049,10 +10049,10 @@ SELECT ST_Disjoint('POINT(0 0)'::geometry, 'LINESTRING ( 0 0, 0 2 )'::geometry);
 	  <refnamediv>
 		<refname>ST_Distance</refname>
 
-		<refpurpose>Returns the 2-dimensional cartesian minimum distance between two geometries in
-		projected units.</refpurpose>
+		<refpurpose>For geometry type Returns the 2-dimensional cartesian minimum distance between two geometries in
+		projected units.  For geography type returns the spherical minimum distance between two geographies (in eventually meters).</refpurpose>
 	  </refnamediv>
-
+ <!-- TODO: Take out the eventually meters once Paul has it returning really in meters -->
 	  <refsynopsisdiv>
 		<funcsynopsis>
 		  <funcprototype>
@@ -10064,6 +10064,15 @@ SELECT ST_Disjoint('POINT(0 0)'::geometry, 'LINESTRING ( 0 0, 0 2 )'::geometry);
 			<paramdef><type>geometry </type>
 			<parameter>g2</parameter></paramdef>
 		  </funcprototype>
+		  <funcprototype>
+			<funcdef>float <function>ST_Distance</function></funcdef>
+
+			<paramdef><type>geography </type>
+			<parameter>gg1</parameter></paramdef>
+
+			<paramdef><type>geography </type>
+			<parameter>gg2</parameter></paramdef>
+		  </funcprototype>
 		</funcsynopsis>
 	  </refsynopsisdiv>
 
@@ -10071,7 +10080,7 @@ SELECT ST_Disjoint('POINT(0 0)'::geometry, 'LINESTRING ( 0 0, 0 2 )'::geometry);
 		<title>Description</title>
 
 		<para>Returns the 2-dimensional minimum cartesian distance between two geometries in
-		projected units.</para>
+		projected units. For geography type returns the minimum distance around spheroid between two geographies (in eventually meters).</para>
 
 		<para>
 		  <inlinegraphic fileref="images/check.png" />