Docs: CTF-IR sequence's length field must be unsigned

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

diff --git a/include/babeltrace/ctf-ir/event-fields.h b/include/babeltrace/ctf-ir/event-fields.h
index c617dac2c11130d233c30fd090a66e604bd398d0..332d7d473ef05edcbd3e696b1a723c2edc4cc9ec 100644 (file)
--- a/include/babeltrace/ctf-ir/event-fields.h
+++ b/include/babeltrace/ctf-ir/event-fields.h
@@ -116,7 +116,8 @@ extern struct bt_ctf_field *bt_ctf_field_sequence_get_length(
  * Set the sequence's length field.
  *
  * @param sequence Sequence field instance.
- * @param length_field Integer field instance indicating the sequence's length.
+ * @param length_field Unsigned integer field instance indicating the
+ *        sequence's length.
  *
  * Returns 0 on success, a negative value on error.
  */