qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] [PATCH bugfix v1 3/3] qom: object.h: Update object_get_cano


From: Peter Crosthwaite
Subject: [Qemu-devel] [PATCH bugfix v1 3/3] qom: object.h: Update object_get_canon_path* doc
Date: Tue, 19 Aug 2014 22:08:09 -0700

With information about return value ownership.

Signed-off-by: Peter Crosthwaite <address@hidden>
---

 include/qom/object.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/qom/object.h b/include/qom/object.h
index 8618e49..87de889 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1029,7 +1029,8 @@ Object *object_get_root(void);
  * object_get_canonical_path_component:
  *
  * Returns: The final component in the object's canonical path.  The canonical
- * path is the path within the composition tree starting from the root.
+ * path is the path within the composition tree starting from the root. The
+ * returned value may not be modified.
  */
 const gchar *object_get_canonical_path_component(Object *obj);
 
@@ -1037,7 +1038,8 @@ const gchar *object_get_canonical_path_component(Object 
*obj);
  * object_get_canonical_path:
  *
  * Returns: The canonical path for a object.  This is the path within the
- * composition tree starting from the root.
+ * composition tree starting from the root.  The returned value is allocated
+ * memory and the client is responsible for freeing the returned value.
  */
 gchar *object_get_canonical_path(Object *obj);
 
-- 
2.0.1.1.gfbfc394




reply via email to

[Prev in Thread] Current Thread [Next in Thread]