@@ -77,11 +77,11 @@ class CORE_EXPORT QgsSettingsEntryBase
77
77
/* *
78
78
* Constructor for QgsSettingsEntryBase.
79
79
*
80
- * The \a key argument specifies the key of the settings.
81
- * The \a section argument specifies the section.
82
- * The \a defaultValue argument specifies the default value for the settings entry.
83
- * The \a description argument specifies a description for the settings entry.
84
- * The \a options argument specifies the options for the settings entry.
80
+ * \arg key specifies the key of the settings.
81
+ * \arg section specifies the section.
82
+ * \arg defaultValue specifies the default value for the settings entry.
83
+ * \arg description specifies a description for the settings entry.
84
+ * \arg options specifies the options for the settings entry.
85
85
*/
86
86
QgsSettingsEntryBase ( const QString &key,
87
87
const QString §ion,
@@ -97,17 +97,18 @@ class CORE_EXPORT QgsSettingsEntryBase
97
97
/* *
98
98
* Constructor for QgsSettingsEntryBase.
99
99
*
100
- * The \a key argument specifies the key of the settings.
101
- * The \a parent argument specifies the parent in the tree of settings.
102
- * The \a defaultValue argument specifies the default value for the settings entry.
103
- * The \a description argument specifies a description for the settings entry.
104
- * The \a options argument specifies the options for the settings entry.
100
+ * \arg key specifies the key of the settings.
101
+ * \arg parent specifies the parent in the tree of settings.
102
+ * \arg defaultValue specifies the default value for the settings entry.
103
+ * \arg description specifies a description for the settings entry.
104
+ * \arg options specifies the options for the settings entry.
105
+ * \throws QgsSettingsException if the number of given parent named items doesn't match the complete key definition
105
106
*/
106
107
QgsSettingsEntryBase ( const QString &key,
107
108
QgsSettingsTreeElement *parentTreeElement,
108
109
const QVariant &defaultValue = QVariant(),
109
110
const QString &description = QString(),
110
- Qgis::SettingsOptions options = Qgis::SettingsOptions() );
111
+ Qgis::SettingsOptions options = Qgis::SettingsOptions() ) SIP_THROW( QgsSettingsException ) ;
111
112
112
113
/* *
113
114
* Destructor for QgsSettingsEntryBase.
@@ -117,14 +118,14 @@ class CORE_EXPORT QgsSettingsEntryBase
117
118
/* *
118
119
* Returns settings entry key.
119
120
*
120
- * The \a dynamicKeyPart argument specifies the dynamic part of the settings key.
121
+ * \arg dynamicKeyPart specifies the dynamic part of the settings key.
121
122
*/
122
123
QString key ( const QString &dynamicKeyPart = QString() ) const ;
123
124
124
125
/* *
125
126
* Returns settings entry key.
126
127
*
127
- * The \a dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
128
+ * \arg dynamicKeyParts specifies the list of dynamic parts of the settings key.
128
129
*/
129
130
QString key ( const QStringList &dynamicKeyPartList ) const ;
130
131
@@ -135,7 +136,7 @@ class CORE_EXPORT QgsSettingsEntryBase
135
136
* the settings key "NewsFeed/httpsfeedqgisorg/27/content" is valid for the settings entry
136
137
* defined with the key "NewsFeed/%1/%2/content"
137
138
*
138
- * The \a key to check
139
+ * \arg key to check
139
140
*/
140
141
bool keyIsValid ( const QString &key ) const ;
141
142
@@ -160,14 +161,14 @@ class CORE_EXPORT QgsSettingsEntryBase
160
161
/* *
161
162
* Returns TRUE if the settings is contained in the underlying QSettings.
162
163
*
163
- * The \a dynamicKeyPart argument specifies the dynamic part of the settings key.
164
+ * \arg dynamicKeyPart specifies the dynamic part of the settings key.
164
165
*/
165
166
bool exists ( const QString &dynamicKeyPart = QString() ) const ;
166
167
167
168
/* *
168
169
* Returns TRUE if the settings is contained in the underlying QSettings.
169
170
*
170
- * The \a dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
171
+ * \arg dynamicKeyParts specifies the list of dynamic parts of the settings key.
171
172
*/
172
173
bool exists ( const QStringList &dynamicKeyPartList ) const ;
173
174
@@ -181,14 +182,14 @@ class CORE_EXPORT QgsSettingsEntryBase
181
182
/* *
182
183
* Removes the settings from the underlying QSettings.
183
184
*
184
- * The \a dynamicKeyPart argument specifies the dynamic part of the settings key.
185
+ * \arg dynamicKeyPart specifies the dynamic part of the settings key.
185
186
*/
186
187
void remove ( const QString &dynamicKeyPart = QString() ) const ;
187
188
188
189
/* *
189
190
* Removes the settings from the underlying QSettings.
190
191
*
191
- * The \a dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
192
+ * \arg dynamicKeyParts specifies the list of dynamic parts of the settings key.
192
193
*/
193
194
void remove ( const QStringList &dynamicKeyPartList ) const ;
194
195
@@ -202,7 +203,7 @@ class CORE_EXPORT QgsSettingsEntryBase
202
203
* Set settings value.
203
204
*
204
205
* The \a value to set.
205
- * The \a dynamicKeyPart argument specifies the dynamic part of the settings key.
206
+ * \arg dynamicKeyPart specifies the dynamic part of the settings key.
206
207
* \deprecated since QGIS 3.26 use setVariantValuePrivate or an implementation setValue instead
207
208
*/
208
209
Q_DECL_DEPRECATED virtual bool setVariantValue ( const QVariant &value, const QString &dynamicKeyPart = QString() ) const SIP_DEPRECATED;
@@ -211,15 +212,15 @@ class CORE_EXPORT QgsSettingsEntryBase
211
212
* Set settings value.
212
213
*
213
214
* The \a value to set.
214
- * The \a dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
215
+ * \arg dynamicKeyParts specifies the list of dynamic parts of the settings key.
215
216
* \deprecated since QGIS 3.26 use setVariantValuePrivate or an implementation setValue instead
216
217
*/
217
218
Q_DECL_DEPRECATED virtual bool setVariantValue ( const QVariant &value, const QStringList &dynamicKeyPartList ) const SIP_DEPRECATED;
218
219
219
- // ! Returns settings value with the \a dynamicKeyPart argument specifying the dynamic part of the settings key.
220
+ // ! Returns settings value with \arg dynamicKeyPart specifying the dynamic part of the settings key.
220
221
QVariant valueAsVariant ( const QString &dynamicKeyPart = QString() ) const ;
221
222
222
- // ! Returns settings value with the \a dynamicKeyPart argument specifying the dynamic part of the settings key.
223
+ // ! Returns settings value with \arg dynamicKeyPart specifying the dynamic part of the settings key.
223
224
QVariant valueAsVariant ( const QStringList &dynamicKeyPartList ) const ;
224
225
225
226
/* *
@@ -231,8 +232,8 @@ class CORE_EXPORT QgsSettingsEntryBase
231
232
/* *
232
233
* Returns settings value.
233
234
*
234
- * The \a dynamicKeyPartList argument specifies the list of dynamic parts of the settings key.
235
- * The \a defaultValueOverride argument if valid is used instead of the normal default value.
235
+ * \arg dynamicKeyPartList specifies the list of dynamic parts of the settings key.
236
+ * \arg defaultValueOverride if valid is used instead of the normal default value.
236
237
* \since QGIS 3.26
237
238
*/
238
239
QVariant valueAsVariantWithDefaultOverride ( const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList ) const ;
@@ -353,11 +354,12 @@ class QgsSettingsEntryByReference : public QgsSettingsEntryBase
353
354
/* *
354
355
* Constructor for QgsSettingsEntryByReference.
355
356
*
356
- * The \a key argument specifies the key of the settings.
357
- * The \a parent argument specifies the parent in the tree of settings.
358
- * The \a defaultValue argument specifies the default value for the settings entry.
359
- * The \a description argument specifies a description for the settings entry.
360
- * The \a options arguments specifies the options for the settings entry.
357
+ * \arg key specifies the key of the settings.
358
+ * \arg parent specifies the parent in the tree of settings.
359
+ * \arg defaultValue specifies the default value for the settings entry.
360
+ * \arg description specifies a description for the settings entry.
361
+ * \arg optionss specifies the options for the settings entry.
362
+ * \throws QgsSettingsException if the number of given parent named items doesn't match the complete key definition
361
363
*/
362
364
QgsSettingsEntryByReference ( const QString &key,
363
365
QgsSettingsTreeElement *parent,
@@ -370,11 +372,11 @@ class QgsSettingsEntryByReference : public QgsSettingsEntryBase
370
372
/* *
371
373
* Constructor for QgsSettingsEntryByReference.
372
374
*
373
- * The \a key argument specifies the key of the settings.
374
- * The \a section argument specifies the section.
375
- * The \a defaultValue argument specifies the default value for the settings entry.
376
- * The \a description argument specifies a description for the settings entry.
377
- * The \a options arguments specifies the options for the settings entry.
375
+ * \arg key specifies the key of the settings.
376
+ * \arg section specifies the section.
377
+ * \arg defaultValue specifies the default value for the settings entry.
378
+ * \arg description specifies a description for the settings entry.
379
+ * \arg optionss specifies the options for the settings entry.
378
380
*/
379
381
QgsSettingsEntryByReference ( const QString &key,
380
382
const QString §ion,
@@ -436,7 +438,7 @@ class QgsSettingsEntryByReference : public QgsSettingsEntryBase
436
438
* Set settings value.
437
439
*
438
440
* The \a value to set.
439
- * The \a dynamicKeyPart argument specifies the dynamic part of the settings key.
441
+ * \arg dynamicKeyPart specifies the dynamic part of the settings key.
440
442
*/
441
443
bool setValue ( const T &value, const QString &dynamicKeyPart = QString() ) const
442
444
{
@@ -447,7 +449,7 @@ class QgsSettingsEntryByReference : public QgsSettingsEntryBase
447
449
* Set settings value.
448
450
*
449
451
* The \a value to set.
450
- * The \a dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
452
+ * \arg dynamicKeyParts specifies the list of dynamic parts of the settings key.
451
453
*/
452
454
bool setValue ( const T &value, const QStringList &dynamicKeyPartList ) const
453
455
{
@@ -515,12 +517,13 @@ class QgsSettingsEntryByValue : public QgsSettingsEntryBase
515
517
/* *
516
518
* Constructor for QgsSettingsEntryByValue.
517
519
*
518
- * The \a key argument specifies the key of the settings.
519
- * The \a parent argument specifies the parent in the tree of settings.
520
- * The \a section argument specifies the section.
521
- * The \a defaultValue argument specifies the default value for the settings entry.
522
- * The \a description argument specifies a description for the settings entry.
523
- * The \a options arguments specifies the options for the settings entry.
520
+ * \arg key specifies the key of the settings.
521
+ * \arg parent specifies the parent in the tree of settings.
522
+ * \arg section specifies the section.
523
+ * \arg defaultValue specifies the default value for the settings entry.
524
+ * \arg description specifies a description for the settings entry.
525
+ * \arg optionss specifies the options for the settings entry.
526
+ * \throws QgsSettingsException if the number of given parent named items doesn't match the complete key definition
524
527
*/
525
528
QgsSettingsEntryByValue ( const QString &key, QgsSettingsTreeElement *parent, QVariant defaultValue, const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions() )
526
529
: QgsSettingsEntryBase( key, parent, defaultValue, description, options )
@@ -529,11 +532,11 @@ class QgsSettingsEntryByValue : public QgsSettingsEntryBase
529
532
/* *
530
533
* Constructor for QgsSettingsEntryByValue.
531
534
*
532
- * The \a key argument specifies the key of the settings.
533
- * The \a section argument specifies the section.
534
- * The \a defaultValue argument specifies the default value for the settings entry.
535
- * The \a description argument specifies a description for the settings entry.
536
- * The \a options arguments specifies the options for the settings entry.
535
+ * \arg key specifies the key of the settings.
536
+ * \arg section specifies the section.
537
+ * \arg defaultValue specifies the default value for the settings entry.
538
+ * \arg description specifies a description for the settings entry.
539
+ * \arg optionss specifies the options for the settings entry.
537
540
*/
538
541
QgsSettingsEntryByValue ( const QString &key, const QString §ion, QVariant defaultValue, const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions() )
539
542
: QgsSettingsEntryBase( key, section, defaultValue, description, options )
@@ -544,16 +547,16 @@ class QgsSettingsEntryByValue : public QgsSettingsEntryBase
544
547
/* *
545
548
* Returns settings value.
546
549
*
547
- * The \a dynamicKeyPart argument specifies the dynamic part of the settings key.
548
- * The \a defaultValueOverride argument if valid is used instead of the normal default value.
550
+ * \arg dynamicKeyPart specifies the dynamic part of the settings key.
551
+ * \arg defaultValueOverride if valid is used instead of the normal default value.
549
552
*/
550
553
T value ( const QString &dynamicKeyPart = QString() ) const { return this ->convertFromVariant ( valueAsVariant ( dynamicKeyPart ) );}
551
554
552
555
/* *
553
556
* Returns settings value.
554
557
*
555
- * The \a dynamicKeyPartList argument specifies the list of dynamic parts of the settings key.
556
- * The \a defaultValueOverride argument if valid is used instead of the normal default value.
558
+ * \arg dynamicKeyPartList specifies the list of dynamic parts of the settings key.
559
+ * \arg defaultValueOverride if valid is used instead of the normal default value.
557
560
*/
558
561
T value ( const QStringList &dynamicKeyPartList ) const { return this ->convertFromVariant ( valueAsVariant ( dynamicKeyPartList ) );}
559
562
@@ -591,7 +594,7 @@ class QgsSettingsEntryByValue : public QgsSettingsEntryBase
591
594
* Set settings value.
592
595
*
593
596
* The \a value to set.
594
- * The \a dynamicKeyPart argument specifies the dynamic part of the settings key.
597
+ * \arg dynamicKeyPart specifies the dynamic part of the settings key.
595
598
*/
596
599
bool setValue ( T value, const QString &dynamicKeyPart = QString() ) const
597
600
{
@@ -602,7 +605,7 @@ class QgsSettingsEntryByValue : public QgsSettingsEntryBase
602
605
* Set settings value.
603
606
*
604
607
* The \a value to set.
605
- * The \a dynamicKeyParts argument specifies the list of dynamic parts of the settings key.
608
+ * \arg dynamicKeyParts specifies the list of dynamic parts of the settings key.
606
609
*/
607
610
bool setValue ( T value, const QStringList &dynamicKeyPartList ) const
608
611
{
0 commit comments