mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-11-18 20:10:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor changes: fix some comments for Doygen documentation

Browse Source
This commit is contained in:
fbernon 2007-06-21 07:17:29 +00:00
parent d3f0a3211d
commit 4c07b1606c
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/core/pbuf.c
View File

@ -96,6 +96,8 @@ pbuf_init(void)
* layer at which the pbuf is allocated and the requested size
* (from the size parameter).
*
* @param l flag to define header size
* @param length size of the pbuf's payload
* @param flag this parameter decides how and where the pbuf
* should be allocated as follows:
*
@ -338,7 +340,8 @@ pbuf_realloc(struct pbuf *p, u16_t new_len)
*
* The ->payload, ->tot_len and ->len fields are adjusted.
*
* @param hdr_size_inc Number of bytes to increment header size which
* @param p pbuf to change the header size.
* @param header_size_increment Number of bytes to increment header size which
* increases the size of the pbuf. New space is on the front.
* (Using a negative value decreases the header size.)
* If hdr_size_inc is 0, this function does nothing and returns succesful.
@ -435,7 +438,7 @@ pbuf_header(struct pbuf *p, s16_t header_size_increment)
* decrementing. So, when all reference counts are one, the whole
* chain is free'd.
*
* @param pbuf The pbuf (chain) to be dereferenced.
* @param p The pbuf (chain) to be dereferenced.
*
* @return the number of pbufs that were de-allocated
* from the head of the chain.
@ -672,7 +675,8 @@ pbuf_dechain(struct pbuf *p)
*
* @note Only one packet is copied, no packet queue!
*
* @param p Head of pbuf chain to process
* @param p_to pbuf source of the copy
* @param p_from pbuf destination of the copy
*
* @return ERR_OK if pbuf was copied
* ERR_ARG if one of the pbufs is NULL or p_to is not big

6
src/netif/etharp.c
View File

@ -506,7 +506,7 @@ etharp_find_addr(struct netif *netif, struct ip_addr *ipaddr,
* packet p is passed to the IP layer.
*
* @param netif The lwIP network interface on which the IP packet pbuf arrived.
* @param pbuf The IP packet that arrived on netif.
* @param p The IP packet that arrived on netif.
*
* @return NULL
*
@ -542,8 +542,8 @@ etharp_ip_input(struct netif *netif, struct pbuf *p)
* is freed by this function.
*
* @param netif The lwIP network interface on which the ARP packet pbuf arrived.
* @param pbuf The ARP packet that arrived on netif. Is freed by this function.
* @param ethaddr Ethernet address of netif.
* @param p The ARP packet that arrived on netif. Is freed by this function.
*
* @return NULL
*
@ -681,8 +681,8 @@ etharp_arp_input(struct netif *netif, struct eth_addr *ethaddr, struct pbuf *p)
* the gateway is used.
*
* @param netif The lwIP network interface which the IP packet will be sent on.
* @param q The pbuf(s) containing the IP packet to be sent.
* @param ipaddr The IP address of the packet destination.
* @param pbuf The pbuf(s) containing the IP packet to be sent.
*
* @return
* - ERR_RTE No route to destination (no gateway to external networks),