Additional doxygen updates
[keystone-rtos/netapi.git] / ti / runtime / netapi / netapi_err.h
index 8981991a57e72136f998deaa87c51c73142eae83..86c646cf5fb2543e030c4da3c45bb3f6ea5ae3ce 100755 (executable)
 
 #ifndef __NETAPI_ERR__
 #define __NETAPI_ERR__
-/**
- *   @defgroup NETAPI_RetValue NETAPI Return Codes
+
+/** @defgroup netapi_errors NETAPI Error Return Values
+ *  @ingroup netapi
  */
-/**  @ingroup NETAPI_RetValue */
 
 /**
  *  @def  NETAPI_ERR_OK
+ *  @ingroup netapi_errors
  *       No error 
  */
 #define NETAPI_ERR_OK  0
+
 /**
- *  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_NOMEM
+ *  @ingroup netapi_errors
  *  @brief   out of memory error  
  */
 #define NETAPI_ERR_NOMEM -1
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_BAD_INPUT
- *       arguments or configuraiton is invalid
+ *  @ingroup netapi_errors
+ *  @brief   arguments or configuraiton is invalid
  */
 #define NETAPI_ERR_BAD_INPUT -2
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_QLLD 
- *       QUEUE MANAGER Reports an error
+ *  @ingroup netapi_errors
+ *  @brief   QUEUE MANAGER Reports an error
  */
 #define NETAPI_ERR_QLLD -3
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_NOTFOUND
- *       the resource cannot be located
+ *  @ingroup netapi_errors
+ *  @brief   the resource cannot be located
  */
 #define NETAPI_ERR_NOTFOUND -4
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_BUSY
- *       Temporarily out of resources or resource leak
+ *  @ingroup netapi_errors
+ *  @brief   Temporarily out of resources or resource leak
  */
 #define NETAPI_ERR_BUSY -5 
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_NWAL_ERR0
- *       NWAL subsytem reports error 
+ *  @ingroup netapi_errors
+ *  @brief   NWAL subsytem reports error 
  */
 #define NETAPI_ERR_NWAL_ERR0 -6
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_NOT_IMLEMENTED_
- *       Feature not implemented in this version    
+ *  @ingroup netapi_errors
+ *  @brief   Feature not implemented in this version    
  */
 #define NETAPI_ERR_NOT_IMPLEMENTED -7
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_NORES
- *      no free (hw) resources available 
+ *  @ingroup netapi_errors
+ *  @brief   no free (hw) resources available 
  */
 #define NETAPI_ERR_NORES -8
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_ALREADY_CANCELLED
- *       timer has already been cancelled
+ *  @ingroup netapi_errors
+ *  @brief   timer has already been cancelled
  */
 #define NETAPI_ERR_ALREADY_CANCELLED -100
+
 /**
-*  @ingroup NETAPI_RetValue
  *  @def  NETAPI_ERR_NWAL_TX_ERR
- *       error trying to send to NWAL. 
+ *  @ingroup netapi_errors
+ *  @brief   error trying to send to NWAL. 
  */
 #define NETAPI_ERR_NWAL_TX_ERR -65536
 #endif