Skip to content

Commit f57c548

Browse files
nyalldawsonnyalldawson
committedJul 16, 2018
Fix documentation test failures
·
ltr-3_40final-3_4_0
1 parent 3180988 commit f57c548

File tree

6 files changed

+26
-17
lines changed

6 files changed

+26
-17
lines changed
 

‎python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,11 @@ class QgsProcessingToolboxModelRecentNode : QgsProcessingToolboxModelNode
101101
%Docstring
102102
Processing toolbox model node corresponding to the recent algorithms group
103103

104-
.. versionadded:: 3.4
105-
106104
.. warning::
107105

108106
Not part of stable API and may change in future QGIS releases.
107+
108+
.. versionadded:: 3.4
109109
%End
110110

111111
%TypeHeaderCode
@@ -127,11 +127,11 @@ class QgsProcessingToolboxModelProviderNode : QgsProcessingToolboxModelNode
127127
%Docstring
128128
Processing toolbox model node corresponding to a Processing provider.
129129

130-
.. versionadded:: 3.4
131-
132130
.. warning::
133131

134132
Not part of stable API and may change in future QGIS releases.
133+
134+
.. versionadded:: 3.4
135135
%End
136136

137137
%TypeHeaderCode
@@ -164,11 +164,11 @@ class QgsProcessingToolboxModelGroupNode : QgsProcessingToolboxModelNode
164164
%Docstring
165165
Processing toolbox model node corresponding to a group of algorithms.
166166

167-
.. versionadded:: 3.4
168-
169167
.. warning::
170168

171169
Not part of stable API and may change in future QGIS releases.
170+
171+
.. versionadded:: 3.4
172172
%End
173173

174174
%TypeHeaderCode
@@ -204,11 +204,11 @@ class QgsProcessingToolboxModelAlgorithmNode : QgsProcessingToolboxModelNode
204204
%Docstring
205205
Processing toolbox model node corresponding to an algorithm.
206206

207-
.. versionadded:: 3.4
208-
209207
.. warning::
210208

211209
Not part of stable API and may change in future QGIS releases.
210+
211+
.. versionadded:: 3.4
212212
%End
213213

214214
%TypeHeaderCode
@@ -394,7 +394,7 @@ from the given registry. If no registry is specified, then the processing
394394
registry attached to QgsApplication.processingRegistry() will be used
395395
by the model.
396396

397-
If \recentLog is specified then it will be used to create a "Recently used" top
397+
If ``recentLog`` is specified then it will be used to create a "Recently used" top
398398
level group containing recently used algorithms.
399399
%End
400400

‎python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ class QgsProcessingToolboxTreeView : QTreeView
1515
%Docstring
1616
Processing toolbox tree view, showing algorithms and providers in a tree structure.
1717

18-
.. versionadded:: 3.4
19-
2018
.. warning::
2119

2220
Not part of stable API and may change in future QGIS releases.
21+
22+
.. versionadded:: 3.4
2323
%End
2424

2525
%TypeHeaderCode

‎src/gui/processing/qgsprocessingtoolboxmodel.cpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
#include "modeltest.h"
2424
#endif
2525

26+
///@cond PRIVATE
27+
2628
//
2729
// QgsProcessingToolboxModelNode
2830
//
@@ -104,6 +106,8 @@ const QgsProcessingAlgorithm *QgsProcessingToolboxModelAlgorithmNode::algorithm(
104106
return mAlgorithm;
105107
}
106108

109+
///@endcond
110+
107111
//
108112
// QgsProcessingToolboxModel
109113
//

