Add missing dox

qgis · Sep 5, 2022 · 2dae176 · 2dae176
1 parent b20cc30
commit 2dae176
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/python/core/auto_generated/project/qgsprojectdisplaysettings.sip.in b/python/core/auto_generated/project/qgsprojectdisplaysettings.sip.in
@@ -97,8 +97,22 @@ Sets the default coordinate ``type`` for the project.
 %End
 
     QgsCoordinateReferenceSystem coordinateCustomCrs() const;
+%Docstring
+Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
+
+.. seealso:: :py:func:`setCoordinateCustomCrs`
+
+.. versionadded:: 3.28
+%End
 
     void setCoordinateCustomCrs( const QgsCoordinateReferenceSystem &crs );
+%Docstring
+Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
+
+.. seealso:: :py:func:`setCoordinateCustomCrs`
+
+.. versionadded:: 3.28
+%End
 
     bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
 %Docstring
@@ -146,6 +160,15 @@ Emitted when the default coordinate format changes.
 %End
 
     void coordinateCustomCrsChanged();
+%Docstring
+Emitted when the coordinate custom CRS changes.
+
+.. seealso:: :py:func:`setCoordinateCustomCrs`
+
+.. seealso:: :py:func:`coordinateCustomCrs`
+
+.. versionadded:: 3.28
+%End
 
 };
 

diff --git a/src/core/project/qgsprojectdisplaysettings.h b/src/core/project/qgsprojectdisplaysettings.h
@@ -110,8 +110,18 @@ class CORE_EXPORT QgsProjectDisplaySettings : public QObject
      */
     void setCoordinateType( Qgis::CoordinateDisplayType type );
 
+    /**
+     * Returns the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
+     * \see setCoordinateCustomCrs()
+     * \since QGIS 3.28
+     */
     QgsCoordinateReferenceSystem coordinateCustomCrs() const { return mCoordinateCustomCrs; }
 
+    /**
+     * Sets the coordinate custom CRS used when the project coordinate type is set to Qgis.CoordinateDisplayType.CustomCrs.
+     * \see setCoordinateCustomCrs()
+     * \since QGIS 3.28
+     */
     void setCoordinateCustomCrs( const QgsCoordinateReferenceSystem &crs );
 
     /**
@@ -153,6 +163,13 @@ class CORE_EXPORT QgsProjectDisplaySettings : public QObject
      */
     void coordinateTypeChanged();
 
+    /**
+     * Emitted when the coordinate custom CRS changes.
+     *
+     * \see setCoordinateCustomCrs()
+     * \see coordinateCustomCrs()
+     * \since QGIS 3.28
+     */
     void coordinateCustomCrsChanged();
 
   private: