Skip to content

Commit 22ea3ac

Browse files
alexbruyalexbruy
committedApr 8, 2017
homogenize doxygen comments
·
ltr-3_40final-3_0_0
1 parent 8b7a6b8 commit 22ea3ac

File tree

2 files changed

+57
-57
lines changed

2 files changed

+57
-57
lines changed
 

‎python/gui/qgscheckablecombobox.sip

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,66 +26,66 @@ class QgsCheckableComboBox : QComboBox
2626
QgsCheckableComboBox( QWidget *parent = 0 );
2727
%Docstring
2828
Constructor for QgsCheckableComboBox.
29-
@param parent parent object
29+
\param parent parent object
3030
%End
3131

3232
QString separator() const;
3333
%Docstring
3434
Returns separator used to separate items in the display text.
35-
@see setSeparator()
35+
\see setSeparator()
3636
%End
3737

3838
void setSeparator( const QString &separator );
3939
%Docstring
4040
Set separator used to separate items in the display text.
41-
@param separator separator to use
42-
@see separator()
41+
\param separator separator to use
42+
\see separator()
4343
%End
4444

4545
QString defaultText() const;
4646
%Docstring
4747
Returns default text which will be displayed in the widget
4848
when no items selected.
49-
@see setDefaultText()
49+
\see setDefaultText()
5050
%End
5151

5252
void setDefaultText( const QString &text );
5353
%Docstring
5454
Set default text which will be displayed in the widget when
5555
no items selected.
56-
@param text default text
57-
@see defaultText()
56+
\param text default text
57+
\see defaultText()
5858
%End
5959

6060
QStringList checkedItems() const;
6161
%Docstring
6262
Returns currently checked items.
63-
@see setCheckedItems()
63+
\see setCheckedItems()
6464
%End
6565

6666
Qt::CheckState itemCheckState( int index ) const;
6767
%Docstring
6868
Returns the checked state of the item identified by index
69-
@param index item index
70-
@see setItemCheckState()
71-
@see toggleItemCheckState()
69+
\param index item index
70+
\see setItemCheckState()
71+
\see toggleItemCheckState()
7272
%End
7373

7474
void setItemCheckState( int index, Qt::CheckState state );
7575
%Docstring
7676
Sets the item check state to state
77-
@param index item index
78-
@param state check state
79-
@see itemCheckState()
80-
@see toggleItemCheckState()
77+
\param index item index
78+
\param state check state
79+
\see itemCheckState()
80+
\see toggleItemCheckState()
8181
%End
8282

8383
void toggleItemCheckState( int index );
8484
%Docstring
8585
Toggles the item check state
86-
@param index item index
87-
@see itemCheckState()
88-
@see setItemCheckState()
86+
\param index item index
87+
\see itemCheckState()
88+
\see setItemCheckState()
8989
%End
9090

9191
virtual void hidePopup();
@@ -111,8 +111,8 @@ class QgsCheckableComboBox : QComboBox
111111
void setCheckedItems( const QStringList &items );
112112
%Docstring
113113
Set items which should be checked/selected.
114-
@param items items to select
115-
@see checkedItems()
114+
\param items items to select
115+
\see checkedItems()
116116
%End
117117

118118
protected:

‎src/gui/qgscheckablecombobox.h

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ class QEvent;
3131
* \ingroup gui
3232
* QStandardItemModel subclass which makes all items checkable
3333
* by default.
34-
* @note added in QGIS 3.0
35-
* @note not available in Python bindings
34+
* \note added in QGIS 3.0
35+
* \note not available in Python bindings
3636
**/
3737
#ifndef SIP_RUN
3838
class QgsCheckableItemModel : public QStandardItemModel
@@ -42,29 +42,29 @@ class QgsCheckableItemModel : public QStandardItemModel
4242
public:
4343

4444
/** Constructor for QgsCheckableItemModel.
45-
* @param parent parent object
45+
* \param parent parent object
4646
*/
4747
QgsCheckableItemModel( QObject *parent = nullptr );
4848

4949
/** Returns a combination of the item flags: items are enabled
5050
* (ItemIsEnabled), selectable (ItemIsSelectable) and checkable
5151
* (ItemIsUserCheckable).
52-
* @param index item index
52+
* \param index item index
5353
*/
5454
virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
5555

5656
/** Returns the data stored under the given role for the item
5757
* referred to by the index.
58-
* @param index item index
59-
* @param role data role
58+
* \param index item index
59+
* \param role data role
6060
*/
6161
virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const;
6262

