Improve the extentBuffer API docs

This commit is contained in:
Éric Lemoine 2019-06-19 09:32:44 +02:00
parent d771ccf188
commit 0b87041b31
2 changed files with 13 additions and 10 deletions

View File

@ -78,17 +78,19 @@ of output size. Use visibleExtent() to get the resulting extent.
double extentBuffer() const;
%Docstring
Returns the buffer to use around the visible extent for rendering symbols whose
corresponding geometries are outside the visible extent.
Returns the buffer in map units to use around the visible extent for rendering
symbols whose corresponding geometries are outside the visible extent.
.. seealso:: :py:func:`setExtentBuffer`
.. versionadded:: 3.10
%End
void setExtentBuffer( double buffer );
%Docstring
Sets the buffer to use around the visible extent for rendering symbols whose
corresponding geometries are outside the visible extent. This is useful when
using tiles to avoid cut symbols at tile boundaries.
Sets the buffer in map units to use around the visible extent for rendering
symbols whose corresponding geometries are outside the visible extent. This
is useful when using tiles to avoid cut symbols at tile boundaries.
.. versionadded:: 3.10
%End

View File

@ -103,16 +103,17 @@ class CORE_EXPORT QgsMapSettings
void setExtent( const QgsRectangle &rect, bool magnified = true );
/**
* Returns the buffer to use around the visible extent for rendering symbols whose
* corresponding geometries are outside the visible extent.
* Returns the buffer in map units to use around the visible extent for rendering
* symbols whose corresponding geometries are outside the visible extent.
* \see setExtentBuffer()
* \since QGIS 3.10
*/
double extentBuffer() const;
/**
* Sets the buffer to use around the visible extent for rendering symbols whose
* corresponding geometries are outside the visible extent. This is useful when
* using tiles to avoid cut symbols at tile boundaries.
* Sets the buffer in map units to use around the visible extent for rendering
* symbols whose corresponding geometries are outside the visible extent. This
* is useful when using tiles to avoid cut symbols at tile boundaries.
* \since QGIS 3.10
*/
void setExtentBuffer( double buffer );