Update doc

qgis · Mar 10, 2021 · f94e29e · f94e29e
1 parent 4e4aa1f
commit f94e29e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 11 deletions.
diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in
@@ -507,9 +507,12 @@ Returns the extent of the layer.
 
     QgsRectangle geographicExtent( bool actual = false ) const;
 %Docstring
-Returns the geographic extent (EPSG:4326) of the layer.
+Returns the geographic extent (EPSG:4326) of the layer according to
+ReadFlag.FlagTrustLayerMetadata. If that flag is activated, then the
+geographic extent read in the qgs project is returned. Otherwise, the
+actual geographic extent is returned.
 
-.. seealso:: :py:func:`setExtent`
+:param actual: True to return the current geographic extent whatever the read flags
 
 .. versionadded:: 3.18
 %End
@@ -1707,9 +1710,6 @@ Copies attributes like name, short name, ... into another layer.
     virtual void setExtent( const QgsRectangle &extent );
 %Docstring
 Sets the ``extent`` in layer CRS.
-
-If the layer CRS is not EPSG:4326 and the geographic extent is
-known.
 %End
 
     void setValid( bool valid );

diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -515,9 +515,11 @@ class CORE_EXPORT QgsMapLayer : public QObject
     virtual QgsRectangle extent() const;
 
     /**
-     * Returns the geographic extent (EPSG:4326) of the layer.
-     *
-     * \see setExtent()
+     * Returns the geographic extent (EPSG:4326) of the layer according to
+     * ReadFlag::FlagTrustLayerMetadata. If that flag is activated, then the
+     * geographic extent read in the qgs project is returned. Otherwise, the
+     * actual geographic extent is returned.
+     * \param actual True to return the current geographic extent whatever the read flags
      * \since QGIS 3.18
      */
     QgsRectangle geographicExtent( bool actual = false ) const;
@@ -1522,9 +1524,6 @@ class CORE_EXPORT QgsMapLayer : public QObject
 
     /**
      * Sets the \a extent in layer CRS.
-     *
-     * If the layer CRS is not EPSG:4326 and the geographic extent is
-     * known.
      */
     virtual void setExtent( const QgsRectangle &extent );