Skip to content
Permalink
Browse files

Fix documentation test failures

  • Loading branch information
nyalldawson committed Jul 10, 2018
1 parent 3180988 commit f57c548ec3c2114f99ece37e78764a5652bb0fac
@@ -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

@@ -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
@@ -23,6 +23,8 @@
#include "modeltest.h"
#endif

///@cond PRIVATE

//
// QgsProcessingToolboxModelNode
//
@@ -104,6 +106,8 @@ const QgsProcessingAlgorithm *QgsProcessingToolboxModelAlgorithmNode::algorithm(
return mAlgorithm;
}

///@endcond

//
// QgsProcessingToolboxModel
//
@@ -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,
@@ -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
@@ -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

0 comments on commit f57c548

Please sign in to comment.
You can’t perform that action at this time.