minor cleanup
[keystone-rtos/netapi.git] / ti / runtime / netapi / netapi.h
index 0e5bf454f684412ab867315f6b05101026237842..f7a8bac0350c1a65497dc436f36c9bd12e79edf7 100644 (file)
@@ -2,9 +2,9 @@
  * FILE PURPOSE :  -----------NETAPI-------------
  *         user space access to transport resources on SOC
  **************************************************************
  * FILE PURPOSE :  -----------NETAPI-------------
  *         user space access to transport resources on SOC
  **************************************************************
- * FILE: netapi.h
+ * @file netapi.h
  * 
  * 
- * DESCRIPTION:  netapi main header file for user space transport
+ * @brief DESCRIPTION:  netapi main header file for user space transport
  *               library
  * 
  * REVISION HISTORY:  rev 0.0.1 
  *               library
  * 
  * REVISION HISTORY:  rev 0.0.1 
 /**  @ingroup netapi */
 
 /** @defgroup netapi_api_functions NETAPI API's
 /**  @ingroup netapi */
 
 /** @defgroup netapi_api_functions NETAPI API's
- *  @ingroup netapi
+ *  @ingroup netapi_api_functions
  */
 
 /**  @ingroup netapi_structures */
 /**
  * @def NETAPI_T
  */
 
 /**  @ingroup netapi_structures */
 /**
  * @def NETAPI_T
- *  netapi handle:  one per thread
- *  used in most NETAPI calls
+ * @brief  netapi handle:  one per thread
+ *         used in most NETAPI calls
  */
 typedef void * NETAPI_T;
 
  */
 typedef void * NETAPI_T;
 
@@ -164,6 +164,7 @@ void netapi_shutdown(NETAPI_T  p);
 
 /**  @ingroup netapi_api_functions */
 /*
 
 /**  @ingroup netapi_api_functions */
 /*
+
 *  @brief  API returns a @ref Pktlib_HeapIfTable to use when creating pktlib heaps 
  *
  *  @details  Application will need a heapIfTable in order to create its own heaps. This
 *  @brief  API returns a @ref Pktlib_HeapIfTable to use when creating pktlib heaps 
  *
  *  @details  Application will need a heapIfTable in order to create its own heaps. This
@@ -194,7 +195,7 @@ Pktlib_HeapIfTable *netapi_getPktlibIfTable(void) ;
  *  @retval     int :  amount of memory available for heap buffer storage (in bytes)
  *  @pre        @ref netapi_init 
  */
  *  @retval     int :  amount of memory available for heap buffer storage (in bytes)
  *  @pre        @ref netapi_init 
  */
-int  netapi_getBufmemRemainder(void);
+int  netapi_getBufMemRemainder(void);
 /**  @ingroup netapi_api_functions */
 
 /*
 /**  @ingroup netapi_api_functions */
 
 /*