source interface documentation

[babeltrace.git] / include / babeltrace / plugin / source.h

diff --git a/include/babeltrace/plugin/source.h b/include/babeltrace/plugin/source.h
index 1e2176a9805f3d7495d6a2a366244b256d842d6e..0e96529bba9578c19fbec016db07be0f647518f0 100644 (file)
--- a/include/babeltrace/plugin/source.h
+++ b/include/babeltrace/plugin/source.h
@@ -35,10 +35,23 @@ extern "C" {
 
 struct bt_plugin;
 struct bt_notification_iterator;
+
+/**
+ * Iterator creation function type.
+ *
+ * @param plugin       Plug-in instance
+ */
 typedef struct bt_notification_iterator *(
-               *bt_plugin_source_iterator_create_func)(struct bt_plugin *);
+               *bt_plugin_source_iterator_create_func)(
+               struct bt_plugin *plugin);
 
-struct bt_notification_iterator *bt_plugin_source_get_iterator(
+/**
+ * Create an iterator on a plug-in instance.
+ *
+ * @param plugin       Plug-in instance
+ * @returns            Notification iterator instance
+ */
+struct bt_notification_iterator *bt_plugin_source_create_iterator(
                struct bt_plugin *plugin);
 
 #ifdef __cplusplus