clarify documentation of fluid_sample_sizeof()

This commit is contained in:
derselbst 2018-12-28 14:54:13 +01:00
parent c8b18056c6
commit 488da516cd

View file

@ -515,6 +515,8 @@ delete_fluid_sample(fluid_sample_t *sample)
* Useful in low latency scenarios e.g. to allocate a sample on the stack.
*
* @return Size of fluid_sample_t in bytes
*
* @note It is recommend to zero initialize the memory before using the object.
*/
size_t fluid_sample_sizeof()
{