Docs: event class must have a stream class before events may be created

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

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index c6b30960cb6a023eda08c46d10f0be1f52a59592..30b790035456eefbd4ffff13a3fe45e09522b7c0 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -202,6 +202,9 @@ extern void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class);
  * sets its reference count to 1. Each instance shares the ownership of the
  * event class using its reference count.
  *
+ * An event class must be associated with a stream class before events
+ * may be instanciated.
+ *
  * @param event_class Event class.
  *
  * Returns an allocated field type on success, NULL on error.