aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorEven Rouault <even.rouault@spatialys.com>2018-12-12 23:26:37 +0100
committerEven Rouault <even.rouault@spatialys.com>2018-12-12 23:26:37 +0100
commitc566213d28d488df622eeebb52b9aa44fd231189 (patch)
treea58c66c4f63b4775763dcb5820d8212332d5e1c3 /src
parent696fc1eb108478ae1eeecf6f113a60ff979f0cf9 (diff)
downloadPROJ-c566213d28d488df622eeebb52b9aa44fd231189.tar.gz
PROJ-c566213d28d488df622eeebb52b9aa44fd231189.zip
Improve doc of CRS::identify() / proj_obj_identify()
Diffstat (limited to 'src')
-rw-r--r--src/c_api.cpp4
-rw-r--r--src/crs.cpp12
2 files changed, 12 insertions, 4 deletions
diff --git a/src/c_api.cpp b/src/c_api.cpp
index e5ceca7d..d3aae5ac 100644
--- a/src/c_api.cpp
+++ b/src/c_api.cpp
@@ -1754,7 +1754,9 @@ PJ_OBJ *proj_obj_get_target_crs(PJ_CONTEXT *ctx, const PJ_OBJ *obj) {
* authorityFactory is not null.
*
* The method returns a list of matching reference CRS, and the percentage
- * (0-100) of confidence in the match.
+ * (0-100) of confidence in the match. The list is sorted by decreasing
+ * confidence.
+ *
* 100% means that the name of the reference entry
* perfectly matches the CRS name, and both are equivalent. In which case a
* single result is returned.
diff --git a/src/crs.cpp b/src/crs.cpp
index 572fae5d..40a8e2e1 100644
--- a/src/crs.cpp
+++ b/src/crs.cpp
@@ -580,7 +580,9 @@ CRSNNPtr CRS::alterName(const std::string &newName) const {
* authorityFactory is not null.
*
* The method returns a list of matching reference CRS, and the percentage
- * (0-100) of confidence in the match.
+ * (0-100) of confidence in the match. The list is sorted by decreasing
+ * confidence.
+ *
* 100% means that the name of the reference entry
* perfectly matches the CRS name, and both are equivalent. In which case a
* single result is returned.
@@ -2874,7 +2876,9 @@ void ProjectedCRS::addUnitConvertAndAxisSwap(io::PROJStringFormatter *formatter,
* authorityFactory is not null.
*
* The method returns a list of matching reference CRS, and the percentage
- * (0-100) of confidence in the match.
+ * (0-100) of confidence in the match. The list is sorted by decreasing
+ * confidence.
+ *
* 100% means that the name of the reference entry
* perfectly matches the CRS name, and both are equivalent. In which case a
* single result is returned.
@@ -3311,7 +3315,9 @@ bool CompoundCRS::_isEquivalentTo(
* authorityFactory is not null.
*
* The method returns a list of matching reference CRS, and the percentage
- * (0-100) of confidence in the match.
+ * (0-100) of confidence in the match. The list is sorted by decreasing
+ * confidence.
+ *
* 100% means that the name of the reference entry
* perfectly matches the CRS name, and both are equivalent. In which case a
* single result is returned.