Document field-path.h (API)

[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 6d45e33f27d375848c863e33e1ce2e503dc511fe..dc43392125152137ae95c18cf9e84fa072085099 100644 (file)
--- a/include/babeltrace/ctf-ir/event.h
+++ b/include/babeltrace/ctf-ir/event.h
@@ -164,6 +164,7 @@ create the event object in the first place with bt_ctf_event_create().
                        or \c NULL on error.
 
 @prenotnull{event}
+@postrefcountsame{event}
 @postsuccessrefcountretinc
 */
 extern struct bt_ctf_event_class *bt_ctf_event_get_class(
@@ -182,6 +183,7 @@ This function returns a reference to the event class which was set to
                        \p event or on error.
 
 @prenotnull{event}
+@postrefcountsame{event}
 @postsuccessrefcountretinc
 
 @sa bt_ctf_event_set_packet(): Associates a given event to a given
@@ -207,6 +209,7 @@ On success, this function also sets the parent stream object of
 \p event to the parent stream of \p packet.
 
 @param[in] event       Event to which to associate \p packet.
+@param[in] packet      Packet to associate to \p event.
 @returns               0 on success, or a negative value on error.
 
 @prenotnull{event}
@@ -230,6 +233,7 @@ extern int bt_ctf_event_set_packet(struct bt_ctf_event *event,
 @returns               Parent stream of \p event, or \c NULL on error.
 
 @prenotnull{event}
+@postrefcountsame{event}
 @postsuccessrefcountretinc
 */
 extern struct bt_ctf_stream *bt_ctf_event_get_stream(
@@ -253,6 +257,7 @@ extern struct bt_ctf_stream *bt_ctf_event_get_stream(
                        field is not set or on error.
 
 @prenotnull{event}
+@postrefcountsame{event}
 @postsuccessrefcountretinc
 
 @sa bt_ctf_event_get_header(): Sets the stream event header
@@ -301,6 +306,7 @@ extern int bt_ctf_event_set_header(struct bt_ctf_event *event,
                        field is not set or on error.
 
 @prenotnull{event}
+@postrefcountsame{event}
 @postsuccessrefcountretinc
 
 @sa bt_ctf_event_set_stream_event_context(): Sets the stream event
@@ -348,6 +354,7 @@ extern int bt_ctf_event_set_stream_event_context(struct bt_ctf_event *event,
                        the event context field is not set or on error.
 
 @prenotnull{event}
+@postrefcountsame{event}
 @postsuccessrefcountretinc
 
 @sa bt_ctf_event_set_event_context(): Sets the event context field of a
@@ -394,6 +401,7 @@ extern int bt_ctf_event_set_event_context(struct bt_ctf_event *event,
                        the event payload field is not set or on error.
 
 @prenotnull{event}
+@postrefcountsame{event}
 @postsuccessrefcountretinc
 
 @sa bt_ctf_event_set_payload_field(): Sets the event payload field of a