fix doc and typos

This commit is contained in:
Julien Cabieces 2022-11-08 16:56:31 +01:00
parent f8c1c16ec7
commit 7a2a252d0d
8 changed files with 38 additions and 11 deletions

View File

@ -136,7 +136,7 @@ Sets the list of disabled symbol layer ids.
.. seealso:: :py:func:`disabledSymbolLayersV2`
.. seealso:: :py:func:`isSymbolLayerEnabledV2`
.. seealso:: :py:func:`isSymbolLayerEnabled`
.. versionadded:: 3.30
%End

View File

@ -645,9 +645,9 @@ This is a list of symbol layers of other layers that should be occluded.
Prepares all mask internal objects according to what is defined in ``context``
This should be called prior to calling :py:func:`~QgsSymbolLayer.startRender` method.
.. seealso:: :py:func:`addSymbolLayerClipPath`
.. seealso:: :py:func:`QgsRenderContext.addSymbolLayerClipPath`
.. seealso:: :py:func:`symbolLayerClipPaths`
.. seealso:: :py:func:`QgsRenderContext.symbolLayerClipPaths`
.. versionadded:: 3.26
%End
@ -709,7 +709,7 @@ Copies paint effect of this layer to another symbol layer
void installMasks( QgsRenderContext &context, bool recursive );
%Docstring
When renderering, install masks on ``context`` painter
When rendering, install masks on ``context`` painter
if ``recursive`` is ``True`` masks are installed recursively for all children symbol layers
.. seealso:: :py:func:`prepareMasks`
@ -721,7 +721,7 @@ if ``recursive`` is ``True`` masks are installed recursively for all children sy
void removeMasks( QgsRenderContext &context, bool recursive );
%Docstring
When renderering, remove previously installed masks from ``context`` painter
When rendering, remove previously installed masks from ``context`` painter
if ``recursive`` is ``True`` masks are removed recursively for all children symbol layers
.. seealso:: :py:func:`prepareMasks`

View File

@ -113,9 +113,22 @@ Default constructor
QgsSymbolLayerReference( const QString &layerId, const QgsSymbolLayerId &symbolLayer );
%Docstring
Constructor
:param layerId: layer id
:param symbolLayer: symbol layer id
.. deprecated:: QGIS 3.30
%End
QgsSymbolLayerReference( const QString &layerId, const QString &symbolLayerId );
%Docstring
Constructor
:param layerId: layer id
:param symbolLayerId: symbol layer id
.. versionadded:: 3.30
%End
QString layerId() const;
%Docstring

View File

@ -1043,6 +1043,8 @@ key (rule for :py:class:`QgsRuleBasedRenderer` for instance) and index path, so
to new ones.
.. versionadded:: 3.30
.. deprecated:: QGIS 3.30
%End
static void clearSymbolLayerIds( QgsSymbol *symbol );

View File

@ -164,7 +164,7 @@ class CORE_EXPORT QgsRenderContext : public QgsTemporalRangeObject
*
* Sets the list of disabled symbol layer ids.
* \see disabledSymbolLayersV2()
* \see isSymbolLayerEnabledV2()
* \see isSymbolLayerEnabled()
* \since QGIS 3.30
*/
void setDisabledSymbolLayersV2( const QSet<QString> &symbolLayers );

View File

@ -626,8 +626,8 @@ class CORE_EXPORT QgsSymbolLayer
/**
* Prepares all mask internal objects according to what is defined in \a context
* This should be called prior to calling startRender() method.
* \see addSymbolLayerClipPath()
* \see symbolLayerClipPaths()
* \see QgsRenderContext::addSymbolLayerClipPath()
* \see QgsRenderContext::symbolLayerClipPaths()
* \since QGIS 3.26
*/
virtual void prepareMasks( const QgsSymbolRenderContext &context );
@ -700,7 +700,7 @@ class CORE_EXPORT QgsSymbolLayer
void copyPaintEffect( QgsSymbolLayer *destLayer ) const;
/**
* When renderering, install masks on \a context painter
* When rendering, install masks on \a context painter
* if \a recursive is TRUE masks are installed recursively for all children symbol layers
* \see prepareMasks()
* \see removeMasks()
@ -709,7 +709,7 @@ class CORE_EXPORT QgsSymbolLayer
void installMasks( QgsRenderContext &context, bool recursive );
/**
* When renderering, remove previously installed masks from \a context painter
* When rendering, remove previously installed masks from \a context painter
* if \a recursive is TRUE masks are removed recursively for all children symbol layers
* \see prepareMasks()
* \see installMasks()

View File

@ -140,11 +140,22 @@ class CORE_EXPORT QgsSymbolLayerReference
//! Default constructor
QgsSymbolLayerReference() = default;
//! Constructor
/**
* Constructor
* \param layerId layer id
* \param symbolLayer symbol layer id
* \deprecated since QGIS 3.30
*/
Q_DECL_DEPRECATED QgsSymbolLayerReference( const QString &layerId, const QgsSymbolLayerId &symbolLayer )
: mLayerId( layerId ), mDeprecatedSymbolLayerId( symbolLayer )
{}
/**
* Constructor
* \param layerId layer id
* \param symbolLayerId symbol layer id
* \since QGIS 3.30
*/
QgsSymbolLayerReference( const QString &layerId, const QString &symbolLayerId )
: mLayerId( layerId ), mSymbolLayerId( symbolLayerId )
{}

View File

@ -934,6 +934,7 @@ class CORE_EXPORT QgsSymbolLayerUtils
* key (rule for QgsRuleBasedRenderer for instance) and index path, so this method migrates \a mapLayers old references
* to new ones.
* \since QGIS 3.30
* \deprecated since QGIS 3.30
*/
Q_DECL_DEPRECATED static void fixOldSymbolLayerReferences( const QMap<QString, QgsMapLayer *> &mapLayers );