Docs: add documentation for bt_ctf_field_type_enumeration_find_mappings*

[babeltrace.git] / include / babeltrace / ctf-ir / fields.h

diff --git a/include/babeltrace/ctf-ir/fields.h b/include/babeltrace/ctf-ir/fields.h
index 4cc8b03d8df55fddc6bd18b6d51b10ec0e469bf7..3a4c76a66dc6b30286f20942d81319bbe81b1076 100644 (file)
--- a/include/babeltrace/ctf-ir/fields.h
+++ b/include/babeltrace/ctf-ir/fields.h
@@ -639,12 +639,9 @@ extern struct bt_ctf_field *bt_ctf_field_enumeration_get_container(
                struct bt_ctf_field *enum_field);
 
 /**
-@brief Returns an iterator to the mappings selected by the current
+@brief Returns a @enumiter to the mappings selected by the current
        integral value of the @enumfield \p enum_field.
 
-On success, \p enum_field remains the sole owner of the returned
-value.
-
 @param[in] enum_field  Enumeration field of which to get the name of
                        mapping associated to its current integral
                        value.
@@ -657,6 +654,7 @@ value.
 @pre The wrapped integer field of \p enum_field contains an integral
        value.
 @postrefcountsame{enum_field}
+@postsuccessrefcountret1
 */
 extern struct bt_ctf_field_type_enumeration_mapping_iterator *
 bt_ctf_field_enumeration_get_mappings(struct bt_ctf_field *enum_field);