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 d96675ba0a3bf084afa3a29c367df1d1259e4526..420bd628c379a4a021632522e1d2a3d01c291af5 100644 (file)
--- 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.
  *
  * 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
  * @param object       Object to copy
  * @returns            Deep copy of \p object on success, or \c NULL
  *                     on error