Skip to content

Commit 1a117cf

Browse files
committed
fix doxygen
1 parent a09b9e7 commit 1a117cf

4 files changed

+30
-1
lines changed

python/gui/qgsoptionsdialoghighlightwidget.sip.in

+7
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,14 @@ This uses stylesheets.
2424
#include "qgsoptionsdialoghighlightwidget.h"
2525
%End
2626
public:
27+
2728
static QgsOptionsDialogHighlightWidget *createWidget( QWidget *widget ) /Factory/;
29+
%Docstring
30+
create a highlight widget implementation for the proper widget type.
31+
For instance a QgsOptionsDialogHighlightButton for button.
32+
@return a QgsOptionsDialogHighlightWidget or a None if there is no implementation
33+
for the given widget.
34+
%End
2835

2936
bool isValid();
3037
%Docstring

python/gui/qgsoptionsdialoghighlightwidgetsimpl.sip.in

+10
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ class QgsOptionsDialogHighlightLabel : QgsOptionsDialogHighlightWidget
1717
%Docstring
1818
A highlight widget for labels.
1919
This is used to search and highlight text in QgsOptionsDialogBase implementations.
20+
21+
.. versionadded:: 3.0
2022
%End
2123

2224
%TypeHeaderCode
@@ -38,6 +40,8 @@ class QgsOptionsDialogHighlightCheckBox : QgsOptionsDialogHighlightWidget
3840
%Docstring
3941
A highlight widget for checkboxes.
4042
This is used to search and highlight text in QgsOptionsDialogBase implementations.
43+
44+
.. versionadded:: 3.0
4145
%End
4246

4347
%TypeHeaderCode
@@ -59,6 +63,8 @@ class QgsOptionsDialogHighlightButton : QgsOptionsDialogHighlightWidget
5963
%Docstring
6064
A highlight widget for buttons.
6165
This is used to search and highlight text in QgsOptionsDialogBase implementations.
66+
67+
.. versionadded:: 3.0
6268
%End
6369

6470
%TypeHeaderCode
@@ -80,6 +86,8 @@ class QgsOptionsDialogHighlightGroupBox : QgsOptionsDialogHighlightWidget
8086
%Docstring
8187
A highlight widget for group boxes.
8288
This is used to search and highlight text in QgsOptionsDialogBase implementations.
89+
90+
.. versionadded:: 3.0
8391
%End
8492

8593
%TypeHeaderCode
@@ -103,6 +111,8 @@ A highlight widget for trees.
103111
This is used to search and highlight text in QgsOptionsDialogBase implementations.
104112
Highlighting is only available for tree widgets only while searching can be performed
105113
in any tree view or inherited class.
114+
115+
.. versionadded:: 3.0
106116
%End
107117

108118
%TypeHeaderCode

src/gui/qgsoptionsdialoghighlightwidget.h

+8-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
/**
2727
* \ingroup gui
28-
* \class QgsSearchHighlightOptionWidget
28+
* \class QgsOptionsDialogHighlightWidget
2929
* Container for a widget to be used to search text in the option dialog
3030
* If the widget type is handled, it is valid.
3131
* It can perform a text search in the widget and highlight it in case of success.
@@ -37,6 +37,13 @@ class GUI_EXPORT QgsOptionsDialogHighlightWidget : public QObject
3737

3838
Q_OBJECT
3939
public:
40+
41+
/**
42+
* create a highlight widget implementation for the proper widget type.
43+
* For instance a QgsOptionsDialogHighlightButton for button.
44+
* @return a QgsOptionsDialogHighlightWidget or a nullptr if there is no implementation
45+
* for the given widget.
46+
*/
4047
static QgsOptionsDialogHighlightWidget *createWidget( QWidget *widget ) SIP_FACTORY;
4148

4249
/**

src/gui/qgsoptionsdialoghighlightwidgetsimpl.h

+5
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ class QTreeWidgetItem;
3838
* \class QgsOptionsDialogHighlightLabel
3939
* A highlight widget for labels.
4040
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
41+
* \since QGIS 3.0
4142
*/
4243
class GUI_EXPORT QgsOptionsDialogHighlightLabel : public QgsOptionsDialogHighlightWidget
4344
{
@@ -58,6 +59,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightLabel : public QgsOptionsDialogHighlig
5859
* \class QgsOptionsDialogHighlightCheckBox
5960
* A highlight widget for checkboxes.
6061
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
62+
* \since QGIS 3.0
6163
*/
6264
class GUI_EXPORT QgsOptionsDialogHighlightCheckBox : public QgsOptionsDialogHighlightWidget
6365
{
@@ -78,6 +80,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightCheckBox : public QgsOptionsDialogHigh
7880
* \class QgsOptionsDialogHighlightButton
7981
* A highlight widget for buttons.
8082
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
83+
* \since QGIS 3.0
8184
*/
8285
class GUI_EXPORT QgsOptionsDialogHighlightButton : public QgsOptionsDialogHighlightWidget
8386
{
@@ -98,6 +101,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightButton : public QgsOptionsDialogHighli
98101
* \class QgsOptionsDialogHighlightGroupBox
99102
* A highlight widget for group boxes.
100103
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
104+
* \since QGIS 3.0
101105
*/
102106
class GUI_EXPORT QgsOptionsDialogHighlightGroupBox : public QgsOptionsDialogHighlightWidget
103107
{
@@ -120,6 +124,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightGroupBox : public QgsOptionsDialogHigh
120124
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
121125
* Highlighting is only available for tree widgets only while searching can be performed
122126
* in any tree view or inherited class.
127+
* \since QGIS 3.0
123128
*/
124129
class GUI_EXPORT QgsOptionsDialogHighlightTree : public QgsOptionsDialogHighlightWidget
125130
{

0 commit comments

Comments
 (0)