Skip to content

Commit

Permalink
gnrc_sixlowpan_frag/rbuf: document undocumented functions
Browse files Browse the repository at this point in the history
This adds documentation for the following undocumented functions:

- rbuf_rm()
- rbuf_entry_empty()
  • Loading branch information
miri64 committed Apr 18, 2019
1 parent a0ee219 commit 6610ac9
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions sys/net/gnrc/network_layer/sixlowpan/frag/rbuf.h
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,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);
}
Expand Down

0 comments on commit 6610ac9

Please # to comment.