X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fplugin%2Fplugin.h;h=77204d9d76e5647bc055c81e488f2ae620a40e76;hb=2bd8a567becb9934d52fe95aa8a722322ab660f8;hp=8134074da909fc45b9062648a36df337c35bf8dc;hpb=a27aeabb58992523714699c8b2c0d1c8c0f943d3;p=babeltrace.git

diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h
index 8134074d..77204d9d 100644
--- a/include/babeltrace/plugin/plugin.h
+++ b/include/babeltrace/plugin/plugin.h
@@ -39,13 +39,13 @@ extern "C" {
 enum bt_plugin_type {
 	BT_PLUGIN_TYPE_UNKNOWN =	-1,
 
-	/* A source plug-in is a notification generator. */
+	/** A source plug-in is a notification generator. */
 	BT_PLUGIN_TYPE_SOURCE =		0,
 
-	/* A sink plug-in handles incoming notifications. */
+	/** A sink plug-in handles incoming notifications. */
 	BT_PLUGIN_TYPE_SINK =		1,
 
-	/* A filter plug-in implements both Source and Sink interfaces. */
+	/** A filter plug-in implements both Source and Sink interfaces. */
 	BT_PLUGIN_TYPE_FILTER =		2,
 };
 
@@ -53,26 +53,28 @@ enum bt_plugin_type {
  * Status code. Errors are always negative.
  */
 enum bt_plugin_status {
-	/** Memory allocation failure. **/
+	/** Memory allocation failure. */
 	/* -12 for compatibility with -ENOMEM */
 	BT_PLUGIN_STATUS_NOMEM =	-12,
 
-	/** Invalid arguments. **/
+	/** Invalid arguments. */
 	/* -22 for compatibility with -EINVAL */
 	BT_PLUGIN_STATUS_INVAL =	-22,
 
-	/** Unsupported plug-in feature. **/
+	/** Unsupported plug-in feature. */
 	BT_PLUGIN_STATUS_UNSUPPORTED =	-2,
 
-	/** General error. **/
+	/** General error. */
 	BT_PLUGIN_STATUS_ERROR =	-1,
 
-	/** No error, okay. **/
+	/** No error, okay. */
 	BT_PLUGIN_STATUS_OK =		0,
-}
+};
+
+struct bt_plugin;
 
 /**
- * Get plug-in instance name
+ * Get plug-in instance name.
  *
  * @param plugin	Plug-in instance of which to get the name
  * @returns		Returns a pointer to the plug-in's name
@@ -80,7 +82,7 @@ enum bt_plugin_status {
 extern const char *bt_plugin_get_name(struct bt_plugin *plugin);
 
 /**
- * Set plug-in instance name
+ * Set plug-in instance name.
  *
  * @param plugin	Plug-in instance of which to set the name
  * @param name		New plug-in name (will be copied)
@@ -90,7 +92,7 @@ extern enum bt_plugin_status bt_plugin_set_name(
 		struct bt_plugin *plugin, const char *name);
 
 /**
- * Get plug-in instance type
+ * Get plug-in instance type.
  *
  * @param plugin	Plug-in instance of which to get the type
  * @returns		One of #bt_plugin_type values
@@ -98,7 +100,7 @@ extern enum bt_plugin_status bt_plugin_set_name(
 extern enum bt_plugin_type bt_plugin_get_type(struct bt_plugin *plugin);
 
 /**
- * Set a plug-in instance's error stream
+ * Set a plug-in instance's error stream.
  *
  * @param plugin	Plug-in instance
  * @param error_stream	Error stream