add emum doc to maa_result_t

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>

diff --git a/api/maa.h b/api/maa.h
index fe4dd86..902f779 100644 (file)
--- a/api/maa.h
+++ b/api/maa.h
@@ -34,19 +34,22 @@
 extern "C" {
 #endif
 
+/**
+ * MAA return codes
+ */
 typedef enum {
-    MAA_SUCCESS                              =  0,
-    MAA_ERROR_FEATURE_NOT_IMPLEMENTED        =  1,
-    MAA_ERROR_FEATURE_NOT_SUPPORTED          =  2,
-    MAA_ERROR_INVALID_VERBOSITY_LEVEL        =  3,
-    MAA_ERROR_INVALID_PARAMETER              =  4,
-    MAA_ERROR_INVALID_HANDLE                 =  5,
-    MAA_ERROR_NO_RESOURCES                   =  6,
-    MAA_ERROR_INVALID_RESOURCE               =  7,
-    MAA_ERROR_INVALID_QUEUE_TYPE             =  8,
-    MAA_ERROR_NO_DATA_AVAILABLE              =  9,
+    MAA_SUCCESS                              =  0, /**< Expected response */
+    MAA_ERROR_FEATURE_NOT_IMPLEMENTED        =  1, /**< Feature TODO */
+    MAA_ERROR_FEATURE_NOT_SUPPORTED          =  2, /**< Feature not supported by HW */
+    MAA_ERROR_INVALID_VERBOSITY_LEVEL        =  3, /**< Verbosity level wrong */
+    MAA_ERROR_INVALID_PARAMETER              =  4, /**< Parameter invalid */
+    MAA_ERROR_INVALID_HANDLE                 =  5, /**< Handle invalid */
+    MAA_ERROR_NO_RESOURCES                   =  6, /**< No resource of that type avail */
+    MAA_ERROR_INVALID_RESOURCE               =  7, /**< Resource invalid */
+    MAA_ERROR_INVALID_QUEUE_TYPE             =  8, /**< Queue type incorrect */
+    MAA_ERROR_NO_DATA_AVAILABLE              =  9, /**< No data available */
 
-    MAA_ERROR_UNSPECIFIED                    = 99
+    MAA_ERROR_UNSPECIFIED                    = 99 /**< Unknown Error */
 } maa_result_t;
 
 /** Get the version string of maa autogenerated from git tag