From d97bac968c717fa2f1c2be4d8658f0e6a6e392fa Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Mon, 13 Jul 2015 11:46:46 -0400 Subject: [PATCH] Docs: plugin-system.h 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/plugin-system.h | 36 ++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/include/babeltrace/plugin/plugin-system.h b/include/babeltrace/plugin/plugin-system.h index 6eee12fb..d2970b58 100644 --- a/include/babeltrace/plugin/plugin-system.h +++ b/include/babeltrace/plugin/plugin-system.h @@ -167,7 +167,7 @@ typedef struct bt_notification *(*bt_notification_iterator_get_cb)( struct bt_notification_iterator *iterator); /** - * Function advancing an iterator's position. + * Function advancing an iterator's position of one element. * * @param iterator Notification iterator instance * @returns One of #bt_notification_iterator_status values @@ -183,23 +183,57 @@ typedef enum bt_notification_iterator_status (*bt_notification_iterator_next_cb) typedef void (*bt_notification_iterator_destroy_cb)( struct bt_notification_iterator *iterator); +/** + * Set an iterator's "get" callback which return the current notification. + * + * @param iterator Notification iterator instance + * @param get Notification return callback + * @returns One of #bt_notification_iterator_status values + */ extern enum bt_notification_iterator_status bt_notification_iterator_set_get_cb(struct bt_notification_iterator *iterator, bt_notification_iterator_get_cb get); +/** + * Set an iterator's "next" callback which advances the iterator's position. + * + * @param iterator Notification iterator instance + * @param next Iterator "next" callback + * @returns One of #bt_notification_iterator_status values + */ extern enum bt_notification_iterator_status bt_notification_iterator_set_next_cb(struct bt_notification_iterator *iterator, bt_notification_iterator_next_cb next); +/** + * Set an iterator's "destroy" callback. + * + * @param iterator Notification iterator instance + * @param next Iterator destruction callback + * @returns One of #bt_notification_iterator_status values + */ extern enum bt_notification_iterator_status bt_notification_iterator_set_destroy_cb( struct bt_notification_iterator *iterator, bt_notification_iterator_destroy_cb destroy); +/** + * Set an iterator's private data. + * + * @param iterator Notification iterator instance + * @param data Iterator private data + * @returns One of #bt_notification_iterator_status values + */ extern enum bt_notification_iterator_status bt_notification_iterator_set_private_data( struct bt_notification_iterator *iterator, void *data); +/** + * Gett an iterator's private data. + * + * @param iterator Notification iterator instance + * @returns Iterator instance private data + */ extern void *bt_notification_iterator_get_private_data( struct bt_notification_iterator *iterator); -- 2.34.1