lib: remove "For *" comments in public headers

[babeltrace.git] / include / babeltrace2 / graph / self-component-port-input-message-iterator.h

diff --git a/include/babeltrace2/graph/self-component-port-input-message-iterator.h b/include/babeltrace2/graph/self-component-port-input-message-iterator.h
index dbdf7110f1399759d9e445612aa8d77579f5ccbf..2c4d262c6e3673bef50fcb4853693e2dce52c9dc 100644 (file)
--- a/include/babeltrace2/graph/self-component-port-input-message-iterator.h
+++ b/include/babeltrace2/graph/self-component-port-input-message-iterator.h
@@ -1,5 +1,5 @@
-#ifndef BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
-#define BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
+#ifndef BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
+#define BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H
 
 /*
  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
@@ -23,17 +23,13 @@
  * SOFTWARE.
  */
 
-#include <stdint.h>
+#ifndef __BT_IN_BABELTRACE_H
+# error "Please include <babeltrace2/babeltrace.h> instead."
+#endif
 
-/* For bt_message_iterator_status */
-#include <babeltrace2/graph/message-iterator-const.h>
+#include <stdint.h>
 
-/*
- * For bt_component, bt_message_iterator,
- * bt_self_component_port_input_message_iterator,
- * bt_self_component_port_input, bt_message_array_const, bt_bool,
- * __BT_UPCAST
- */
+#include <babeltrace2/graph/message-iterator.h>
 #include <babeltrace2/types.h>
 
 #ifdef __cplusplus
@@ -56,7 +52,7 @@ extern bt_component *
 bt_self_component_port_input_message_iterator_borrow_component(
                bt_self_component_port_input_message_iterator *iterator);
 
-extern bt_message_iterator_status
+extern bt_message_iterator_next_status
 bt_self_component_port_input_message_iterator_next(
                bt_self_component_port_input_message_iterator *iterator,
                bt_message_array_const *msgs, uint64_t *count);
@@ -69,12 +65,12 @@ bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
 extern bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning(
                bt_self_component_port_input_message_iterator *iterator);
 
-extern bt_message_iterator_status
+extern bt_message_iterator_seek_ns_from_origin_status
 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                bt_self_component_port_input_message_iterator *iterator,
                int64_t ns_from_origin);
 
-extern bt_message_iterator_status
+extern bt_message_iterator_seek_beginning_status
 bt_self_component_port_input_message_iterator_seek_beginning(
                bt_self_component_port_input_message_iterator *iterator);
 
@@ -101,4 +97,4 @@ extern void bt_self_component_port_input_message_iterator_put_ref(
 }
 #endif
 
-#endif /* BABELTRACE_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */
+#endif /* BABELTRACE2_GRAPH_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_H */