API doc: add #include line in the detailed description

[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 00ea951d407de320b2359e4d8cdb16c49f5b82df..1959d9569a4643ac4d62c7fb7e7eecb38385e3fb 100644 (file)
--- a/include/babeltrace/ctf-ir/stream-class.h
+++ b/include/babeltrace/ctf-ir/stream-class.h
@@ -42,6 +42,14 @@ extern "C" {
 @ingroup ctfir
 @brief CTF IR stream class.
 
+@code
+#include <babeltrace/ctf-ir/stream-class.h>
+@endcode
+
+@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 +104,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 +116,7 @@ except for:
 @sa ctfirstream
 @sa ctfireventclass
 @sa ctfirtraceclass
+@sa ctfirwriterstreamclass
 
 @file
 @brief CTF IR stream class type and functions.
@@ -522,6 +531,7 @@ on a frozen stream class.
 @prehot{event_class}
 @postrefcountsame{stream_class}
 @postsuccessrefcountinc{event_class}
+@postsuccessfrozen{event_class}
 */
 extern int bt_ctf_stream_class_add_event_class(
                struct bt_ctf_stream_class *stream_class,