Allow unset tags on variant field types

[babeltrace.git] / include / babeltrace / ctf-ir / event-types.h

diff --git a/include/babeltrace/ctf-ir/event-types.h b/include/babeltrace/ctf-ir/event-types.h
index 774a88ed651d402c3fb20b82a3d6694463ae6518..9562318172103ba14e1ad961af80a02b80f8b0b7 100644 (file)
--- a/include/babeltrace/ctf-ir/event-types.h
+++ b/include/babeltrace/ctf-ir/event-types.h
@@ -486,7 +486,7 @@ extern struct bt_ctf_field_type *bt_ctf_field_type_variant_create(
  *
  * @param variant Variant type.
  *
- * Returns a field type instance on success, NULL on error.
+ * Returns a field type instance on success, NULL if unset.
  */
 extern struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type(
                struct bt_ctf_field_type *variant);
@@ -496,7 +496,7 @@ extern struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type(
  *
  * @param variant Variant type.
  *
- * Returns the tag field's name, NULL on error.
+ * Returns the tag field's name, NULL if unset.
  */
 extern const char *bt_ctf_field_type_variant_get_tag_name(
                struct bt_ctf_field_type *variant);