diff mbox

[v3,04/12] qom: document reference counting of link properties

Message ID 1359114420-16149-5-git-send-email-pbonzini@redhat.com
State New
Headers show

Commit Message

Paolo Bonzini Jan. 25, 2013, 11:46 a.m. UTC
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 include/qom/object.h | 5 +++++
 1 file changed, 5 insertions(+)
diff mbox

Patch

diff --git a/include/qom/object.h b/include/qom/object.h
index 8e16ea8..5e8e528 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1033,6 +1033,11 @@  void object_property_add_child(Object *obj, const char *name,
  * between objects.
  *
  * Links form the graph in the object model.
+ *
+ * Ownership of the pointer that @child points to is transferred to the
+ * link property.  The reference count for <code>*@child</code> is
+ * managed by the property from after the function returns till the
+ * property is deleted with object_property_del().
  */
 void object_property_add_link(Object *obj, const char *name,
                               const char *type, Object **child,