should not have been pub use, documentation fixes

This commit is contained in:
Vinzenz Schroeter 2024-05-28 22:23:21 +02:00
parent 69d4cff0bf
commit 084c3df1db
9 changed files with 43 additions and 31 deletions

View file

@ -735,7 +735,12 @@ bool sp_connection_send(const struct sp_Connection *connection,
/**
* Deallocates a `Packet`.
*
* Note: do not call this if the instance has been consumed in another way, e.g. by sending it.
* # Safety
*
* The caller has to make sure that:
*
* - `this` points to a valid `Packet`
* - `this` is not used concurrently or after this call
*/
void sp_packet_dealloc(struct sp_Packet *this_);