Skip to content

Commit

Permalink
Fix documentation test failures
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Jul 16, 2018
1 parent 3180988 commit f57c548
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions src/gui/processing/qgsprocessingtoolboxmodel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
#include "modeltest.h"
#endif

///@cond PRIVATE

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

///@endcond

//
// QgsProcessingToolboxModel
//
Expand Down
11 changes: 6 additions & 5 deletions src/gui/processing/qgsprocessingtoolboxmodel.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand All @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
Expand All @@ -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,
Expand Down
3 changes: 3 additions & 0 deletions src/gui/processing/qgsprocessingtoolboxtreeview.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
#include "qgsprocessingtoolboxtreeview.h"
#include "qgsprocessingtoolboxmodel.h"

///@cond PRIVATE

QgsProcessingToolboxTreeView::QgsProcessingToolboxTreeView( QWidget *parent,
QgsProcessingRegistry *registry,
QgsProcessingRecentAlgorithmLog *recentLog )
Expand Down Expand Up @@ -107,3 +109,4 @@ QModelIndex QgsProcessingToolboxTreeView::findFirstVisibleAlgorithm( const QMode
return QModelIndex();
}

///@endcond
3 changes: 2 additions & 1 deletion src/gui/processing/qgsprocessingtoolboxtreeview.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down Expand Up @@ -105,4 +105,5 @@ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView

};

///@endcond
#endif // QGSPROCESSINGTOOLBOXTREEVIEW_H

0 comments on commit f57c548

Please sign in to comment.