Make bt_ctf_event_class_create() create an empty context FT

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

diff --git a/include/babeltrace/ctf-ir/event-class.h b/include/babeltrace/ctf-ir/event-class.h
index 5052f70fa551452ef09e745cf222b7f6e583e963..fec7aa875a6e29b8227a0153ea83bcd03ed2bada 100644 (file)
--- a/include/babeltrace/ctf-ir/event-class.h
+++ b/include/babeltrace/ctf-ir/event-class.h
@@ -121,9 +121,11 @@ struct bt_ctf_stream_class;
 /**
 @brief Creates a default CTF IR event class named \p name­.
 
-The event class is created \em without an event context
-\link ctfirfieldtypes field type\endlink and with an empty event
-payload field type.
+On success, the context and payload field types are empty structure
+field types. You can modify those default field types after the
+event class is created with
+bt_ctf_event_class_set_context_type() and
+bt_ctf_event_class_set_payload_type().
 
 Upon creation, the event class's ID is <em>not set</em>. You
 can set it to a specific value with bt_ctf_event_class_set_id(). If it