From cf66233873e579a162ba05c5e87c1a2ae98c0efd Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Sat, 6 Aug 2016 22:28:12 +0200 Subject: [PATCH] PBUF layer documentation clarification --- src/include/lwip/pbuf.h | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/include/lwip/pbuf.h b/src/include/lwip/pbuf.h index 32b75626..509bd475 100644 --- a/src/include/lwip/pbuf.h +++ b/src/include/lwip/pbuf.h @@ -82,16 +82,15 @@ typedef enum { /** Includes spare room for link layer header (ethernet header). * Use this if you intend to pass the pbuf to functions like ip4_output(), * ip6_output() or ip_output(). + * @see @ref PBUF_LINK_HLEN */ PBUF_LINK, /** Includes spare room for additional encapsulation header before ethernet headers (e.g. 802.11). - * Use this if you intend to pass the pbuf to functions like netif->linkoutput() + * Use this if you intend to pass the pbuf to functions like netif->linkoutput(). + * @see @ref PBUF_LINK_ENCAPSULATION_HLEN */ PBUF_RAW_TX, - /** No spare room, final packet for sending. - * Use this if you intend to pass the pbuf to functions like netif->linkoutput() - * or for input packets received by ethernet-layer netif drivers. - */ + /** Use this for input packets received by ethernet-layer netif drivers. */ PBUF_RAW } pbuf_layer;