]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - keystone-rtos/netapi.git/blobdiff - ti/runtime/netapi/netapi.h
Merge remote branch 'origin/master' into netapi-keystone2
[keystone-rtos/netapi.git] / ti / runtime / netapi / netapi.h
index 4ad0da297426e8295d47aa4f8779e4426818cd18..27f49ec3790fecf357a2dccc5d03dd3877b10648 100755 (executable)
@@ -260,13 +260,13 @@ void netapi_shutdown(NETAPI_T  p);
  *  @ingroup netapi_gen_functions
  *  @brief netapi_getPktlibIfTable  API returns a Pktlib_HeapIfTable to use when creating pktlib heaps
  *
- *  @details Application will need a heapIfTable in order to create its own heaps. This
+ *  @details Application will need a Pktlib_HeapIfTable in order to create its own heaps. This
  *           function returns a table that can be passed in the call to Pktlib_CreateHeap
  *           The memory used for these heaps is  special with the following characteristics: 
  *             - Specific alignment.
  *             - Must be contguous.
  *             - Must have a physical to virtual mapping that  is known by NETAPI. 
- *           Thus it must be completely managed by NETAPI. This interfaced table provides a
+ *           Thus it must be completely managed by NETAPI. This interface table provides a
  *           malloc function that the pktlib heap library uses to allocate data for the heap
  *           buffers.
  *  @retval     Pktlib_HeapIfTable pointer 
@@ -369,7 +369,7 @@ static inline void netapi_setCookie(NETAPI_T p, void * cookie)
  *  @ingroup netapi_gen_functions
  *  @brief netapi_netcpPoll  API is used to poll for NETCP configuration response messages.
  *
- *  @details Application, if controlling the scheduler,  will need to call this
+ *  @details Application, if implementing the scheduler,  will need to call this
  *           function periodically to check for NETCP configuration responses (eg
  *           statistics requests). 
  *  @param[in]  p   The NETAPI handle, @ref NETAPI_T
@@ -405,7 +405,7 @@ return -1;  //no room
 /**
  *  @ingroup netapi_gen_functions
  *  @brief netapi_unregisterHeap  API is used to un-register a heap that was created by application 
- *                                and previously registerd so that it's garbage queue could  be polled 
+ *                                and previously registered so that it's garbage queue could  be polled 
  *                                automatically by @ref netapi_poll_heapGarbage(). 
  *
  *  @details This API un-registers an application-created heap with the netapi instance. 
@@ -430,7 +430,7 @@ return -1;  //not found
  *  @ingroup netapi_gen_functions
  *  @brief netapi_closeHeap  API is used to remove a created pktlib heap
  *
- *  @details This API removes anapplication-created heap with the netapi instance
+ *  @details This API removes an application-created heap with the netapi instance
  *           NOTE: descriptors are zapped and cannot be reused]
  *  @param[in]  p   The NETAPI handle, @ref NETAPI_T
  *  @param[in]  h :  handle to pklib heap