From 8634613509e2930a284373963a58d042c120a9e7 Mon Sep 17 00:00:00 2001 From: derselbst Date: Sat, 29 Dec 2018 18:26:37 +0100 Subject: [PATCH] fix incorrect documentation of fluid_sample_sizeof() --- src/sfloader/fluid_sfont.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/sfloader/fluid_sfont.c b/src/sfloader/fluid_sfont.c index 09df0e37..548a80ab 100644 --- a/src/sfloader/fluid_sfont.c +++ b/src/sfloader/fluid_sfont.c @@ -512,11 +512,13 @@ delete_fluid_sample(fluid_sample_t *sample) /** * Returns the size of the fluid_sample_t structure. * - * Useful in low latency scenarios e.g. to allocate a sample on the stack. + * Useful in low latency scenarios e.g. to allocate a pool of samples. * * @return Size of fluid_sample_t in bytes * * @note It is recommend to zero initialize the memory before using the object. + * + * @warning Do NOT allocate samples on the stack and assign them to a voice! */ size_t fluid_sample_sizeof() {