mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-10-05 22:29:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor: documentation updates

Browse Source
This commit is contained in:
Dirk Ziegelmeier 2016-08-24 08:19:51 +02:00
parent 831b7fc7d3
commit 6fc7f84497
4 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/core/raw.c
View File

@ -271,7 +271,7 @@ raw_recv(struct raw_pcb *pcb, raw_recv_fn recv, void *recv_arg)
* then.) * then.)
* *
* @param pcb the raw pcb which to send * @param pcb the raw pcb which to send
* @param p the IP payload to send * @param p the IP payload to send. pbuf layer must be @ref PBUF_IP.
* @param ipaddr the destination address of the IP packet * @param ipaddr the destination address of the IP packet
* *
*/ */
@ -393,7 +393,7 @@ raw_sendto(struct raw_pcb *pcb, struct pbuf *p, const ip_addr_t *ipaddr)
* Send the raw IP packet to the address given by raw_connect() * Send the raw IP packet to the address given by raw_connect()
* *
* @param pcb the raw pcb which to send * @param pcb the raw pcb which to send
* @param p the IP payload to send * @param p the IP payload to send. pbuf layer must be @ref PBUF_IP.
* *
*/ */
err_t err_t

6
src/core/udp.c
View File

@ -462,7 +462,7 @@ chkerr:
* Send data using UDP. * Send data using UDP.
* *
* @param pcb UDP PCB used to send the data. * @param pcb UDP PCB used to send the data.
* @param p chain of pbuf's to be sent. * @param p chain of pbuf's to be sent. pbuf layer must be @ref PBUF_TRANSPORT.
* *
* The datagram will be sent to the current remote_ip & remote_port * The datagram will be sent to the current remote_ip & remote_port
* stored in pcb. If the pcb is not bound to a port, it will * stored in pcb. If the pcb is not bound to a port, it will
@ -511,7 +511,7 @@ udp_send_chksum(struct udp_pcb *pcb, struct pbuf *p,
* Send data to a specified address using UDP. * Send data to a specified address using UDP.
* *
* @param pcb UDP PCB used to send the data. * @param pcb UDP PCB used to send the data.
* @param p chain of pbuf's to be sent. * @param p chain of pbuf's to be sent. pbuf layer must be @ref PBUF_TRANSPORT.
* @param dst_ip Destination IP address. * @param dst_ip Destination IP address.
* @param dst_port Destination UDP port. * @param dst_port Destination UDP port.
* *
@ -598,7 +598,7 @@ udp_sendto_chksum(struct udp_pcb *pcb, struct pbuf *p, const ip_addr_t *dst_ip,
* on a netif that is still down. * on a netif that is still down.
* *
* @param pcb UDP PCB used to send the data. * @param pcb UDP PCB used to send the data.
* @param p chain of pbuf's to be sent. * @param p chain of pbuf's to be sent. pbuf layer must be @ref PBUF_TRANSPORT.
* @param dst_ip Destination IP address. * @param dst_ip Destination IP address.
* @param dst_port Destination UDP port. * @param dst_port Destination UDP port.
* @param netif the netif used for sending. * @param netif the netif used for sending.

3
src/include/lwip/pbuf.h
View File

@ -71,8 +71,7 @@ extern "C" {
*/ */
typedef enum { typedef enum {
/** Includes spare room for transport layer header, e.g. TCP header. /** Includes spare room for transport layer header, e.g. TCP header.
* Use this if you intend to pass the pbuf to functions like udp_send() or * Use this if you intend to pass the pbuf to functions like udp_send().
* tcp_write().
*/ */
PBUF_TRANSPORT, PBUF_TRANSPORT,
/** Includes spare room for IP header. /** Includes spare room for IP header.

2
src/netif/ethernet.c
View File

@ -246,7 +246,7 @@ free_and_return:
* @see @ref LWIP_HOOK_UNKNOWN_ETH_PROTOCOL * @see @ref LWIP_HOOK_UNKNOWN_ETH_PROTOCOL
* *
* @param netif the lwIP network interface on which to send the packet * @param netif the lwIP network interface on which to send the packet
* @param p the packet to send, p->payload pointing to the (uninitialized) ethernet header * @param p the packet to send. pbuf layer must be @ref PBUF_LINK.
* @param src the source MAC address to be copied into the ethernet header * @param src the source MAC address to be copied into the ethernet header
* @param dst the destination MAC address to be copied into the ethernet header * @param dst the destination MAC address to be copied into the ethernet header
* @param eth_type ethernet type (@ref eth_type) * @param eth_type ethernet type (@ref eth_type)