From 790b1a533c63cf884f318ec65e8df66ab9d5d966 Mon Sep 17 00:00:00 2001 From: Alexander Bruy Date: Tue, 2 Jul 2024 12:43:32 +0100 Subject: [PATCH] update QGIS version in the doxygen comments --- .../PyQt6/gui/auto_additions/qgsprocessingtoolboxmodel.py | 2 +- .../processing/qgsprocessingfavoritealgorithmlog.sip.in | 2 +- .../processing/qgsprocessingtoolboxmodel.sip.in | 6 +++--- .../processing/qgsprocessingtoolboxtreeview.sip.in | 4 ++-- python/PyQt6/gui/auto_generated/qgsgui.sip.in | 2 +- python/gui/auto_additions/qgsprocessingtoolboxmodel.py | 2 +- .../processing/qgsprocessingfavoritealgorithmlog.sip.in | 2 +- .../processing/qgsprocessingtoolboxmodel.sip.in | 6 +++--- .../processing/qgsprocessingtoolboxtreeview.sip.in | 4 ++-- python/gui/auto_generated/qgsgui.sip.in | 2 +- src/gui/processing/qgsprocessingfavoritealgorithmlog.h | 2 +- src/gui/processing/qgsprocessingtoolboxmodel.h | 8 ++++---- src/gui/processing/qgsprocessingtoolboxtreeview.h | 4 ++-- src/gui/qgsgui.h | 2 +- 14 files changed, 24 insertions(+), 24 deletions(-) diff --git a/python/PyQt6/gui/auto_additions/qgsprocessingtoolboxmodel.py b/python/PyQt6/gui/auto_additions/qgsprocessingtoolboxmodel.py index fd0aad0cd793..9e92d5de2987 100644 --- a/python/PyQt6/gui/auto_additions/qgsprocessingtoolboxmodel.py +++ b/python/PyQt6/gui/auto_additions/qgsprocessingtoolboxmodel.py @@ -19,7 +19,7 @@ QgsProcessingToolboxModelNode.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite QgsProcessingToolboxModelNode.NodeType.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite 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.baseClass = QgsProcessingToolboxModelNode diff --git a/python/PyQt6/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in b/python/PyQt6/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in index b3507c47447d..951680377381 100644 --- a/python/PyQt6/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in +++ b/python/PyQt6/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in @@ -24,7 +24,7 @@ The log contents are saved and restored via :py:class:`QgsSettings`. Not stable API -.. versionadded:: 3.38 +.. versionadded:: 3.40 %End %TypeHeaderCode diff --git a/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in b/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in index c3be88d7bc98..95ce3d668c05 100644 --- a/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in +++ b/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in @@ -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. -.. versionadded:: 3.38 +.. versionadded:: 3.40 %End %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. 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 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. 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 QgsProcessingToolboxModel *toolboxModel(); diff --git a/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in b/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in index a956df038449..76b279734c19 100644 --- a/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in +++ b/python/PyQt6/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in @@ -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. 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 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. 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 void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model /Transfer/ ); diff --git a/python/PyQt6/gui/auto_generated/qgsgui.sip.in b/python/PyQt6/gui/auto_generated/qgsgui.sip.in index a59168058014..7896c6cc7bd3 100644 --- a/python/PyQt6/gui/auto_generated/qgsgui.sip.in +++ b/python/PyQt6/gui/auto_generated/qgsgui.sip.in @@ -112,7 +112,7 @@ Returns the global processing recent algorithm log, used for tracking recently u %Docstring Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms. -.. versionadded:: 3.38 +.. versionadded:: 3.40 %End static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() /KeepReference/; diff --git a/python/gui/auto_additions/qgsprocessingtoolboxmodel.py b/python/gui/auto_additions/qgsprocessingtoolboxmodel.py index 4c0090c622bd..b0e0fbf14458 100644 --- a/python/gui/auto_additions/qgsprocessingtoolboxmodel.py +++ b/python/gui/auto_additions/qgsprocessingtoolboxmodel.py @@ -19,7 +19,7 @@ QgsProcessingToolboxModelNode.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite QgsProcessingToolboxModelNode.NodeType.NodeFavorite = QgsProcessingToolboxModelNode.NodeType.Favorite 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.baseClass = QgsProcessingToolboxModelNode diff --git a/python/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in b/python/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in index b3507c47447d..951680377381 100644 --- a/python/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in +++ b/python/gui/auto_generated/processing/qgsprocessingfavoritealgorithmlog.sip.in @@ -24,7 +24,7 @@ The log contents are saved and restored via :py:class:`QgsSettings`. Not stable API -.. versionadded:: 3.38 +.. versionadded:: 3.40 %End %TypeHeaderCode diff --git a/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in b/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in index 5eb83dbe26dd..dc5f1b8ceebf 100644 --- a/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in +++ b/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in @@ -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. -.. versionadded:: 3.38 +.. versionadded:: 3.40 %End %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. 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 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. 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 QgsProcessingToolboxModel *toolboxModel(); diff --git a/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in b/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in index a956df038449..76b279734c19 100644 --- a/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in +++ b/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in @@ -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. 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 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. 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 void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model /Transfer/ ); diff --git a/python/gui/auto_generated/qgsgui.sip.in b/python/gui/auto_generated/qgsgui.sip.in index 1fb7ccd8aa32..dad447068463 100644 --- a/python/gui/auto_generated/qgsgui.sip.in +++ b/python/gui/auto_generated/qgsgui.sip.in @@ -112,7 +112,7 @@ Returns the global processing recent algorithm log, used for tracking recently u %Docstring Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms. -.. versionadded:: 3.38 +.. versionadded:: 3.40 %End static QgsDataItemGuiProviderRegistry *dataItemGuiProviderRegistry() /KeepReference/; diff --git a/src/gui/processing/qgsprocessingfavoritealgorithmlog.h b/src/gui/processing/qgsprocessingfavoritealgorithmlog.h index 42c35bc51e21..a7812ed9f7dd 100644 --- a/src/gui/processing/qgsprocessingfavoritealgorithmlog.h +++ b/src/gui/processing/qgsprocessingfavoritealgorithmlog.h @@ -33,7 +33,7 @@ class QgsSettingsEntryStringList; * The log contents are saved and restored via QgsSettings. * * \note Not stable API - * \since QGIS 3.38 + * \since QGIS 3.40 */ class GUI_EXPORT QgsProcessingFavoriteAlgorithmLog : public QObject { diff --git a/src/gui/processing/qgsprocessingtoolboxmodel.h b/src/gui/processing/qgsprocessingtoolboxmodel.h index 7f73b7f2814e..26e614adefbe 100644 --- a/src/gui/processing/qgsprocessingtoolboxmodel.h +++ b/src/gui/processing/qgsprocessingtoolboxmodel.h @@ -75,7 +75,7 @@ class GUI_EXPORT QgsProcessingToolboxModelNode : public QObject Group SIP_MONKEYPATCH_COMPAT_NAME( NodeGroup ), //!< Group node Algorithm SIP_MONKEYPATCH_COMPAT_NAME( NodeAlgorithm ), //!< Algorithm 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 ) // *INDENT-ON* @@ -160,7 +160,7 @@ class GUI_EXPORT QgsProcessingToolboxModelRecentNode : public QgsProcessingToolb * \brief Processing toolbox model node corresponding to the favorite algorithms group * \ingroup gui * \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 { @@ -339,7 +339,7 @@ class GUI_EXPORT QgsProcessingToolboxModel : public QAbstractItemModel * level group containing recently used algorithms. * * 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, QgsProcessingRecentAlgorithmLog *recentLog = nullptr, @@ -497,7 +497,7 @@ class GUI_EXPORT QgsProcessingToolboxProxyModel: public QSortFilterProxyModel * level group containing recently used algorithms. * * 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, QgsProcessingRegistry *registry = nullptr, diff --git a/src/gui/processing/qgsprocessingtoolboxtreeview.h b/src/gui/processing/qgsprocessingtoolboxtreeview.h index 142b08997fbf..0d8ffd5cab66 100644 --- a/src/gui/processing/qgsprocessingtoolboxtreeview.h +++ b/src/gui/processing/qgsprocessingtoolboxtreeview.h @@ -51,7 +51,7 @@ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView * level group containing recently used algorithms. * * 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, QgsProcessingRegistry *registry = nullptr, @@ -65,7 +65,7 @@ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView * level group containing recently used algorithms. * * 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( QgsProcessingRegistry *registry, diff --git a/src/gui/qgsgui.h b/src/gui/qgsgui.h index 5fd51ee2dadb..0de720f6bb63 100644 --- a/src/gui/qgsgui.h +++ b/src/gui/qgsgui.h @@ -160,7 +160,7 @@ class GUI_EXPORT QgsGui : public QObject /** * Returns the global Processing favorite algorithm log, used for tracking favorite Processing algorithms. - * \since QGIS 3.38 + * \since QGIS 3.40 */ static QgsProcessingFavoriteAlgorithmLog *processingFavoriteAlgorithmLog();