From 2cd233537a0e743df2dab7204ef14d3d1140a364 Mon Sep 17 00:00:00 2001 From: Stephane Letz Date: Thu, 20 Nov 2014 16:27:11 +0100 Subject: [PATCH] Improve documentation. --- common/jack/types.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/common/jack/types.h b/common/jack/types.h index d9b6c43a..094d4074 100644 --- a/common/jack/types.h +++ b/common/jack/types.h @@ -440,7 +440,8 @@ typedef void (*JackShutdownCallback)(void *arg); * the callback context. * @param code a status word, formed by OR-ing together the relevant @ref JackStatus bits. - * @param reason a string describing the shutdown reason (backend failure, server crash... etc...) + * @param reason a string describing the shutdown reason (backend failure, server crash... etc...). + * Note that this string will not be available anymore after the callback returns, so possibly copy it. * @param arg pointer to a client supplied structure */ typedef void (*JackInfoShutdownCallback)(jack_status_t code, const char* reason, void *arg);