Skip to content
Snippets Groups Projects
Unverified Commit 1140b37c authored by Joakim Nohlgård's avatar Joakim Nohlgård Committed by GitHub
Browse files

Merge pull request #10278 from miri64/gnrc_pktbuf/doc/clarify-start-write

gnrc_pktbuf: clarify doc of _start_write()
parents 21efb201 99e3d780
No related branches found
No related tags found
No related merge requests found
...@@ -172,16 +172,16 @@ static inline void gnrc_pktbuf_release(gnrc_pktsnip_t *pkt) ...@@ -172,16 +172,16 @@ static inline void gnrc_pktbuf_release(gnrc_pktsnip_t *pkt)
} }
/** /**
* @brief Must be called once before there is a write operation in a thread. * @brief Must be called once before there is a write operation on a
* [packet snip](@ref gnrc_pktsnip_t) in a thread.
* *
* @details This function duplicates a packet in the packet buffer if * @details This function duplicates a packet snip in the packet buffer (both
* the instance of the gnrc_pktsnip_t and its data) if
* gnrc_pktsnip_t::users of @p pkt > 1. * gnrc_pktsnip_t::users of @p pkt > 1.
* *
* @note Do *not* call this function in a thread twice on the same packet. * @param[in] pkt The packet snip you want to write into.
* *
* @param[in] pkt The packet you want to write into. * @return The (new) pointer to the packet snip.
*
* @return The (new) pointer to the pkt.
* @return NULL, if gnrc_pktsnip_t::users of @p pkt > 1 and if there is not * @return NULL, if gnrc_pktsnip_t::users of @p pkt > 1 and if there is not
* enough space in the packet buffer. * enough space in the packet buffer.
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment