From: Jérémie Galarneau Date: Fri, 15 May 2015 15:14:17 +0000 (-0400) Subject: source interface documentation X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=0c881a116f5ffa6ccdd7d9f653cb312f44ee6002;p=deliverable%2Fbabeltrace.git source interface documentation Signed-off-by: Jérémie Galarneau --- diff --git a/include/babeltrace/plugin/source.h b/include/babeltrace/plugin/source.h index 1e2176a98..0e96529bb 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