Remove misleading comments from udp_send() and raw_send(). A pbuf may be added automatically in front of the chain to be able to send PBUF_REFs

This commit is contained in:
Dirk Ziegelmeier 2016-08-24 08:45:37 +02:00
parent 6fc7f84497
commit 8426dfa14d
2 changed files with 5 additions and 5 deletions

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. pbuf layer must be @ref PBUF_IP. * @param p the IP payload to send
* @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. pbuf layer must be @ref PBUF_IP. * @param p the IP payload to send
* *
*/ */
err_t err_t

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. pbuf layer must be @ref PBUF_TRANSPORT. * @param p chain of pbuf's to be sent.
* *
* 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. pbuf layer must be @ref PBUF_TRANSPORT. * @param p chain of pbuf's to be sent.
* @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. pbuf layer must be @ref PBUF_TRANSPORT. * @param p chain of pbuf's to be sent.
* @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.