stream-class.h: doc: add note about CTF IR writer-only API

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

diff --git a/include/babeltrace/ctf-ir/stream-class.h b/include/babeltrace/ctf-ir/stream-class.h
index 9946afc58368f2920f78b3dbe3eeee1b4a1c312f..233801475124917c88555873f5f2fd0c93f0e5c8 100644 (file)
--- 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 <strong><em>stream class</em></strong> 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.
@@ -553,7 +558,7 @@ event classes.
 @prenotnull{visitor}
 */
 extern int bt_ctf_stream_class_visit(struct bt_ctf_stream_class *stream_class,
-               bt_ctf_ir_visitor visitor, void *data);
+               bt_ctf_visitor visitor, void *data);
 
 /** @} */