From 319f672c818465c5801c36f2bc28ae286140be4d Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Tue, 22 Nov 2016 15:36:00 -0500 Subject: [PATCH] stream-class.h: doc: add note about CTF IR writer-only API MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- include/babeltrace/ctf-ir/stream-class.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h index 00ea951d..23380147 100644 --- a/include/babeltrace/ctf-ir/stream-class.h +++ b/include/babeltrace/ctf-ir/stream-class.h @@ -42,6 +42,10 @@ extern "C" { @ingroup ctfir @brief CTF IR stream class. +@note +See \ref ctfirwriterstreamclass which documents additional CTF IR stream +class functions exclusive to the CTF IR writer mode. + A CTF IR stream class is a template that you can use to create concrete \link ctfirstream CTF IR streams\endlink. @@ -96,7 +100,7 @@ success: - bt_ctf_trace_add_stream_class() - bt_ctf_event_create() - bt_ctf_writer_create_stream() - (\link ctfirwriter CTF writer\endlink mode only) + (\link ctfirwriter CTF IR writer\endlink mode only) You cannot modify a frozen stream class: it is considered immutable, except for: @@ -108,6 +112,7 @@ except for: @sa ctfirstream @sa ctfireventclass @sa ctfirtraceclass +@sa ctfirwriterstreamclass @file @brief CTF IR stream class type and functions. -- 2.34.1