Add notification documentation

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

diff --git a/include/babeltrace/plugin/notification/eot.h b/include/babeltrace/plugin/notification/eot.h
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/include/babeltrace/plugin/notification/notification.h b/include/babeltrace/plugin/notification/notification.h
index 6db3a503078547d71efad3822066152d4d76df10..a15fde6a99f24f154888bb0c8662a81316dc31a7 100644 (file)
--- a/include/babeltrace/plugin/notification/notification.h
+++ b/include/babeltrace/plugin/notification/notification.h
@@ -35,16 +35,48 @@ extern "C" {
 
 struct bt_notification;
 
+/**
+ * Notification types. Unhandled notification types should be ignored.
+ */
 enum bt_plugin_notification_type {
        BT_PLUGIN_NOTIFICATION_TYPE_UNKNOWN = -1,
-       BT_PLUGIN_NOTIFICATION_TYPE_EVENT = 0, /* see notification/event.h */
-       BT_PLUGIN_NOTIFICATION_TYPE_EVENTS_DISCARDED = 0, /* see notification/events-discarded.h */
+
+       /** Event delivery notification, see event.h */
+       BT_PLUGIN_NOTIFICATION_TYPE_EVENT = 0,
+
+       /** New stream packet notification, see packet.h */
+       BT_PLUGIN_NOTIFICATION_TYPE_NEW_PACKET = 1,
+
+       /** End of trace notification, see eot.h */
+       BT_PLUGIN_NOTIFICATION_TYPE_EOT = 2,
 };
 
+/**
+ * Get a notification's type.
+ *
+ * @param notification Notification instance
+ * @returns            One of #bt_plugin_notification_type
+ */
 enum bt_plugin_notification_type bt_plugin_notification_get_type(
                struct bt_plugin_notification *notification);
 
+/**
+ * Increments the reference count of \p notifiaction.
+ *
+ * @param notification Notification of which to increment the reference count
+ *
+ * @see bt_plugin_notification_put()
+ */
 void bt_plugin_notification_get(struct bt_plugin_notification *notification);
+
+/**
+ * Decrements the reference count of \p notification, destroying it when this
+ * count reaches 0.
+ *
+ * @param notification Notification of which to decrement the reference count
+ *
+ * @see bt_plugin_notification_get()
+ */
 void bt_plugin_notification_put(struct bt_plugin_notification *notification);
 
 #ifdef __cplusplus

diff --git a/include/babeltrace/plugin/notification/packet.h b/include/babeltrace/plugin/notification/packet.h
new file mode 100644 (file)
index 0000000..e69de29