From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Fri, 15 May 2015 15:14:06 +0000 (-0400)
Subject: plugin-system.h documentation
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=bf36dbdf4a009f468eefd093a7664c3822133a70;p=deliverable%2Fbabeltrace.git

plugin-system.h documentation

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

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.