Notification interfaces

[babeltrace.git] / include / babeltrace / plugin / notification / iterator.h

diff --git a/include/babeltrace/plugin/notification/iterator.h b/include/babeltrace/plugin/notification/iterator.h
index 51247d182ce50810d15a08ce84f4b7d4afbd8d8e..18ee4f625a0d818013affa723d0fc0b5cf5f6757 100644 (file)
--- a/include/babeltrace/plugin/notification/iterator.h
+++ b/include/babeltrace/plugin/notification/iterator.h
@@ -57,15 +57,18 @@ enum bt_notification_iterator_status {
        BT_NOTIFICATION_ITERATOR_STATUS_OK = 0,
 };
 
+/**
+ * Notification iterator seek reference.
+ */
 enum bt_notification_iterator_seek_type {
        /** Seek at a time relative to the beginning of the trace. */
        BT_NOTIFICATION_ITERATOR_SEEK_TYPE_BEGIN = 0,
 
-       /** Seek at a time relative to the current position */
+       /** Seek at a time relative to the current position. */
        BT_NOTIFICATION_ITERATOR_SEEK_TYPE_CURRENT = 1,
 
-       /** Seek at a absolute time */
-       BT_NOTIFICATION_ITERATOR_SEEK_TYPE_SET = 2,
+       /** Seek at a time relative to the end of the trace. */
+       BT_NOTIFICATION_ITERATOR_SEEK_TYPE_END = 1,
 };
 
 /**
@@ -74,7 +77,7 @@ enum bt_notification_iterator_seek_type {
  * This functions will <b>not</b> advance the cursor's position.
  * The returned notification's reference count is already incremented.
  *
- * @param Iterator     Iterator instance
+ * @param iterator     Iterator instance
  * @returns            Returns a bt_notification instance
  *
  * @see bt_notification_put()