Skip to content

Commit

Permalink
update QGIS version in the doxygen comments
Browse files Browse the repository at this point in the history
  • Loading branch information
alexbruy committed Jul 2, 2024
1 parent f1ef864 commit 790b1a5
Show file tree
Hide file tree
Showing 14 changed files with 24 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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/ );
Expand Down
2 changes: 1 addition & 1 deletion python/PyQt6/gui/auto_generated/qgsgui.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -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/;
Expand Down
2 changes: 1 addition & 1 deletion python/gui/auto_additions/qgsprocessingtoolboxmodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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/ );
Expand Down
2 changes: 1 addition & 1 deletion python/gui/auto_generated/qgsgui.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -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/;
Expand Down
2 changes: 1 addition & 1 deletion src/gui/processing/qgsprocessingfavoritealgorithmlog.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
8 changes: 4 additions & 4 deletions src/gui/processing/qgsprocessingtoolboxmodel.h
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions src/gui/processing/qgsprocessingtoolboxtreeview.h
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion src/gui/qgsgui.h
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down

0 comments on commit 790b1a5

Please sign in to comment.