6363
/** Sets the role data for the item at index to value.
64-
* @param index item index
65-
* @param value data value
66-
* @param role data role
67-
* @returns true on success, false otherwise
64+
* \param index item index
65+
* \param value data value
66+
* \param role data role
67+
* \returns true on success, false otherwise
6868
*/
6969
virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole );
7070

@@ -80,8 +80,8 @@ class QgsCheckableItemModel : public QStandardItemModel
8080
* \ingroup gui
8181
* QStyledItemDelegate subclass for QgsCheckableComboBox. Needed for
8282
* correct drawing of the checkable items on Mac and GTK.
83-
* @note added in QGIS 3.0
84-
* @note not available in Python bindings
83+
* \note added in QGIS 3.0
84+
* \note not available in Python bindings
8585
**/
8686

8787
class QgsCheckBoxDelegate : public QStyledItemDelegate
@@ -91,15 +91,15 @@ class QgsCheckBoxDelegate : public QStyledItemDelegate
9191
public:
9292

9393
/** Constructor for QgsCheckBoxDelegate.
94-
* @param parent parent object
94+
* \param parent parent object
9595
*/
9696
QgsCheckBoxDelegate( QObject *parent = nullptr );
9797

9898
/** Renders the delegate using the given painter and style option
9999
* for the item specified by index.
100-
* @param painter painter to use
101-
* @param option style option
102-
* @param index item index
100+
* \param painter painter to use
101+
* \param option style option
102+
* \param index item index
103103
*/
104104
virtual void paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const;
105105
};
@@ -108,7 +108,7 @@ class QgsCheckBoxDelegate : public QStyledItemDelegate
108108
/** \class QgsCheckableComboBox
109109
* \ingroup gui
110110
* QComboBox subclass which allows selecting multiple items.
111-
* @note added in QGIS 3.0
111+
* \note added in QGIS 3.0
112112
**/
113113

114114
class GUI_EXPORT QgsCheckableComboBox : public QComboBox
@@ -122,58 +122,58 @@ class GUI_EXPORT QgsCheckableComboBox : public QComboBox
122122
public:
123123

124124
/** Constructor for QgsCheckableComboBox.
125-
* @param parent parent object
125+
* \param parent parent object
126126
*/
127127
QgsCheckableComboBox( QWidget *parent = nullptr );
128128

129129
/** Returns separator used to separate items in the display text.
130-
* @see setSeparator()
130+
* \see setSeparator()
131131
*/
132132
QString separator() const;
133133

134134
/** Set separator used to separate items in the display text.
135-
* @param separator separator to use
136-
* @see separator()
135+
* \param separator separator to use
136+
* \see separator()
137137
*/
138138
void setSeparator( const QString &separator );
139139

140140
/** Returns default text which will be displayed in the widget
141141
* when no items selected.
142-
* @see setDefaultText()
142+
* \see setDefaultText()
143143
*/
144144
QString defaultText() const;
145145

146146
/** Set default text which will be displayed in the widget when
147147
* no items selected.
148-
* @param text default text
149-
* @see defaultText()
148+
* \param text default text
149+
* \see defaultText()
150150
*/
151151
void setDefaultText( const QString &text );
152152

153153
/** Returns currently checked items.
154-
* @see setCheckedItems()
154+
* \see setCheckedItems()
155155
*/
156156
QStringList checkedItems() const;
157157

158158
/** Returns the checked state of the item identified by index
159-
* @param index item index
160-
* @see setItemCheckState()
161-
* @see toggleItemCheckState()
159+
* \param index item index
160+
* \see setItemCheckState()
161+
* \see toggleItemCheckState()
162162
*/
163163
Qt::CheckState itemCheckState( int index ) const;
164164

165165
/** Sets the item check state to state
166-
* @param index item index
167-
* @param state check state
168-
* @see itemCheckState()
169-
* @see toggleItemCheckState()
166+
* \param index item index
167+
* \param state check state
168+
* \see itemCheckState()
169+
* \see toggleItemCheckState()
170170
*/
171171
void setItemCheckState( int index, Qt::CheckState state );
172172

173173
/** Toggles the item check state
174-
* @param index item index
175-
* @see itemCheckState()
176-
* @see setItemCheckState()
174+
* \param index item index
175+
* \see itemCheckState()
176+
* \see setItemCheckState()
177177
*/
178178
void toggleItemCheckState( int index );
179179

@@ -195,8 +195,8 @@ class GUI_EXPORT QgsCheckableComboBox : public QComboBox
195195
public slots:
196196

197197
/** Set items which should be checked/selected.
198-
* @param items items to select
199-
* @see checkedItems()
198+
* \param items items to select
199+
* \see checkedItems()
200200
*/
201201
void setCheckedItems( const QStringList &items );
202202

0 commit comments

Comments
 (0)
Please sign in to comment.