From c4baec6695344726d5a2e491ec2680bbc2903660 Mon Sep 17 00:00:00 2001 From: paul Date: Tue, 1 Mar 2011 14:46:07 +0000 Subject: [PATCH] tweak weak linkage comments and fix typo git-svn-id: svn+ssh://jackaudio.org/trunk/jack@4137 0c269be4-1314-0410-8aa9-9f06e86f4224 --- jack/weakjack.h | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/jack/weakjack.h b/jack/weakjack.h index c636690..2fe3d5c 100644 --- a/jack/weakjack.h +++ b/jack/weakjack.h @@ -49,17 +49,23 @@ * someone tries to run Jill with the "old" version of JACK. However, functions * added to JACK after version 0.116.2 are all declared to have "weak" linkage * which means that their abscence doesn't cause an error during program - * startup. Instead, Jill can test whether or not the symbol jack_set_latency_callback() + * startup. Instead, Jill can test whether or not the symbol jack_set_latency_callback * is null or not. If its null, it means that the JACK installed on this machine * is too old to support this function. If its not null, then Jill can use it - * just like any other function in the API. + * just like any other function in the API. For example: + * + * \code + * if (jack_set_latency_callback) { + * jack_set_latency_callback (jill_client, jill_latency_callback, arg); + * } + * \endcode * * However, there are clients that may want to use this approach to parts of the * the JACK API that predate 0.116.2. For example, they might want to see if even * really old basic parts of the API like jack_client_open() exist at runtime. * * Such clients should include before any other JACK header. - * This will make the ENTIRE JACK API be subject to weak linkage, so that any + * This will make the \b entire JACK API be subject to weak linkage, so that any * and all functions can be checked for existence at runtime. It is important * to understand that very few clients need to do this - if you use this * feature you should have a clear reason to do so. @@ -96,6 +102,6 @@ #endif #endif -x1/*@}*/ +/*@}*/ #endif /* weakjack */