bt_context_add_trace, bt_iter_pos and bt_iter needed some more comments.

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

diff --git a/include/babeltrace/iterator.h b/include/babeltrace/iterator.h
index 94df03c868526b1bcdf3fdbe935d8dfbf09406c9..1aaa5dd0345dd401059e7fa3d1f02910f229ab31 100644 (file)
--- a/include/babeltrace/iterator.h
+++ b/include/babeltrace/iterator.h
@@ -24,6 +24,23 @@
 struct bt_iter;
 struct bt_saved_pos;
 
+/*
+ * bt_iter is an abstract class, each format has to implement its own
+ * iterator derived from this parent class.
+ */
+
+/*
+ * bt_iter_pos
+ *
+ * This structure represents the position where to set an iterator.
+ *
+ * type represents the type of seek to use.
+ * u is the argument of the seek if necessary :
+ * - seek_time is the timestamp to seek to when using BT_SEEK_TIME, it
+ *   is expressed in "raw" seconds (not offsetted)
+ * - restore is a position saved with bt_iter_get_pos, it is used with
+ *   BT_SEEK_RESTORE.
+ */
 struct bt_iter_pos {
        enum {
                BT_SEEK_TIME,           /* uses u.seek_time */