aboutsummaryrefslogtreecommitdiff
path: root/src/iso19111/c_api.cpp
diff options
context:
space:
mode:
authorEven Rouault <even.rouault@spatialys.com>2019-04-18 11:06:34 +0200
committerEven Rouault <even.rouault@spatialys.com>2019-04-18 11:06:34 +0200
commitadc03895800b192f72dc70213786ee708909b75e (patch)
tree293c6d51c5b2740594dbdd45d801356cbb4085b3 /src/iso19111/c_api.cpp
parentfc395adffc379ec2281288ee4d87a09eca9653bc (diff)
downloadPROJ-adc03895800b192f72dc70213786ee708909b75e.tar.gz
PROJ-adc03895800b192f72dc70213786ee708909b75e.zip
Improve doc of proj_coordoperation_get_towgs84_values() (fixes #1430)
Diffstat (limited to 'src/iso19111/c_api.cpp')
-rw-r--r--src/iso19111/c_api.cpp5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/iso19111/c_api.cpp b/src/iso19111/c_api.cpp
index 970d38d8..8fea51e9 100644
--- a/src/iso19111/c_api.cpp
+++ b/src/iso19111/c_api.cpp
@@ -5962,7 +5962,10 @@ int proj_coordoperation_get_param(
* @param coordoperation Object of type Transformation, that can be represented
* as a WKT1 TOWGS84 node (must not be NULL)
* @param out_values Pointer to an array of value_count double values.
- * @param value_count Size of out_values array.
+ * @param value_count Size of out_values array. The suggested size is 7 to get
+ * translation, rotation and scale difference parameters. Rotation and scale
+ * difference terms might be zero if the transformation only includes translation
+ * parameters. In that case, value_count could be set to 3.
* @param emit_error_if_incompatible Boolean to inicate if an error must be
* logged if coordoperation is not compatible with a WKT1 TOWGS84
* representation.