cpp-common/bt2c/fmt.hpp: use `wise_enum::string_type` in `EnableIfIsWiseEnum` definition
[babeltrace.git] / include / babeltrace2 / util.h
index 1c37b8e3b2668e27335c68cc38b854201a62e881..80c0e66bde5e4bf5820310c072dff3a8485b79c9 100644 (file)
@@ -7,6 +7,8 @@
 #ifndef BABELTRACE2_UTIL_H
 #define BABELTRACE2_UTIL_H
 
+/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
+
 #ifndef __BT_IN_BABELTRACE_H
 # error "Please include <babeltrace2/babeltrace.h> instead."
 #endif
@@ -73,13 +75,13 @@ The following illustration shows the possible scenarios:
 \bt_p{offset_seconds} can be negative. For example, considering:
 
 - A 1000&nbsp;Hz clock.
-- \bt_p{offset_seconds} set to -10&nbsp;seconds.
+- \bt_p{offset_seconds} set to 10&nbsp;seconds.
 - \bt_p{offset_cycles} set to 500&nbsp;cycles
   (that is, 0.5&nbsp;seconds).
 - \bt_p{cycles} set to 2000&nbsp;cycles (that is, 2&nbsp;seconds).
 
-The computed value is -7.5&nbsp;seconds, so this function sets
-\bt_p{*ns_from_origin} to -7,500,000,000.
+The computed value is 7.5&nbsp;seconds, so this function sets
+\bt_p{*ns_from_origin} to 7,500,000,000.
 
 This function can fail and return the
 #BT_UTIL_CLOCK_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR status
@@ -121,7 +123,7 @@ code if any step of the computation process causes an integer overflow.
 bt_util_clock_cycles_to_ns_from_origin_status
 bt_util_clock_cycles_to_ns_from_origin(uint64_t cycles,
                uint64_t frequency, int64_t offset_seconds,
-               uint64_t offset_cycles, int64_t *ns_from_origin);
+               uint64_t offset_cycles, int64_t *ns_from_origin) __BT_NOEXCEPT;
 
 /*! @} */
 
This page took 0.024684 seconds and 4 git commands to generate.