objects: Doxygen: note about frozen copy

[babeltrace.git] / include / babeltrace / objects.h

diff --git a/include/babeltrace/objects.h b/include/babeltrace/objects.h
index 9b69bd1fdce86c2d27e8f5c4120bdb010fefe597..420bd628c379a4a021632522e1d2a3d01c291af5 100644 (file)
--- a/include/babeltrace/objects.h
+++ b/include/babeltrace/objects.h
@@ -155,7 +155,7 @@ enum bt_object_type {
        /** Boolean object (holds \c true or \c false). */
        BT_OBJECT_TYPE_BOOL =           1,
 
-       /** Integer (holds a signed 64-bit integer value). */
+       /** Integer object (holds a signed 64-bit integer value). */
        BT_OBJECT_TYPE_INTEGER =        2,
 
        /**
@@ -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