From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Sat, 3 Dec 2016 01:48:10 +0000 (-0500)
Subject: field-types.h: doc: bt_ctf_field_type_copy(): add not frozen @post
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=631688600ebc6141f7b681226d988415609b9864;p=deliverable%2Fbabeltrace.git

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 4270ef2db..b9896e3d7 100644
--- 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);