Standardize *get_*_count() functions
[babeltrace.git] / include / babeltrace / ctf-ir / stream-class.h
index ed82b84824b0b9d899e579da924f1d22b3aeab6e..dc7b35d6ec436fd99005919ad06d19ac054bb87e 100644 (file)
@@ -47,8 +47,8 @@ extern "C" {
 @endcode
 
 @note
-See \ref ctfirwriterstreamclass which documents additional CTF IR stream
-class functions exclusive to the CTF IR writer mode.
+See \ref ctfwriterstreamclass which documents additional CTF IR stream
+class functions exclusive to the CTF 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.
@@ -104,7 +104,7 @@ success:
 - bt_ctf_trace_add_stream_class()
 - bt_ctf_event_create()
 - bt_ctf_writer_create_stream()
-  (\link ctfirwriter CTF IR writer\endlink mode only)
+  (\link ctfwriter CTF writer\endlink mode only)
 
 You cannot modify a frozen stream class: it is considered immutable,
 except for:
@@ -116,7 +116,7 @@ except for:
 @sa ctfirstream
 @sa ctfireventclass
 @sa ctfirtraceclass
-@sa ctfirwriterstreamclass
+@sa ctfwriterstreamclass
 
 @file
 @brief CTF IR stream class type and functions.
@@ -377,7 +377,7 @@ a stream class without a event header field type.
 As of Babeltrace \btversion, if \p event_header_type is not \c NULL,
 \p event_header_type \em must be a CTF IR structure field type object.
 
-@param[in] trace_class         Trace class of which to set the packet
+@param[in] stream_class                Stream class of which to set the event
                                header field type.
 @param[in] event_header_type   Event header field type, or \c NULL to unset
                                the current event header field type.
@@ -391,8 +391,8 @@ As of Babeltrace \btversion, if \p event_header_type is not \c NULL,
 @post <strong>On success, if \p event_header_type is not \c NULL</strong>,
        the reference count of \p event_header_type is incremented.
 
-@sa bt_ctf_trace_get_packet_header_type(): Returns the packet
-       header field type of a given trace class.
+@sa bt_ctf_stream_class_get_event_header_type(): Returns the event
+       header field type of a given stream class.
 */
 extern int bt_ctf_stream_class_set_event_header_type(
                struct bt_ctf_stream_class *stream_class,
@@ -474,7 +474,7 @@ extern int bt_ctf_stream_class_set_event_context_type(
 @prenotnull{stream_class}
 @postrefcountsame{stream_class}
 */
-extern int bt_ctf_stream_class_get_event_class_count(
+extern int64_t bt_ctf_stream_class_get_event_class_count(
                struct bt_ctf_stream_class *stream_class);
 
 /**
@@ -613,10 +613,6 @@ extern int bt_ctf_stream_class_visit(struct bt_ctf_stream_class *stream_class,
 
 /** @} */
 
-// TODO: document for writer
-extern struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
-               struct bt_ctf_stream_class *stream_class);
-
 #ifdef __cplusplus
 }
 #endif
This page took 0.023874 seconds and 4 git commands to generate.