API documentation

qgis · Nov 25, 2013 · 8e73a58 · 8e73a58
1 parent efaaab3
commit 8e73a58
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -879,10 +879,12 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
      */
     bool addFeature( QgsFeature& f, bool alsoUpdateExtent = true );
 
-    /** Updates an existing feature
-        @param f feature to update
-        @return                    True in case of success and False in case of error
-        @note added in 1.8
+    /** Updates an existing feature. This method needs to query the datasource
+        on every call. Consider using {@link changeAttributeValue()} or
+        {@link changeGeometry()} instead.
+        @param f  Feature to update
+        @return   True in case of success and False in case of error
+        @note     Added in 1.8
      */
     bool updateFeature( QgsFeature &f );