Doxygen

qgis · Sep 21, 2017 · 846fef2 · 846fef2
1 parent 813e9d3
commit 846fef2
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/python/gui/qgsmaplayerconfigwidgetfactory.sip b/python/gui/qgsmaplayerconfigwidgetfactory.sip
@@ -69,6 +69,7 @@ Constructor
     virtual bool supportsStyleDock() const;
 %Docstring
  Flag if widget is supported for use in style dock.
+ The default implementation returns false.
  :return: True if supported
  :rtype: bool
 %End
@@ -82,6 +83,7 @@ Constructor
     virtual bool supportLayerPropertiesDialog() const;
 %Docstring
  Flag if widget is supported for use in layer properties dialog.
+ The default implementation returns false.
  :return: True if supported
  :rtype: bool
 %End

diff --git a/src/app/qgsvectorlayerproperties.h b/src/app/qgsvectorlayerproperties.h
@@ -64,14 +64,22 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private
       return txtDisplayName->text();
     }
 
-    /** Adds an attribute to the table (but does not commit it yet)
-    \param field the field to add
-    \returns false in case of a name conflict, true in case of success */
+    /**
+     * Adds an attribute to the layer.
+     * The layer will need to be in edit mode. It will only be added to the provider when the edit buffer
+     * is committed.
+     * \param field the field to add
+     * \returns false in case of a name conflict, true in case of success
+     */
     bool addAttribute( const QgsField &field );
 
-    /** Deletes an attribute (but does not commit it)
-      \param name attribute name
-      \returns false in case of a non-existing attribute.*/
+    /**
+     * Deletes an attribute.
+     * The layer will need to be in edit mode. It will only be added to the provider when the edit buffer
+     * is committed.
+     * \param name attribute name
+     * \returns false in case of a non-existing attribute.
+     */
     bool deleteAttribute( int attr );
 
     //! Adds a properties page factory to the vector layer properties dialog.

diff --git a/src/gui/qgsmaplayerconfigwidgetfactory.h b/src/gui/qgsmaplayerconfigwidgetfactory.h
@@ -70,6 +70,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory
 
     /**
      * Flag if widget is supported for use in style dock.
+     * The default implementation returns false.
      * \returns True if supported
      */
     virtual bool supportsStyleDock() const { return false; }
@@ -82,6 +83,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory
 
     /**
      * Flag if widget is supported for use in layer properties dialog.
+     * The default implementation returns false.
      * \returns True if supported
      */
     virtual bool supportLayerPropertiesDialog() const { return false; }