‎src/gui/processing/qgsprocessingtoolboxmodel.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ class GUI_EXPORT QgsProcessingToolboxModelNode : public QObject
129129
/**
130130
* Processing toolbox model node corresponding to the recent algorithms group
131131
* \ingroup gui
132-
* \since QGIS 3.4
133132
* \warning Not part of stable API and may change in future QGIS releases.
133+
* \since QGIS 3.4
134134
*/
135135
class GUI_EXPORT QgsProcessingToolboxModelRecentNode : public QgsProcessingToolboxModelNode
136136
{
@@ -150,8 +150,8 @@ class GUI_EXPORT QgsProcessingToolboxModelRecentNode : public QgsProcessingToolb
150150
/**
151151
* Processing toolbox model node corresponding to a Processing provider.
152152
* \ingroup gui
153-
* \since QGIS 3.4
154153
* \warning Not part of stable API and may change in future QGIS releases.
154+
* \since QGIS 3.4
155155
*/
156156
class GUI_EXPORT QgsProcessingToolboxModelProviderNode : public QgsProcessingToolboxModelNode
157157
{
@@ -187,8 +187,8 @@ class GUI_EXPORT QgsProcessingToolboxModelProviderNode : public QgsProcessingToo
187187
/**
188188
* Processing toolbox model node corresponding to a group of algorithms.
189189
* \ingroup gui
190-
* \since QGIS 3.4
191190
* \warning Not part of stable API and may change in future QGIS releases.
191+
* \since QGIS 3.4
192192
*/
193193
class GUI_EXPORT QgsProcessingToolboxModelGroupNode : public QgsProcessingToolboxModelNode
194194
{
@@ -226,8 +226,8 @@ class GUI_EXPORT QgsProcessingToolboxModelGroupNode : public QgsProcessingToolbo
226226
/**
227227
* Processing toolbox model node corresponding to an algorithm.
228228
* \ingroup gui
229-
* \since QGIS 3.4
230229
* \warning Not part of stable API and may change in future QGIS releases.
230+
* \since QGIS 3.4
231231
*/
232232
class GUI_EXPORT QgsProcessingToolboxModelAlgorithmNode : public QgsProcessingToolboxModelNode
233233
{
@@ -413,6 +413,7 @@ class GUI_EXPORT QgsProcessingToolboxProxyModel: public QSortFilterProxyModel
413413

414414
public:
415415

416+
//! Available filter flags for filtering the model
416417
enum Filter
417418
{
418419
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
429430
* registry attached to QgsApplication::processingRegistry() will be used
430431
* by the model.
431432
*
432-
* If \recentLog is specified then it will be used to create a "Recently used" top
433+
* If \a recentLog is specified then it will be used to create a "Recently used" top
433434
* level group containing recently used algorithms.
434435
*/
435436
explicit QgsProcessingToolboxProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr,

‎src/gui/processing/qgsprocessingtoolboxtreeview.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
#include "qgsprocessingtoolboxtreeview.h"
1717
#include "qgsprocessingtoolboxmodel.h"
1818

19+
///@cond PRIVATE
20+
1921
QgsProcessingToolboxTreeView::QgsProcessingToolboxTreeView( QWidget *parent,
2022
QgsProcessingRegistry *registry,
2123
QgsProcessingRecentAlgorithmLog *recentLog )
@@ -107,3 +109,4 @@ QModelIndex QgsProcessingToolboxTreeView::findFirstVisibleAlgorithm( const QMode
107109
return QModelIndex();
108110
}
109111

112+
///@endcond

‎src/gui/processing/qgsprocessingtoolboxtreeview.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ class QgsProcessingAlgorithm;
3030
/**
3131
* Processing toolbox tree view, showing algorithms and providers in a tree structure.
3232
* \ingroup gui
33-
* \since QGIS 3.4
3433
* \warning Not part of stable API and may change in future QGIS releases.
34+
* \since QGIS 3.4
3535
*/
3636
class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView
3737
{
@@ -105,4 +105,5 @@ class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView
105105

106106
};
107107

108+
///@endcond
108109
#endif // QGSPROCESSINGTOOLBOXTREEVIEW_H

0 commit comments

Comments
 (0)
Please sign in to comment.