update QGIS version in the doxygen comments

This commit is contained in:
Alexander Bruy 2024-07-02 12:43:32 +01:00 committed by Nyall Dawson
parent 40f85dd8e7
commit d5605a3321
14 changed files with 24 additions and 24 deletions

View File

@ -19,7 +19,7 @@ QgsProcessingToolboxModelNode.NodeRecent.__doc__ = "Recent algorithms node"
QgsProcessingToolboxModelNode.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite QgsProcessingToolboxModelNode.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite
QgsProcessingToolboxModelNode.NodeType.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite QgsProcessingToolboxModelNode.NodeType.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite
QgsProcessingToolboxModelNode.NodeFavorite.is_monkey_patched = True QgsProcessingToolboxModelNode.NodeFavorite.is_monkey_patched = True
QgsProcessingToolboxModelNode.NodeFavorite.__doc__ = "Favorites algorithms node, since QGIS 3.38" QgsProcessingToolboxModelNode.NodeFavorite.__doc__ = "Favorites algorithms node, since QGIS 3.40"
QgsProcessingToolboxModelNode.NodeType.__doc__ = "Enumeration of possible model node types\n\n" + '* ``NodeProvider``: ' + QgsProcessingToolboxModelNode.NodeType.Provider.__doc__ + '\n' + '* ``NodeGroup``: ' + QgsProcessingToolboxModelNode.NodeType.Group.__doc__ + '\n' + '* ``NodeAlgorithm``: ' + QgsProcessingToolboxModelNode.NodeType.Algorithm.__doc__ + '\n' + '* ``NodeRecent``: ' + QgsProcessingToolboxModelNode.NodeType.Recent.__doc__ + '\n' + '* ``NodeFavorite``: ' + QgsProcessingToolboxModelNode.NodeType.Favorite.__doc__ QgsProcessingToolboxModelNode.NodeType.__doc__ = "Enumeration of possible model node types\n\n" + '* ``NodeProvider``: ' + QgsProcessingToolboxModelNode.NodeType.Provider.__doc__ + '\n' + '* ``NodeGroup``: ' + QgsProcessingToolboxModelNode.NodeType.Group.__doc__ + '\n' + '* ``NodeAlgorithm``: ' + QgsProcessingToolboxModelNode.NodeType.Algorithm.__doc__ + '\n' + '* ``NodeRecent``: ' + QgsProcessingToolboxModelNode.NodeType.Recent.__doc__ + '\n' + '* ``NodeFavorite``: ' + QgsProcessingToolboxModelNode.NodeType.Favorite.__doc__
# -- # --
QgsProcessingToolboxModelNode.NodeType.baseClass = QgsProcessingToolboxModelNode QgsProcessingToolboxModelNode.NodeType.baseClass = QgsProcessingToolboxModelNode

View File

@ -24,7 +24,7 @@ The log contents are saved and restored via :py:class:`QgsSettings`.
Not stable API Not stable API
.. versionadded:: 3.38 .. versionadded:: 3.40
%End %End
%TypeHeaderCode %TypeHeaderCode

View File

@ -135,7 +135,7 @@ Processing toolbox model node corresponding to the favorite algorithms group
Not part of stable API and may change in future QGIS releases. Not part of stable API and may change in future QGIS releases.
.. versionadded:: 3.38 .. versionadded:: 3.40
%End %End
%TypeHeaderCode %TypeHeaderCode
@ -305,7 +305,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. Since QGIS 3.38 level group containing favorite algorithms. Since QGIS 3.40
%End %End
virtual Qt::ItemFlags flags( const QModelIndex &index ) const; virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
@ -443,7 +443,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. SInce QGIS 3.38 level group containing favorite algorithms. SInce QGIS 3.40
%End %End
QgsProcessingToolboxModel *toolboxModel(); QgsProcessingToolboxModel *toolboxModel();

View File

@ -42,7 +42,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. Since QGIS 3.38 level group containing favorite algorithms. Since QGIS 3.40
%End %End
void setRegistry( void setRegistry(
@ -56,7 +56,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. Since QGIS 3.38 level group containing favorite algorithms. Since QGIS 3.40
%End %End
void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model /Transfer/ ); void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model /Transfer/ );

View File

@ -112,7 +112,7 @@ Returns the global processing recent algorithm log, used for tracking recently u
%Docstring %Docstring
Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms. Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms.
.. versionadded:: 3.38 .. versionadded:: 3.40
%End %End
static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() /KeepReference/; static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() /KeepReference/;

View File

