From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Fri, 9 Mar 2012 19:37:08 +0000 (-0500)
Subject: Fix: ctf/iterator.h bt_ctf_iter_read_event() comment
X-Git-Tag: v1.0.0-pre4~11
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=17e0c86ea65fcfef51592628e35efc27392638f2;hp=c54983704d35cb1cd6da38cb087df2e3b5cfd5d0

Fix: ctf/iterator.h bt_ctf_iter_read_event() comment

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/include/babeltrace/ctf/iterator.h b/include/babeltrace/ctf/iterator.h
index 564b6e23..8f9af0e1 100644
--- a/include/babeltrace/ctf/iterator.h
+++ b/include/babeltrace/ctf/iterator.h
@@ -58,9 +58,8 @@ void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
  * bt_ctf_iter_read_event: Read the iterator's current event data.
  *
  * @iter: trace collection iterator (input)
- * @stream: stream containing event at current position (output)
- * @event: current event (output)
- * Return 0 on success, negative error value on error.
+ *
+ * Return current event on success, NULL on end of trace.
  */
 struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);