diff --git a/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in b/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in index 5fd25e83017..ed2ff190587 100644 --- a/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in +++ b/python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in @@ -101,11 +101,11 @@ class QgsProcessingToolboxModelRecentNode : QgsProcessingToolboxModelNode %Docstring Processing toolbox model node corresponding to the recent algorithms group -.. versionadded:: 3.4 - .. warning:: Not part of stable API and may change in future QGIS releases. + +.. versionadded:: 3.4 %End %TypeHeaderCode @@ -127,11 +127,11 @@ class QgsProcessingToolboxModelProviderNode : QgsProcessingToolboxModelNode %Docstring Processing toolbox model node corresponding to a Processing provider. -.. versionadded:: 3.4 - .. warning:: Not part of stable API and may change in future QGIS releases. + +.. versionadded:: 3.4 %End %TypeHeaderCode @@ -164,11 +164,11 @@ class QgsProcessingToolboxModelGroupNode : QgsProcessingToolboxModelNode %Docstring Processing toolbox model node corresponding to a group of algorithms. -.. versionadded:: 3.4 - .. warning:: Not part of stable API and may change in future QGIS releases. + +.. versionadded:: 3.4 %End %TypeHeaderCode @@ -204,11 +204,11 @@ class QgsProcessingToolboxModelAlgorithmNode : QgsProcessingToolboxModelNode %Docstring Processing toolbox model node corresponding to an algorithm. -.. versionadded:: 3.4 - .. warning:: Not part of stable API and may change in future QGIS releases. + +.. versionadded:: 3.4 %End %TypeHeaderCode @@ -394,7 +394,7 @@ from the given registry. If no registry is specified, then the processing registry attached to QgsApplication.processingRegistry() will be used by the model. -If \recentLog is specified then it will be used to create a "Recently used" top +If ``recentLog`` is specified then it will be used to create a "Recently used" top level group containing recently used algorithms. %End diff --git a/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in b/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in index 53ec8fb1372..880e20555ae 100644 --- a/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in +++ b/python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in @@ -15,11 +15,11 @@ class QgsProcessingToolboxTreeView : QTreeView %Docstring Processing toolbox tree view, showing algorithms and providers in a tree structure. -.. versionadded:: 3.4 - .. warning:: Not part of stable API and may change in future QGIS releases. + +.. versionadded:: 3.4 %End %TypeHeaderCode diff --git a/src/gui/processing/qgsprocessingtoolboxmodel.cpp b/src/gui/processing/qgsprocessingtoolboxmodel.cpp index 1f307feae96..b8018dc3cdc 100644 --- a/src/gui/processing/qgsprocessingtoolboxmodel.cpp +++ b/src/gui/processing/qgsprocessingtoolboxmodel.cpp @@ -23,6 +23,8 @@ #include "modeltest.h" #endif +///@cond PRIVATE + // // QgsProcessingToolboxModelNode // @@ -104,6 +106,8 @@ const QgsProcessingAlgorithm *QgsProcessingToolboxModelAlgorithmNode::algorithm( return mAlgorithm; } +///@endcond + // // QgsProcessingToolboxModel // diff --git a/src/gui/processing/qgsprocessingtoolboxmodel.h b/src/gui/processing/qgsprocessingtoolboxmodel.h index 1ac401772f2..d688903b0a1 100644 --- a/src/gui/processing/qgsprocessingtoolboxmodel.h +++ b/src/gui/processing/qgsprocessingtoolboxmodel.h @@ -129,8 +129,8 @@ class GUI_EXPORT QgsProcessingToolboxModelNode : public QObject /** * Processing toolbox model node corresponding to the recent algorithms group * \ingroup gui - * \since QGIS 3.4 * \warning Not part of stable API and may change in future QGIS releases. + * \since QGIS 3.4 */ class GUI_EXPORT QgsProcessingToolboxModelRecentNode : public QgsProcessingToolboxModelNode { @@ -150,8 +150,8 @@ class GUI_EXPORT QgsProcessingToolboxModelRecentNode : public QgsProcessingToolb /** * Processing toolbox model node corresponding to a Processing provider. * \ingroup gui - * \since QGIS 3.4 * \warning Not part of stable API and may change in future QGIS releases. + * \since QGIS 3.4 */ class GUI_EXPORT QgsProcessingToolboxModelProviderNode : public QgsProcessingToolboxModelNode { @@ -187,8 +187,8 @@ class GUI_EXPORT QgsProcessingToolboxModelProviderNode : public QgsProcessingToo /** * Processing toolbox model node corresponding to a group of algorithms. * \ingroup gui - * \since QGIS 3.4 * \warning Not part of stable API and may change in future QGIS releases. + * \since QGIS 3.4 */ class GUI_EXPORT QgsProcessingToolboxModelGroupNode : public QgsProcessingToolboxModelNode { @@ -226,8 +226,8 @@ class GUI_EXPORT QgsProcessingToolboxModelGroupNode : public QgsProcessingToolbo /** * Processing toolbox model node corresponding to an algorithm. * \ingroup gui - * \since QGIS 3.4 * \warning Not part of stable API and may change in future QGIS releases. + * \since QGIS 3.4 */ class GUI_EXPORT QgsProcessingToolboxModelAlgorithmNode : public QgsProcessingToolboxModelNode { @@ -413,6 +413,7 @@ class GUI_EXPORT QgsProcessingToolboxProxyModel: public QSortFilterProxyModel public: + //! Available filter flags for filtering the model enum Filter { FilterToolbox = 1 << 1, //!< Filters out any algorithms and content which should not be shown in the toolbox @@ -429,7 +430,7 @@ class GUI_EXPORT QgsProcessingToolboxProxyModel: public QSortFilterProxyModel * registry attached to QgsApplication::processingRegistry() will be used * by the model. * - * If \recentLog is specified then it will be used to create a "Recently used" top + * If \a recentLog is specified then it will be used to create a "Recently used" top * level group containing recently used algorithms. */ explicit QgsProcessingToolboxProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr, diff --git a/src/gui/processing/qgsprocessingtoolboxtreeview.cpp b/src/gui/processing/qgsprocessingtoolboxtreeview.cpp index 54202c37e5e..b6a9aa1aa8f 100644 --- a/src/gui/processing/qgsprocessingtoolboxtreeview.cpp +++ b/src/gui/processing/qgsprocessingtoolboxtreeview.cpp @@ -16,6 +16,8 @@ #include "qgsprocessingtoolboxtreeview.h" #include "qgsprocessingtoolboxmodel.h" +///@cond PRIVATE + QgsProcessingToolboxTreeView::QgsProcessingToolboxTreeView( QWidget *parent, QgsProcessingRegistry *registry, QgsProcessingRecentAlgorithmLog *recentLog ) @@ -107,3 +109,4 @@ QModelIndex QgsProcessingToolboxTreeView::findFirstVisibleAlgorithm( const QMode return QModelIndex(); } +///@endcond diff --git a/src/gui/processing/qgsprocessingtoolboxtreeview.h b/src/gui/processing/qgsprocessingtoolboxtreeview.h index bf6e24ee696..bd79bf52dc6 100644 --- a/src/gui/processing/qgsprocessingtoolboxtreeview.h +++ b/src/gui/processing/qgsprocessingtoolboxtreeview.h @@ -30,8 +30,8 @@ class QgsProcessingAlgorithm; /** * Processing toolbox tree view, showing algorithms and providers in a tree structure. * \ingroup gui - * \since QGIS 3.4 * \warning Not part of stable API and may change in future QGIS releases. + * \since QGIS 3.4 */ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView { @@ -105,4 +105,5 @@ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView }; +///@endcond #endif // QGSPROCESSINGTOOLBOXTREEVIEW_H