Doxygen

qgis · Dec 15, 2017 · f7b315f · f7b315f
1 parent 2e2e124
commit f7b315f
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/python/core/qgscoordinatetransformcontext.sip b/python/core/qgscoordinatetransformcontext.sip
@@ -15,6 +15,17 @@ class QgsCoordinateTransformContext
 %Docstring
  Contains information about the context in which a coordinate transform is executed.
 
+ The context stores various information regarding which coordinate transforms should
+ be used when transforming points from a source to destination coordinate reference
+ system.
+
+ The highest priority transforms are those set using addSourceDestinationDatumTransform()
+ and which the transform has a matching source to destination CRS pair.
+
+ Failing this, if the source CRS has a matching transform specified by
+ addSourceDatumTransform() then this datum transform will be used. The same logic
+ applies for destination CRS transforms set using addDestinationDatumTransform().
+
 .. versionadded:: 3.0
 %End
 

diff --git a/src/core/qgscoordinatetransformcontext.h b/src/core/qgscoordinatetransformcontext.h
@@ -27,6 +27,17 @@
  * \ingroup core
  * Contains information about the context in which a coordinate transform is executed.
  *
+ * The context stores various information regarding which coordinate transforms should
+ * be used when transforming points from a source to destination coordinate reference
+ * system.
+ *
+ * The highest priority transforms are those set using addSourceDestinationDatumTransform()
+ * and which the transform has a matching source to destination CRS pair.
+ *
+ * Failing this, if the source CRS has a matching transform specified by
+ * addSourceDatumTransform() then this datum transform will be used. The same logic
+ * applies for destination CRS transforms set using addDestinationDatumTransform().
+ *
  * \since QGIS 3.0
 */