From 5bd929d2fff068f829688f27b54f2f159ff06eb6 Mon Sep 17 00:00:00 2001 From: Markus Armbruster Date: Tue, 14 Jul 2020 18:02:01 +0200 Subject: qom: Document object_get_canonical_path() returns malloced string MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Markus Armbruster Message-Id: <20200714160202.3121879-5-armbru@redhat.com> Reviewed-by: Philippe Mathieu-Daudé --- 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); -- cgit v1.2.3