bt_ctf_event_set_clock_value() does not need a clock class

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

diff --git a/include/babeltrace/ctf-ir/event.h b/include/babeltrace/ctf-ir/event.h
index 1f73b26795268776eec55f4e579212e08252999c..42d39269b46b68f2593c469ba8ba4b8890151d34 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -33,6 +33,7 @@
 #include <stdint.h>
 #include <stddef.h>
 #include <babeltrace/values.h>
+#include <babeltrace/ctf-ir/clock-class.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -73,7 +74,7 @@ object becomes its parent.
 If the \link ctfirtraceclass CTF IR trace class\endlink of an event
 object (parent of its \link ctfirstreamclass CTF IR stream class\endlink,
 which is the parent of its event class) was created by a
-\link ctfirwriter CTF IR writer\endlink object, then the only possible
+\link ctfwriter CTF writer\endlink object, then the only possible
 action you can do with this event object is to append it to a
 \link ctfirstream CTF IR stream\endlink with
 bt_ctf_stream_append_event(). Otherwise, you can create an event
@@ -535,33 +536,29 @@ extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
 @sa bt_ctf_event_set_clock_value(): Sets the clock value of a given event.
 */
 extern struct bt_ctf_clock_value *bt_ctf_event_get_clock_value(
-               struct bt_ctf_event *event, struct bt_ctf_clock *clock_class);
+               struct bt_ctf_event *event, struct bt_ctf_clock_class *clock_class);
 
 /**
 @brief Sets the value, as of the CTF IR event \p event, of the
-       clock described by the
-       \link ctfirclockclass CTF IR clock class\endlink \p clock_class.
+       clock described by its \link ctfirclockclass CTF IR
+       clock class\endlink.
 
 @param[in] event       Event of which to set the value of the clock
-                       described by \p clock_class.
-@param[in] clock_class Class of the clock of which to set the value
-                       for \p event.
-@param[in] clock_value Value of the clock described by \p clock_class
+                       described by the clock class of \p clock_value.
+@param[in] clock_value Value of the clock described by its clock class
                        as of \p event.
 @returns               0 on success, or a negative value on error.
 
 @prenotnull{event}
-@prenotnull{clock_class}
 @prenotnull{clock_value}
 @prehot{event}
 @postrefcountsame{event}
-@postrefcountsame{clock_class}
 
 @sa bt_ctf_event_get_clock_value(): Returns the clock value of
        a given event.
 */
 extern int bt_ctf_event_set_clock_value(
-               struct bt_ctf_event *event, struct bt_ctf_clock *clock_class,
+               struct bt_ctf_event *event,
                struct bt_ctf_clock_value *clock_value);
 
 /** @} */