mirror of
https://github.com/lwip-tcpip/lwip.git
synced 2024-07-04 20:08:57 +00:00
pbuf: Update documentation for pbuf_copy
Remove detail from when the method was called pbuf_take which worked on packet queues.
This commit is contained in:
parent
488d4ad246
commit
a49c347b7e
|
@ -941,12 +941,7 @@ pbuf_dechain(struct pbuf *p)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @ingroup pbuf
|
* @ingroup pbuf
|
||||||
* Create PBUF_RAM copies of pbufs.
|
* Copy the contents of one packet buffer into another.
|
||||||
*
|
|
||||||
* Used to queue packets on behalf of the lwIP stack, such as
|
|
||||||
* ARP based queueing.
|
|
||||||
*
|
|
||||||
* @note You MUST explicitly use p = pbuf_take(p);
|
|
||||||
*
|
*
|
||||||
* @note Only one packet is copied, no packet queue!
|
* @note Only one packet is copied, no packet queue!
|
||||||
*
|
*
|
||||||
|
@ -956,6 +951,7 @@ pbuf_dechain(struct pbuf *p)
|
||||||
* @return ERR_OK if pbuf was copied
|
* @return ERR_OK if pbuf was copied
|
||||||
* ERR_ARG if one of the pbufs is NULL or p_to is not big
|
* ERR_ARG if one of the pbufs is NULL or p_to is not big
|
||||||
* enough to hold p_from
|
* enough to hold p_from
|
||||||
|
* ERR_VAL if any of the pbufs are part of a queue
|
||||||
*/
|
*/
|
||||||
err_t
|
err_t
|
||||||
pbuf_copy(struct pbuf *p_to, const struct pbuf *p_from)
|
pbuf_copy(struct pbuf *p_to, const struct pbuf *p_from)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user