]> granicus.if.org Git - postgis/commitdiff
document st_length*spheroid functions
authorRegina Obe <lr@pcorp.us>
Sun, 26 Oct 2008 22:19:10 +0000 (22:19 +0000)
committerRegina Obe <lr@pcorp.us>
Sun, 26 Oct 2008 22:19:10 +0000 (22:19 +0000)
git-svn-id: http://svn.osgeo.org/postgis/branches/1.3@3184 b70326c6-7e19-0410-871a-916f4a2858ee

postgis_comments.sql

index 3e9dddba8d5fb85fc260bc1284c029cb29f088a3..918391bc68b3ca052b08ec17a5d0cda16d27896d 100644 (file)
@@ -270,6 +270,12 @@ COMMENT ON FUNCTION ST_Length2D(geometry ) IS 'args: a_2dlinestring - Returns th
                        \r
 COMMENT ON FUNCTION ST_Length3D(geometry ) IS 'args: a_3dlinestring - Returns the 3-dimensional or 2-dimensional length of the geometry if it is a linestring or multi-linestring.';\r
                        \r
+COMMENT ON FUNCTION ST_Length_Spheroid(geometry , spheroid ) IS 'args: a_linestring, a_spheroid - Calculates the 2D or 3D length of a linestring/multilinestring on an ellipsoid. This is useful if the coordinates of the geometry are in longitude/latitude and a length is desired without reprojection.';\r
+                       \r
+COMMENT ON FUNCTION ST_Length2D_Spheroid(geometry , spheroid ) IS 'args: a_linestring, a_spheroid - Calculates the 2D length of a linestring/multilinestring on an ellipsoid. This is useful if the coordinates of the geometry are in longitude/latitude and a length is desired without reprojection.';\r
+                       \r
+COMMENT ON FUNCTION ST_Length3D_Spheroid(geometry , spheroid ) IS 'args: a_linestring, a_spheroid - Calculates the length of a geometry on an ellipsoid, taking the elevation into account. This is just an alias for ST_Length_Spheroid.';\r
+                       \r
 COMMENT ON FUNCTION ST_Max_Distance(geometry , geometry ) IS 'args: g1, g2 - Returns the 2-dimensional largest distance between two geometries in projected units.';\r
                        \r
 COMMENT ON FUNCTION ST_OrderingEquals(geometry , geometry ) IS 'args: A, B - Returns true if the given geometries represent the same geometry and points are in the same directional order.';\r