Skip to content

Commit 63def3d

Browse files
committedSep 18, 2017
Doxygen improvements
1 parent 15bc5ed commit 63def3d

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed
 

‎python/core/qgsvectorlayer.sip‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,19 +349,20 @@ class QgsVectorLayer : QgsMapLayer, QgsExpressionContextGenerator, QgsFeatureSin
349349

350350
QString storageType() const;
351351
%Docstring
352-
Returns the permanent storage type for this layer as a friendly name.
352+
Returns the permanent storage type for this layer as a friendly name.
353+
This is obtained from the data provider and does not follow any standard.
353354
:rtype: str
354355
%End
355356

356357
QString capabilitiesString() const;
357358
%Docstring
358-
Capabilities for this layer in a friendly format.
359+
Capabilities for this layer, comma separated and translated.
359360
:rtype: str
360361
%End
361362

362363
QString dataComment() const;
363364
%Docstring
364-
Returns a comment for the data in the layer
365+
Returns a description for this layer as defined in the data provider.
365366
:rtype: str
366367
%End
367368

‎src/core/qgsvectorlayer.h‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -413,13 +413,20 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
413413
*/
414414
virtual QgsVectorLayer *clone() const override SIP_FACTORY;
415415

416-
//! Returns the permanent storage type for this layer as a friendly name.
416+
/**
417+
* Returns the permanent storage type for this layer as a friendly name.
418+
* This is obtained from the data provider and does not follow any standard.
419+
*/
417420
QString storageType() const;
418421

419-
//! Capabilities for this layer in a friendly format.
422+
/**
423+
* Capabilities for this layer, comma separated and translated.
424+
*/
420425
QString capabilitiesString() const;
421426

422-
//! Returns a comment for the data in the layer
427+
/**
428+
* Returns a description for this layer as defined in the data provider.
429+
*/
423430
QString dataComment() const;
424431

425432
/**

0 commit comments

Comments
 (0)
Please sign in to comment.