@ -19,7 +19,7 @@ QgsProcessingToolboxModelNode.NodeRecent.__doc__ = "Recent algorithms node"
QgsProcessingToolboxModelNode.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite QgsProcessingToolboxModelNode.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite
QgsProcessingToolboxModelNode.NodeType.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite QgsProcessingToolboxModelNode.NodeType.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite
QgsProcessingToolboxModelNode.NodeFavorite.is_monkey_patched = True QgsProcessingToolboxModelNode.NodeFavorite.is_monkey_patched = True
QgsProcessingToolboxModelNode.NodeFavorite.__doc__ = "Favorites algorithms node, since QGIS 3.38" QgsProcessingToolboxModelNode.NodeFavorite.__doc__ = "Favorites algorithms node, since QGIS 3.40"
QgsProcessingToolboxModelNode.NodeType.__doc__ = "Enumeration of possible model node types\n\n" + '* ``NodeProvider``: ' + QgsProcessingToolboxModelNode.NodeType.Provider.__doc__ + '\n' + '* ``NodeGroup``: ' + QgsProcessingToolboxModelNode.NodeType.Group.__doc__ + '\n' + '* ``NodeAlgorithm``: ' + QgsProcessingToolboxModelNode.NodeType.Algorithm.__doc__ + '\n' + '* ``NodeRecent``: ' + QgsProcessingToolboxModelNode.NodeType.Recent.__doc__ + '\n' + '* ``NodeFavorite``: ' + QgsProcessingToolboxModelNode.NodeType.Favorite.__doc__ QgsProcessingToolboxModelNode.NodeType.__doc__ = "Enumeration of possible model node types\n\n" + '* ``NodeProvider``: ' + QgsProcessingToolboxModelNode.NodeType.Provider.__doc__ + '\n' + '* ``NodeGroup``: ' + QgsProcessingToolboxModelNode.NodeType.Group.__doc__ + '\n' + '* ``NodeAlgorithm``: ' + QgsProcessingToolboxModelNode.NodeType.Algorithm.__doc__ + '\n' + '* ``NodeRecent``: ' + QgsProcessingToolboxModelNode.NodeType.Recent.__doc__ + '\n' + '* ``NodeFavorite``: ' + QgsProcessingToolboxModelNode.NodeType.Favorite.__doc__
# -- # --
QgsProcessingToolboxModelNode.NodeType.baseClass = QgsProcessingToolboxModelNode QgsProcessingToolboxModelNode.NodeType.baseClass = QgsProcessingToolboxModelNode

View File

@ -24,7 +24,7 @@ The log contents are saved and restored via :py:class:`QgsSettings`.
Not stable API Not stable API
.. versionadded:: 3.38 .. versionadded:: 3.40
%End %End
%TypeHeaderCode %TypeHeaderCode

View File

@ -135,7 +135,7 @@ Processing toolbox model node corresponding to the favorite algorithms group
Not part of stable API and may change in future QGIS releases. Not part of stable API and may change in future QGIS releases.
.. versionadded:: 3.38 .. versionadded:: 3.40
%End %End
%TypeHeaderCode %TypeHeaderCode
@ -305,7 +305,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. Since QGIS 3.38 level group containing favorite algorithms. Since QGIS 3.40
%End %End
virtual Qt::ItemFlags flags( const QModelIndex &index ) const; virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
@ -443,7 +443,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. SInce QGIS 3.38 level group containing favorite algorithms. SInce QGIS 3.40
%End %End
QgsProcessingToolboxModel *toolboxModel(); QgsProcessingToolboxModel *toolboxModel();

View File

@ -42,7 +42,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. Since QGIS 3.38 level group containing favorite algorithms. Since QGIS 3.40
%End %End
void setRegistry( void setRegistry(
@ -56,7 +56,7 @@ If ``recentLog`` is specified then it will be used to create a "Recently used" t
level group containing recently used algorithms. level group containing recently used algorithms.
If ``favoriteLog`` is specified then it will be used to create a "Favorites" top If ``favoriteLog`` is specified then it will be used to create a "Favorites" top
level group containing favorite algorithms. Since QGIS 3.38 level group containing favorite algorithms. Since QGIS 3.40
%End %End
void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model /Transfer/ ); void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model /Transfer/ );

View File

@ -112,7 +112,7 @@ Returns the global processing recent algorithm log, used for tracking recently u
%Docstring %Docstring
Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms. Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms.
.. versionadded:: 3.38 .. versionadded:: 3.40
%End %End
static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() /KeepReference/; static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() /KeepReference/;

View File

