Clarify bt_component_sink_handle_notification_cb semantics

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/include/babeltrace/plugin/plugin-system.h b/include/babeltrace/plugin/plugin-system.h
index 618e3eca3f8a678477913f9e026c883caffe3b5c..59fc54cc79f3e2eb889c8bbedfe3e9489677a4c2 100644 (file)
--- a/include/babeltrace/plugin/plugin-system.h
+++ b/include/babeltrace/plugin/plugin-system.h
@@ -123,8 +123,11 @@ bt_component_source_set_iterator_init_cb(struct bt_component *source,
 /**
  * Notification handling function type.
  *
+ * A reference must be taken on the notification if the component wishes to
+ * keep ownership of the notification beyond the invocation of the callback.
+ *
  * @param sink         Sink component instance
- * @param notificattion        Notification to handle
+ * @param notification Notification to handle
  * @returns            One of #bt_component_status values
  */
 typedef enum bt_component_status (*bt_component_sink_handle_notification_cb)(