* pbuf.c (pbuf_copy_partial): Improve function description comment. Thanks to Luca Ceresoli

This commit is contained in:
jifl 2008-09-30 13:40:41 +00:00
parent edf72a7dfb
commit 6f6c8c5434

View File

@ -737,8 +737,10 @@ pbuf_copy(struct pbuf *p_to, struct pbuf *p_from)
* *
* @param buf the pbuf from which to copy data * @param buf the pbuf from which to copy data
* @param dataptr the application supplied buffer * @param dataptr the application supplied buffer
* @param len length of data to copy (dataptr must be big enough) * @param len length of data to copy (dataptr must be big enough). No more
* than buf->tot_len will be copied, irrespective of len
* @param offset offset into the packet buffer from where to begin copying len bytes * @param offset offset into the packet buffer from where to begin copying len bytes
* @return the number of bytes copied, or 0 on failure
*/ */
u16_t u16_t
pbuf_copy_partial(struct pbuf *buf, void *dataptr, u16_t len, u16_t offset) pbuf_copy_partial(struct pbuf *buf, void *dataptr, u16_t len, u16_t offset)