Skip to content

Commit daab529

Browse files
committed
More Doxymentation
1 parent 1320751 commit daab529

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

src/core/qgsvectorlayer.h

+17-8
Original file line numberDiff line numberDiff line change
@@ -1264,14 +1264,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
12641264
/**
12651265
* Get edit type
12661266
*
1267-
* @deprecated Use @see{editorWidgetV2} instead
1267+
* @deprecated Use editorWidgetV2() instead
12681268
*/
12691269
Q_DECL_DEPRECATED EditType editType( int idx );
12701270

12711271
/**
12721272
* Get edit type
12731273
*
1274-
* @deprecated Use @see{setEditorWidgetV2} instead
1274+
* @deprecated Use setEditorWidgetV2() instead
12751275
*/
12761276
Q_DECL_DEPRECATED void setEditType( int idx, EditType edit );
12771277

@@ -1312,17 +1312,26 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
13121312
void setEditorWidgetV2( int attrIdx, const QString& widgetType );
13131313

13141314
/**
1315-
* Set the editor widget config for a field
1315+
* Set the editor widget config for a field.
1316+
*
1317+
* Python: Will accept a map.
1318+
*
1319+
* Example:
1320+
* \code{.py}
1321+
* layer.setEditorWidgetV2Config( 1, { 'Layer': 'otherlayerid_1234', 'Key': 'Keyfield', 'Value': 'ValueField } )
1322+
* \endcode
13161323
*
13171324
* @param attrIdx Index of the field
13181325
* @param config The config to set for this field
1326+
*
1327+
* @see setEditorWidgetV2() for a list of widgets and choose the widget to see the available options.
13191328
*/
13201329
void setEditorWidgetV2Config( int attrIdx, const QgsEditorWidgetConfig& config );
13211330

13221331
/**
13231332
* Set string representing 'true' for a checkbox (added in 1.4)
13241333
*
1325-
* @deprecated Use @see{setEditorWidgetV2Config} instead
1334+
* @deprecated Use setEditorWidgetV2Config() instead
13261335
*/
13271336
Q_DECL_DEPRECATED void setCheckedState( int idx, QString checked, QString notChecked );
13281337

@@ -1354,14 +1363,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
13541363

13551364
/**
13561365
* Access value map
1357-
* @deprecated Use @see{editorWidgetV2Config} instead
1366+
* @deprecated Use editorWidgetV2Config() instead
13581367
*/
13591368
Q_DECL_DEPRECATED QMap<QString, QVariant> valueMap( int idx );
13601369

13611370
/**
13621371
* Access range widget config data
13631372
*
1364-
* @deprecated Use @see{editorWidgetV2Config} instead
1373+
* @deprecated Use editorWidgetV2Config() instead
13651374
*/
13661375
Q_DECL_DEPRECATED RangeData range( int idx );
13671376

@@ -1385,7 +1394,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
13851394
*
13861395
* @note added in 1.9
13871396
*
1388-
* @deprecated Use @see{setEditorWdigetV2Config} instead
1397+
* @deprecated Use setEditorWidgetV2Config() instead
13891398
*/
13901399
Q_DECL_DEPRECATED QString dateFormat( int idx );
13911400

@@ -1394,7 +1403,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
13941403
*
13951404
* @note added in 1.9
13961405
*
1397-
* @deprecated Use @see{setEditorWdigetV2Config} instead
1406+
* @deprecated Use setEditorWidgetV2Config() instead
13981407
*/
13991408
Q_DECL_DEPRECATED QSize widgetSize( int idx );
14001409

0 commit comments

Comments
 (0)