From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Fri, 20 Mar 2015 17:53:04 +0000 (-0400)
Subject: objects: Doxygen: note about frozen copy
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=cbe481eb0a71baa92c9a84c79bfd00888a76b491;p=deliverable%2Fbabeltrace.git

objects: Doxygen: note about frozen copy

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/include/babeltrace/objects.h b/include/babeltrace/objects.h
index d96675ba0..420bd628c 100644
--- a/include/babeltrace/objects.h
+++ b/include/babeltrace/objects.h
@@ -1055,6 +1055,8 @@ extern enum bt_object_status bt_object_map_insert_map(
  * The created object's reference count is set to 1, unless
  * \p object is a null object.
  *
+ * Copying a frozen object is allowed: the resulting copy is not frozen.
+ *
  * @param object	Object to copy
  * @returns		Deep copy of \p object on success, or \c NULL
  *			on error