Fix: ctf/iterator.h bt_ctf_iter_read_event() comment
authorMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Fri, 9 Mar 2012 19:37:08 +0000 (14:37 -0500)
committerMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Fri, 9 Mar 2012 19:37:08 +0000 (14:37 -0500)
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
include/babeltrace/ctf/iterator.h

index 564b6e23f64465afcce5202f2308995aacdc8eba..8f9af0e19e3b8af855f2e3fae71200014b8af16c 100644 (file)
@@ -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);
 
This page took 0.032857 seconds and 4 git commands to generate.