From 488da516cd1ec4497fd648d4fb43516b34233d5c Mon Sep 17 00:00:00 2001 From: derselbst Date: Fri, 28 Dec 2018 14:54:13 +0100 Subject: [PATCH] clarify documentation of fluid_sample_sizeof() --- src/sfloader/fluid_sfont.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/sfloader/fluid_sfont.c b/src/sfloader/fluid_sfont.c index 405bec6c..978ba591 100644 --- a/src/sfloader/fluid_sfont.c +++ b/src/sfloader/fluid_sfont.c @@ -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() {