From: Philippe Proulx Date: Thu, 12 Mar 2020 17:33:09 +0000 (-0400) Subject: doc: bt_field_class...get_mapping_labels...(): clarify RV's validity X-Git-Tag: v2.0.3~14 X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=11cbb0e6e35843d89de8c5c072480d3cf77cc05a doc: bt_field_class...get_mapping_labels...(): clarify RV's validity The label array which bt_field_class_enumeration_unsigned_get_mapping_labels_for_value() and bt_field_class_enumeration_signed_get_mapping_labels_for_value() return remains valid as long as: * The enumeration field class is not modified. * You don't call the same function again with the same enumeration field class. Signed-off-by: Philippe Proulx Change-Id: I7b197ab5e176c77f4418d23b12e194c6477e5cf8 Reviewed-on: https://review.lttng.org/c/babeltrace/+/3226 --- diff --git a/include/babeltrace2/trace-ir/field-class.h b/include/babeltrace2/trace-ir/field-class.h index 0aab9682..1f907b7f 100644 --- a/include/babeltrace2/trace-ir/field-class.h +++ b/include/babeltrace2/trace-ir/field-class.h @@ -2320,7 +2320,10 @@ On success, if there's no mapping ranges containing the value The number of labels in \bt_p{*labels} is \bt_p{*count}. The array is owned by \bt_p{field_class} and remains valid as long - as \bt_p{field_class} is not modified. + as: + + - \bt_p{field_class} is not modified. + - You don't call this function again with \bt_p{field_class}. @endparblock @param[out] count On success, \bt_p{*count} is the number of labels @@ -2582,7 +2585,10 @@ On success, if there's no mapping ranges containing the value The number of labels in \bt_p{*labels} is \bt_p{*count}. The array is owned by \bt_p{field_class} and remains valid as long - as \bt_p{field_class} is not modified. + as: + + - \bt_p{field_class} is not modified. + - You don't call this function again with \bt_p{field_class}. @endparblock @param[out] count On success, \bt_p{*count} is the number of labels