aboutsummaryrefslogtreecommitdiff
path: root/docs/source/development
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-05-07 13:24:50 +0200
committerKristian Evers <kristianevers@gmail.com>2018-05-07 13:24:50 +0200
commitaecec570644fc8291b027f585311db4007c935f9 (patch)
tree6d6b5172e8ffa5d57cbe4679a54cde4dadae5daf /docs/source/development
parenta751fcc49b6542245e57707488fcbeff7a22fb6a (diff)
downloadPROJ-aecec570644fc8291b027f585311db4007c935f9.tar.gz
PROJ-aecec570644fc8291b027f585311db4007c935f9.zip
Change duplicate doc entry of proj_lp_dist() to proj_lpz_dist()
Diffstat (limited to 'docs/source/development')
-rw-r--r--docs/source/development/reference/functions.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/source/development/reference/functions.rst b/docs/source/development/reference/functions.rst
index 52f801e5..e6a54cba 100644
--- a/docs/source/development/reference/functions.rst
+++ b/docs/source/development/reference/functions.rst
@@ -386,16 +386,19 @@ Distances
.. c:function:: double proj_lp_dist(const PJ *P, PJ_COORD a, PJ_COORD b)
- Calculate geodesic distance between two points in geodetic coordinates.
+ Calculate geodesic distance between two points in geodetic coordinates. The
+ calculated distance is between the two points located on the ellipsoid.
:param PJ* P: Transformation object
:param PJ_COORD a: Coordinate of first point
:param PJ_COORD b: Coordinate of second point
:returns: :c:type:`double` Distance between :c:data:`a` and :c:data:`b` in meters.
-.. c:function:: double proj_lp_dist(const PJ *P, PJ_COORD a, PJ_COORD b)
+.. c:function:: double proj_lpz_dist(const PJ *P, PJ_COORD a, PJ_COORD b)
Calculate geodesic distance between two points in geodetic coordinates.
+ Similar to :c:func:`proj_lp_dist` but also takes the height above the ellipsoid
+ into account.
:param PJ* P: Transformation object
:param PJ_COORD a: Coordinate of first point