index 0e5bf454f684412ab867315f6b05101026237842..f7a8bac0350c1a65497dc436f36c9bd12e79edf7 100644 (file)
* 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
/** @ingroup netapi */
/** @defgroup netapi_api_functions NETAPI API's
- * @ingroup netapi
+ * @ingroup netapi_api_functions
*/
/** @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;
/** @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
* @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 */
/*