Doxygen improvements

qgis · Sep 18, 2017 · 63def3d · 63def3d
1 parent 15bc5ed
commit 63def3d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/python/core/qgsvectorlayer.sip b/python/core/qgsvectorlayer.sip
@@ -349,19 +349,20 @@ class QgsVectorLayer : QgsMapLayer, QgsExpressionContextGenerator, QgsFeatureSin
 
     QString storageType() const;
 %Docstring
-Returns the permanent storage type for this layer as a friendly name.
+ Returns the permanent storage type for this layer as a friendly name.
+ This is obtained from the data provider and does not follow any standard.
  :rtype: str
 %End
 
     QString capabilitiesString() const;
 %Docstring
-Capabilities for this layer in a friendly format.
+ Capabilities for this layer, comma separated and translated.
  :rtype: str
 %End
 
     QString dataComment() const;
 %Docstring
-Returns a comment for the data in the layer
+ Returns a description for this layer as defined in the data provider.
  :rtype: str
 %End
 

diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -413,13 +413,20 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte
      */
     virtual QgsVectorLayer *clone() const override SIP_FACTORY;
 
-    //! Returns the permanent storage type for this layer as a friendly name.
+    /**
+     * Returns the permanent storage type for this layer as a friendly name.
+     * This is obtained from the data provider and does not follow any standard.
+     */
     QString storageType() const;
 
-    //! Capabilities for this layer in a friendly format.
+    /**
+     * Capabilities for this layer, comma separated and translated.
+     */
     QString capabilitiesString() const;
 
-    //! Returns a comment for the data in the layer
+    /**
+     * Returns a description for this layer as defined in the data provider.
+     */
     QString dataComment() const;
 
     /**