[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH for-5.1 4/5] qom: Document object_get_canonical_path() returns ma
From: |
Markus Armbruster |
Subject: |
[PATCH for-5.1 4/5] qom: Document object_get_canonical_path() returns malloced string |
Date: |
Tue, 14 Jul 2020 18:02:01 +0200 |
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
include/qom/object.h | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/include/qom/object.h b/include/qom/object.h
index 55d925d2c8..0f3a60617c 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -1467,8 +1467,9 @@ const char *object_get_canonical_path_component(const
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.
+ * Returns: The canonical path for a object, newly allocated. This is
+ * the path within the composition tree starting from the root. Use
+ * g_free() to free it.
*/
char *object_get_canonical_path(const Object *obj);
--
2.26.2