Add PBUF_NEEDS_COPY macro to documentation

This commit is contained in:
Dirk Ziegelmeier 2017-04-27 19:25:19 +02:00
parent 1add8c14ca
commit 83d0607acf

View File

@ -55,7 +55,8 @@ extern "C" {
#define LWIP_SUPPORT_CUSTOM_PBUF ((IP_FRAG && !LWIP_NETIF_TX_SINGLE_PBUF) || (LWIP_IPV6 && LWIP_IPV6_FRAG)) #define LWIP_SUPPORT_CUSTOM_PBUF ((IP_FRAG && !LWIP_NETIF_TX_SINGLE_PBUF) || (LWIP_IPV6 && LWIP_IPV6_FRAG))
#endif #endif
/** PBUF_NEEDS_COPY(p): return a boolean value indicating whether the given /** @ingroup pbuf
* PBUF_NEEDS_COPY(p): return a boolean value indicating whether the given
* pbuf needs to be copied in order to be kept around beyond the current call * pbuf needs to be copied in order to be kept around beyond the current call
* stack without risking being corrupted. The default setting provides safety: * stack without risking being corrupted. The default setting provides safety:
* it will make a copy iof any pbuf chain that does not consist entirely of * it will make a copy iof any pbuf chain that does not consist entirely of