From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Fri, 13 Mar 2015 01:20:53 +0000 (-0400)
Subject: Docs: event class must have a stream class before events may be created
X-Git-Tag: v2.0.0-pre1~1336
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=54fca895efe7eb95563b5ad9ac1355106415f116

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

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index c6b30960..30b79003 100644
--- 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.