From 0c881a116f5ffa6ccdd7d9f653cb312f44ee6002 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Fri, 15 May 2015 11:14:17 -0400 Subject: [PATCH] source interface documentation MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- include/babeltrace/plugin/source.h | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/include/babeltrace/plugin/source.h b/include/babeltrace/plugin/source.h index 1e2176a9..0e96529b 100644 --- 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 -- 2.34.1