trace.h: doc: add missing end of group

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

diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h
index 93878ebc3e837442e23ecc2ce0061adfd21d8918..099692f38f16120782030f6474d608bc41ede159 100644 (file)
--- a/include/babeltrace/ctf-ir/trace.h
+++ b/include/babeltrace/ctf-ir/trace.h
@@ -56,14 +56,14 @@ You can obtain a trace class in two different modes:
 
 - <strong>Normal mode</strong>: use bt_ctf_trace_create() to create a
   default, empty trace class.
-- <strong>CTF IR writer mode</strong>: use bt_ctf_writer_get_trace() to
-  get the trace class created by a given CTF IR writer object.
+- <strong>CTF writer mode</strong>: use bt_ctf_writer_get_trace() to
+  get the trace class created by a given CTF writer object.
 
 A trace class has the following properties:
 
 - A \b name.
 - A <strong>default byte order</strong>: all the
-  \link ctfirfieldtype field types\endlink eventually part of the trace
+  \link ctfirfieldtypes field types\endlink eventually part of the trace
   class with a byte order set to #BT_CTF_BYTE_ORDER_NATIVE have this
   "real" byte order.
 - An \b environment, which is a custom key-value mapping. Keys are
@@ -109,7 +109,7 @@ success:
 
 - bt_ctf_trace_add_stream_class()
 - 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 trace class: it is considered immutable,
 except for:
@@ -478,11 +478,13 @@ extern int bt_ctf_trace_set_environment_field_string(
 @param[in] trace_class Trace class of which to get the packet
                        header field type.
 @returns               Packet header field type of \p trace_class,
-                       or \c NULL on error.
+                       or \c NULL if \p trace_class has no packet header field
+                       type or on error.
 
 @prenotnull{trace_class}
 @postrefcountsame{trace_class}
-@postsuccessrefcountretinc
+@post <strong>On success, if the return value is a field type</strong>, its
+       reference count is incremented.
 
 @sa bt_ctf_trace_set_packet_header_type(): Sets the packet
        header field type of a given trace class.
@@ -492,22 +494,29 @@ extern struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_type(
 
 /**
 @brief Sets the packet header field type of the CTF IR trace class
-       \p trace_class to \p packet_context_type.
+       \p trace_class to \p packet_header_type, or unsets the current packet
+       header field type from \p trace_class.
+
+If \p packet_header_type is \c NULL, then this function unsets the current
+packet header field type from \p trace_class, effectively making \p trace_class
+a trace without a packet header field type.
 
-As of Babeltrace \btversion, \p packet_context_type \em must be a
-CTF IR structure field type object.
+As of Babeltrace \btversion, if \p packet_header_type is not \c NULL,
+\p packet_header_type \em must be a CTF IR structure field type object.
 
 @param[in] trace_class         Trace class of which to set the packet
                                header field type.
-@param[in] packet_header_type  Packet header field type.
+@param[in] packet_header_type  Packet header field type, or \c NULL to unset
+                               the current packet header field type.
 @returns                       0 on success, or a negative value on error.
 
 @prenotnull{trace_class}
-@prenotnull{packet_header_type}
 @prehot{trace_class}
-@preisstructft{packet_header_type}
+@pre <strong>\p packet_header_type, if not \c NULL</strong>, is a CTF IR
+       structure field type.
 @postrefcountsame{trace_class}
-@postsuccessrefcountinc{packet_header_type}
+@post <strong>On success, if \p packet_header_type is not \c NULL</strong>,
+       the reference count of \p packet_header_type is incremented.
 
 @sa bt_ctf_trace_get_packet_header_type(): Returns the packet
        header field type of a given trace class.
@@ -680,6 +689,13 @@ You can only add a given stream class to one trace class.
 
 You can call this function even if \p trace_class is frozen.
 
+This function tries to resolve the needed
+\link ctfirfieldtypes CTF IR field type\endlink of the dynamic field
+types that are found anywhere in the root field types of
+\p stream_class and of all its currently contained
+\link ctfireventclass CTF IR event classes\endlink. If any automatic
+resolving fails, then this function fails.
+
 @param[in] trace_class Trace class to which to add \p stream_class.
 @param[in] stream_class        Stream class to add to \p trace_class.
 @returns               0 on success, or a negative value on error.
@@ -758,6 +774,8 @@ extern int bt_ctf_trace_visit(struct bt_ctf_trace *trace_class,
 
 /** @} */
 
+/** @} */
+
 /*
  * bt_ctf_trace_get_metadata_string: get metadata string.
  *