field-types.h: doc: bt_ctf_field_type_copy(): add not frozen @post

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

diff --git a/include/babeltrace/ctf-ir/field-types.h b/include/babeltrace/ctf-ir/field-types.h
index 4270ef2db6ace7fddd5b9447905088e7a2b69d4f..b9896e3d7c3dd23175a395f34f4fa49ec4a03d0c 100644 (file)
--- a/include/babeltrace/ctf-ir/field-types.h
+++ b/include/babeltrace/ctf-ir/field-types.h
@@ -650,6 +650,7 @@ in the detailed description of this module).
 @prenotnull{field_type}
 @postrefcountsame{field_type}
 @postsuccessrefcountret1
+@post <strong>On success</strong>, the returned field type is not frozen.
 */
 extern struct bt_ctf_field_type *bt_ctf_field_type_copy(
                struct bt_ctf_field_type *field_type);