aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEven Rouault <even.rouault@spatialys.com>2020-10-31 15:53:15 +0100
committerEven Rouault <even.rouault@spatialys.com>2020-11-01 11:35:48 +0100
commit40daf707a1dd3815b49d50ee69835ed4730c7db3 (patch)
treee8b67bc48f06897e4aa8dc4cc2ae35c13a4ee762
parent65a78535d566e152a01881287c8a2db88cf651bb (diff)
downloadPROJ-40daf707a1dd3815b49d50ee69835ed4730c7db3.tar.gz
PROJ-40daf707a1dd3815b49d50ee69835ed4730c7db3.zip
Doxygen: improve doc of functions related to Datum/DatumEnsemble
-rw-r--r--src/iso19111/c_api.cpp8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/iso19111/c_api.cpp b/src/iso19111/c_api.cpp
index f4f6e6a2..90a414c6 100644
--- a/src/iso19111/c_api.cpp
+++ b/src/iso19111/c_api.cpp
@@ -2050,6 +2050,8 @@ PJ *proj_get_ellipsoid(PJ_CONTEXT *ctx, const PJ *obj) {
/** \brief Get the horizontal datum from a CRS
*
+ * This function may return a Datum or DatumEnsemble object.
+ *
* The returned object must be unreferenced with proj_destroy() after
* use.
* It should be used by at most one thread at a time.
@@ -7992,6 +7994,9 @@ double proj_coordoperation_get_accuracy(PJ_CONTEXT *ctx,
/** \brief Returns the datum of a SingleCRS.
*
+ * If that function returns NULL, @see proj_crs_get_datum_ensemble() to
+ * potentially get a DatumEnsemble instead.
+ *
* The returned object must be unreferenced with proj_destroy() after
* use.
* It should be used by at most one thread at a time.
@@ -8023,6 +8028,9 @@ PJ *proj_crs_get_datum(PJ_CONTEXT *ctx, const PJ *crs) {
/** \brief Returns the datum ensemble of a SingleCRS.
*
+ * If that function returns NULL, @see proj_crs_get_datum() to
+ * potentially get a Datum instead.
+ *
* The returned object must be unreferenced with proj_destroy() after
* use.
* It should be used by at most one thread at a time.