From bf36dbdf4a009f468eefd093a7664c3822133a70 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Fri, 15 May 2015 11:14:06 -0400 Subject: [PATCH] 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 | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/include/babeltrace/plugin/plugin-system.h b/include/babeltrace/plugin/plugin-system.h index 92d81d5a1..02c1f6f38 100644 --- a/include/babeltrace/plugin/plugin-system.h +++ b/include/babeltrace/plugin/plugin-system.h @@ -37,15 +37,21 @@ extern "C" { #endif /** + * Plug-in private data deallocation function type. * + * @param plugin Plug-in instance */ -typedef void (*bt_plugin_destroy_cb)(struct bt_plugin *); +typedef void (*bt_plugin_destroy_cb)(struct bt_plugin *plugin); /** + * Plug-in error stream registration function type. * + * @param plugin Plug-in instance + * @param error_stream Error stream, ownership is not transferred + * @returns One of #bt_plugin_status values */ -typedef void (*bt_plugin_set_error_stream_cb)(struct bt_plugin *, - FILE *error_stream); +typedef enum bt_plugin_status (*bt_plugin_set_error_stream_cb)( + struct bt_plugin *plugin, FILE *error_stream); /** * Get a plug-in's private (implementation) data. -- 2.34.1