From 6fc7f8449741f6289f596e4748607266c6b1dd45 Mon Sep 17 00:00:00 2001
From: Dirk Ziegelmeier <dirk@ziegelmeier.net>
Date: Wed, 24 Aug 2016 08:19:51 +0200
Subject: [PATCH] Minor: documentation updates

---
 src/core/raw.c          | 4 ++--
 src/core/udp.c          | 6 +++---
 src/include/lwip/pbuf.h | 3 +--
 src/netif/ethernet.c    | 2 +-
 4 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/src/core/raw.c b/src/core/raw.c
index efa21f90..e024410e 100644
--- a/src/core/raw.c
+++ b/src/core/raw.c
@@ -271,7 +271,7 @@ raw_recv(struct raw_pcb *pcb, raw_recv_fn recv, void *recv_arg)
  * then.)
  *
  * @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
  *
  */
@@ -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()
  *
  * @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
diff --git a/src/core/udp.c b/src/core/udp.c
index bb957faf..050a9364 100644
--- a/src/core/udp.c
+++ b/src/core/udp.c
@@ -462,7 +462,7 @@ chkerr:
  * Send data using UDP.
  *
  * @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
  * 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.
  *
  * @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_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.
  *
  * @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_port Destination UDP port.
  * @param netif the netif used for sending.
diff --git a/src/include/lwip/pbuf.h b/src/include/lwip/pbuf.h
index 3129311d..d21ab8cb 100644
--- a/src/include/lwip/pbuf.h
+++ b/src/include/lwip/pbuf.h
@@ -71,8 +71,7 @@ extern "C" {
  */
 typedef enum {
   /** 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
-   * tcp_write().
+   * Use this if you intend to pass the pbuf to functions like udp_send().
    */
   PBUF_TRANSPORT,
   /** Includes spare room for IP header.
diff --git a/src/netif/ethernet.c b/src/netif/ethernet.c
index e0c19760..fcb259c1 100644
--- a/src/netif/ethernet.c
+++ b/src/netif/ethernet.c
@@ -246,7 +246,7 @@ free_and_return:
  * @see @ref LWIP_HOOK_UNKNOWN_ETH_PROTOCOL
  *
  * @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 dst the destination MAC address to be copied into the ethernet header
  * @param eth_type ethernet type (@ref eth_type)