Fix: complete error handling of babeltrace API

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

diff --git a/include/babeltrace/ctf/iterator.h b/include/babeltrace/ctf/iterator.h
index 1071def852749d3a4abee44a346e2280dd2d7452..fe70b5e732258e5a245e151a7a259eb7eaf237f8 100644 (file)
--- a/include/babeltrace/ctf/iterator.h
+++ b/include/babeltrace/ctf/iterator.h
@@ -64,7 +64,7 @@ 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)
+ * @iter: trace collection iterator (input). Should NOT be NULL.
  *
  * Return current event on success, NULL on end of trace.
  */