From 43dedfcd2c52c15fb083e0d984c23c6f6e550cb6 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Thu, 18 Apr 2019 12:21:47 +0200 Subject: [PATCH] gnrc_sixlowpan_frag/rbuf: document undocumented functions This adds documentation for the following undocumented functions: - rbuf_rm() - rbuf_entry_empty() --- .../gnrc/network_layer/sixlowpan/frag/rbuf.h | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/sys/net/gnrc/network_layer/sixlowpan/frag/rbuf.h b/sys/net/gnrc/network_layer/sixlowpan/frag/rbuf.h index 957e2573d9..8e067490ad 100644 --- a/sys/net/gnrc/network_layer/sixlowpan/frag/rbuf.h +++ b/sys/net/gnrc/network_layer/sixlowpan/frag/rbuf.h @@ -96,8 +96,28 @@ void rbuf_add(gnrc_netif_hdr_t *netif_hdr, gnrc_pktsnip_t *frag, */ void rbuf_gc(void); +/** + * @brief Unsets a reassembly buffer entry (but does not free + * rbuf_t::super::pkt) + * + * This functions sets rbuf_t::super::pkt to NULL and removes all rbuf::ints. + * + * @param[in] rbuf A reassembly buffer entry + * + * @internal + */ void rbuf_rm(rbuf_t *rbuf); +/** + * @brief Checks if a reassembly buffer entry is unset + * + * @param[in] rbuf A reassembly buffer entry + * + * @return true, if @p rbuf is empty (i.e. rbuf->super.pkt is NULL). + * @return false, if @p rbuf is in use. + * + * @internal + */ static inline bool rbuf_entry_empty(const rbuf_t *rbuf) { return (rbuf->super.pkt == NULL); }