doc/api/libbabeltrace2/DoxygenLayout.xml: use `topics` tab

[babeltrace.git] / include / babeltrace2 / trace-ir / stream.h

diff --git a/include/babeltrace2/trace-ir/stream.h b/include/babeltrace2/trace-ir/stream.h
index 32bc98e1770decbad7e3db38da584a301d896899..70628359015f97d5aa4394813d2cc5932ee9549f 100644 (file)
--- a/include/babeltrace2/trace-ir/stream.h
+++ b/include/babeltrace2/trace-ir/stream.h
@@ -1,28 +1,14 @@
-#ifndef BABELTRACE2_TRACE_IR_STREAM_H
-#define BABELTRACE2_TRACE_IR_STREAM_H
-
 /*
- * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
+ * SPDX-License-Identifier: MIT
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
  */
 
+#ifndef BABELTRACE2_TRACE_IR_STREAM_H
+#define BABELTRACE2_TRACE_IR_STREAM_H
+
+/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
+
 #ifndef __BT_IN_BABELTRACE_H
 # error "Please include <babeltrace2/babeltrace.h> instead."
 #endif
@@ -69,7 +55,7 @@ which can belong to different streams, as long as the stream clocks are
 \ref api-tir-clock-cls-origin "correlatable".
 
 A typical use case for streams is to use one for each traced CPU. Then
-the messages related to a given stream are the ones which occured on a
+the messages related to a given stream are the ones which occurred on a
 given CPU. Other schemes are possible: they are completely
 application-specific, and \bt_name does not enforce any specific
 stream arrangement pattern.
@@ -105,7 +91,7 @@ In the illustration above, notice that:
   stream's default clock.
 
   In other words, a default clock snapshot contains the value of the
-  stream's default clock when this message occured.
+  stream's default clock when this message occurred.
 
 To create a stream:
 
@@ -257,7 +243,7 @@ On success, the returned stream has the following property values:
     trace.
 */
 extern bt_stream *bt_stream_create(bt_stream_class *stream_class,
-               bt_trace *trace);
+               bt_trace *trace) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -325,7 +311,7 @@ On success, the returned stream has the following property values:
 */
 extern bt_stream *bt_stream_create_with_id(
                bt_stream_class *stream_class,
-               bt_trace *trace, uint64_t id);
+               bt_trace *trace, uint64_t id) __BT_NOEXCEPT;
 
 /*! @} */
 
@@ -350,7 +336,7 @@ extern bt_stream *bt_stream_create_with_id(
 @sa bt_stream_borrow_class_const() &mdash;
     \c const version of this function.
 */
-extern bt_stream_class *bt_stream_borrow_class(bt_stream *stream);
+extern bt_stream_class *bt_stream_borrow_class(bt_stream *stream) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -360,7 +346,7 @@ extern bt_stream_class *bt_stream_borrow_class(bt_stream *stream);
 See bt_stream_borrow_class().
 */
 extern const bt_stream_class *bt_stream_borrow_class_const(
-               const bt_stream *stream);
+               const bt_stream *stream) __BT_NOEXCEPT;
 
 /*! @} */
 
@@ -384,7 +370,7 @@ extern const bt_stream_class *bt_stream_borrow_class_const(
 @sa bt_stream_borrow_trace_const() &mdash;
     \c const version of this function.
 */
-extern bt_trace *bt_stream_borrow_trace(bt_stream *stream);
+extern bt_trace *bt_stream_borrow_trace(bt_stream *stream) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -394,7 +380,7 @@ extern bt_trace *bt_stream_borrow_trace(bt_stream *stream);
 See bt_stream_borrow_trace().
 */
 extern const bt_trace *bt_stream_borrow_trace_const(
-               const bt_stream *stream);
+               const bt_stream *stream) __BT_NOEXCEPT;
 
 /*! @} */
 
@@ -421,7 +407,7 @@ See the \ref api-tir-stream-prop-id "numeric ID" property.
     Creates a stream with a specific numeric ID and adds it to a
     trace.
 */
-extern uint64_t bt_stream_get_id(const bt_stream *stream);
+extern uint64_t bt_stream_get_id(const bt_stream *stream) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -466,7 +452,7 @@ See the \ref api-tir-stream-prop-name "name" property.
     Returns the name of a stream.
 */
 extern bt_stream_set_name_status bt_stream_set_name(bt_stream *stream,
-               const char *name);
+               const char *name) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -492,7 +478,7 @@ If \bt_p{stream} has no name, this function returns \c NULL.
 @sa bt_stream_class_set_name() &mdash;
     Sets the name of a stream.
 */
-extern const char *bt_stream_get_name(const bt_stream *stream);
+extern const char *bt_stream_get_name(const bt_stream *stream) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -524,7 +510,8 @@ property.
     Borrows the user attributes of a stream.
 */
 extern void bt_stream_set_user_attributes(
-               bt_stream *stream, const bt_value *user_attributes);
+               bt_stream *stream, const bt_value *user_attributes)
+               __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -551,7 +538,8 @@ property.
 @sa bt_stream_borrow_user_attributes_const() &mdash;
     \c const version of this function.
 */
-extern bt_value *bt_stream_borrow_user_attributes(bt_stream *stream);
+extern bt_value *bt_stream_borrow_user_attributes(bt_stream *stream)
+               __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -561,7 +549,7 @@ extern bt_value *bt_stream_borrow_user_attributes(bt_stream *stream);
 See bt_stream_borrow_user_attributes().
 */
 extern const bt_value *bt_stream_borrow_user_attributes_const(
-               const bt_stream *stream);
+               const bt_stream *stream) __BT_NOEXCEPT;
 
 /*! @} */
 
@@ -585,7 +573,7 @@ extern const bt_value *bt_stream_borrow_user_attributes_const(
 @sa bt_stream_put_ref() &mdash;
     Decrements the reference count of a stream.
 */
-extern void bt_stream_get_ref(const bt_stream *stream);
+extern void bt_stream_get_ref(const bt_stream *stream) __BT_NOEXCEPT;
 
 /*!
 @brief
@@ -602,7 +590,7 @@ extern void bt_stream_get_ref(const bt_stream *stream);
 @sa bt_stream_get_ref() &mdash;
     Increments the reference count of a stream.
 */
-extern void bt_stream_put_ref(const bt_stream *stream);
+extern void bt_stream_put_ref(const bt_stream *stream) __BT_NOEXCEPT;
 
 /*!
 @brief