Add doxygen note linking QgsDistanceArea to QgsEllipsoidUtils

qgis · Apr 18, 2017 · 05b737c · 05b737c
1 parent 5f1656b
commit 05b737c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/python/core/qgsdistancearea.sip b/python/core/qgsdistancearea.sip
@@ -65,7 +65,8 @@ Constructor
 
     bool setEllipsoid( const QString &ellipsoid );
 %Docstring
- Sets the ``ellipsoid`` by its acronym.
+ Sets the ``ellipsoid`` by its acronym. Known ellipsoid acronyms can be
+ retrieved using QgsEllipsoidUtils.acronyms().
  Calculations will only use the ellipsoid if a valid ellipsoid has been set.
  :return: true if ellipsoid was successfully set
  \see ellipsoid()

diff --git a/src/core/qgsdistancearea.h b/src/core/qgsdistancearea.h
@@ -75,7 +75,8 @@ class CORE_EXPORT QgsDistanceArea
     QgsCoordinateReferenceSystem sourceCrs() const { return mCoordTransform.sourceCrs(); }
 
     /**
-     * Sets the \a ellipsoid by its acronym.
+     * Sets the \a ellipsoid by its acronym. Known ellipsoid acronyms can be
+     * retrieved using QgsEllipsoidUtils::acronyms().
      * Calculations will only use the ellipsoid if a valid ellipsoid has been set.
      * \returns true if ellipsoid was successfully set
      * \see ellipsoid()