From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Wed, 13 May 2015 21:53:12 +0000 (-0400)
Subject: Comment plug-in error codes
X-Git-Tag: v2.0.0-pre1~889
X-Git-Url: http://git.efficios.com/?a=commitdiff_plain;h=a27aeabb58992523714699c8b2c0d1c8c0f943d3;p=babeltrace.git

Comment plug-in error codes

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

diff --git a/include/babeltrace/plugin/plugin.h b/include/babeltrace/plugin/plugin.h
index 1080e2bb..8134074d 100644
--- a/include/babeltrace/plugin/plugin.h
+++ b/include/babeltrace/plugin/plugin.h
@@ -53,16 +53,21 @@ enum bt_plugin_type {
  * Status code. Errors are always negative.
  */
 enum bt_plugin_status {
+	/** Memory allocation failure. **/
 	/* -12 for compatibility with -ENOMEM */
 	BT_PLUGIN_STATUS_NOMEM =	-12,
 
+	/** Invalid arguments. **/
 	/* -22 for compatibility with -EINVAL */
 	BT_PLUGIN_STATUS_INVAL =	-22,
 
+	/** Unsupported plug-in feature. **/
 	BT_PLUGIN_STATUS_UNSUPPORTED =	-2,
 
+	/** General error. **/
 	BT_PLUGIN_STATUS_ERROR =	-1,
 
+	/** No error, okay. **/
 	BT_PLUGIN_STATUS_OK =		0,
 }