From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Wed, 13 May 2015 22:06:45 +0000 (-0400)
Subject: Javadoc fixes
X-Git-Tag: v2.0.0-pre1~888
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=3f29fd91d07bad647861ccda49d1515f6f927a0a

Javadoc fixes

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

diff --git a/include/babeltrace/plugin/plugin-internal.h b/include/babeltrace/plugin/plugin-internal.h
index 93c9c525..83654c17 100644
--- a/include/babeltrace/plugin/plugin-internal.h
+++ b/include/babeltrace/plugin/plugin-internal.h
@@ -40,7 +40,7 @@ struct bt_plugin {
 	GString *name;
 	enum bt_plugin_type type;
 
-	/* Plug-in specific callbacks */
+	/* Plug-in implementation callbacks */
 	bt_plugin_destroy_cb destroy;
 	bt_plugin_set_error_stream_cb set_error_stream;
 };
diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h
index 8134074d..9e5c9a87 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,21 +53,21 @@ 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,
 }