@ -33,7 +33,7 @@ class QgsSettingsEntryStringList;
* The log contents are saved and restored via QgsSettings. * The log contents are saved and restored via QgsSettings.
* *
* \note Not stable API * \note Not stable API
* \since QGIS 3.38 * \since QGIS 3.40
*/ */
class GUI_EXPORT QgsProcessingFavoriteAlgorithmLog : public QObject class GUI_EXPORT QgsProcessingFavoriteAlgorithmLog : public QObject
{ {

View File

@ -75,7 +75,7 @@ class GUI_EXPORT QgsProcessingToolboxModelNode : public QObject
Group SIP_MONKEYPATCH_COMPAT_NAME( NodeGroup ), //!< Group node Group SIP_MONKEYPATCH_COMPAT_NAME( NodeGroup ), //!< Group node
Algorithm SIP_MONKEYPATCH_COMPAT_NAME( NodeAlgorithm ), //!< Algorithm node Algorithm SIP_MONKEYPATCH_COMPAT_NAME( NodeAlgorithm ), //!< Algorithm node
Recent SIP_MONKEYPATCH_COMPAT_NAME( NodeRecent ), //!< Recent algorithms node Recent SIP_MONKEYPATCH_COMPAT_NAME( NodeRecent ), //!< Recent algorithms node
Favorite SIP_MONKEYPATCH_COMPAT_NAME( NodeFavorite ), //!< Favorites algorithms node, since QGIS 3.38 Favorite SIP_MONKEYPATCH_COMPAT_NAME( NodeFavorite ), //!< Favorites algorithms node, since QGIS 3.40
}; };
Q_ENUM( NodeType ) Q_ENUM( NodeType )
// *INDENT-ON* // *INDENT-ON*
@ -160,7 +160,7 @@ class GUI_EXPORT QgsProcessingToolboxModelRecentNode : public QgsProcessingToolb
* \brief Processing toolbox model node corresponding to the favorite algorithms group * \brief Processing toolbox model node corresponding to the favorite algorithms group
* \ingroup gui * \ingroup gui
* \warning Not part of stable API and may change in future QGIS releases. * \warning Not part of stable API and may change in future QGIS releases.
* \since QGIS 3.38 * \since QGIS 3.40
*/ */
class GUI_EXPORT QgsProcessingToolboxModelFavoriteNode : public QgsProcessingToolboxModelNode class GUI_EXPORT QgsProcessingToolboxModelFavoriteNode : public QgsProcessingToolboxModelNode
{ {
@ -339,7 +339,7 @@ class GUI_EXPORT QgsProcessingToolboxModel : public QAbstractItemModel
* level group containing recently used algorithms. * level group containing recently used algorithms.
* *
* If \a favoriteLog is specified then it will be used to create a "Favorites" top * If \a favoriteLog is specified then it will be used to create a "Favorites" top
* level group containing favorite algorithms. Since QGIS 3.38 * level group containing favorite algorithms. Since QGIS 3.40
*/ */
QgsProcessingToolboxModel( QObject *parent SIP_TRANSFERTHIS = nullptr, QgsProcessingRegistry *registry = nullptr, QgsProcessingToolboxModel( QObject *parent SIP_TRANSFERTHIS = nullptr, QgsProcessingRegistry *registry = nullptr,
QgsProcessingRecentAlgorithmLog *recentLog = nullptr, QgsProcessingRecentAlgorithmLog *recentLog = nullptr,
@ -497,7 +497,7 @@ class GUI_EXPORT QgsProcessingToolboxProxyModel: public QSortFilterProxyModel
* level group containing recently used algorithms. * level group containing recently used algorithms.
* *
* If \a favoriteLog is specified then it will be used to create a "Favorites" top * If \a favoriteLog is specified then it will be used to create a "Favorites" top
* level group containing favorite algorithms. SInce QGIS 3.38 * level group containing favorite algorithms. SInce QGIS 3.40
*/ */
explicit QgsProcessingToolboxProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr, explicit QgsProcessingToolboxProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr,
QgsProcessingRegistry *registry = nullptr, QgsProcessingRegistry *registry = nullptr,

View File

@ -51,7 +51,7 @@ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView
* level group containing recently used algorithms. * level group containing recently used algorithms.
* *
* If \a favoriteLog is specified then it will be used to create a "Favorites" top * If \a favoriteLog is specified then it will be used to create a "Favorites" top
* level group containing favorite algorithms. Since QGIS 3.38 * level group containing favorite algorithms. Since QGIS 3.40
*/ */
QgsProcessingToolboxTreeView( QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsProcessingToolboxTreeView( QWidget *parent SIP_TRANSFERTHIS = nullptr,
QgsProcessingRegistry *registry = nullptr, QgsProcessingRegistry *registry = nullptr,
@ -65,7 +65,7 @@ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView
* level group containing recently used algorithms. * level group containing recently used algorithms.
* *
* If \a favoriteLog is specified then it will be used to create a "Favorites" top * If \a favoriteLog is specified then it will be used to create a "Favorites" top
* level group containing favorite algorithms. Since QGIS 3.38 * level group containing favorite algorithms. Since QGIS 3.40
*/ */
void setRegistry( void setRegistry(
QgsProcessingRegistry *registry, QgsProcessingRegistry *registry,

View File

@ -160,7 +160,7 @@ class GUI_EXPORT QgsGui : public QObject
/** /**
* Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms. * Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms.
* \since QGIS 3.38 * \since QGIS 3.40
*/ */
static QgsProcessingFavoriteAlgorithmLog *processingFavoriteAlgorithmLog(); static QgsProcessingFavoriteAlgorithmLog *processingFavoriteAlgorithmLog();