Docs: Indicate that stream event context is sampled on event append

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

diff --git a/include/babeltrace/ctf-ir/stream.h b/include/babeltrace/ctf-ir/stream.h
index ab0a8c7e534b5d290f9d3c2f8064430095dc4edb..9cf025547a8d446ba06b7a15c62801d993a104e9 100644 (file)
--- a/include/babeltrace/ctf-ir/stream.h
+++ b/include/babeltrace/ctf-ir/stream.h
@@ -76,6 +76,9 @@ extern void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
  * incrementing its reference count. The current packet is not flushed to disk
  * until the next call to bt_ctf_stream_flush.
  *
+ * The stream event context will be sampled for every appended event if
+ * a stream event context was defined.
+ *
  * @param stream Stream instance.
  * @param event Event instance to append to the stream's current packet.
  *