clap

commit b07c141f931de4360d7b1f3f88ad3edf632eac68
parent 49b4b87190af6a19477c89c75510c6a5d902984b
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date:   Fri, 17 Jun 2022 13:21:53 +0200

Apply baconpaul's suggested documentation

Diffstat:
M
include/clap/ext/params.h
 | 
7
+++++--

1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/include/clap/ext/params.h b/include/clap/ext/params.h
@@ -281,8 +281,11 @@ typedef struct clap_host_params {
 
    // Request a parameter flush.
    //
-   // If the plugin is processing, then the parameters flush will happen during the process() call.
-   // If the plugin isn't processing, then the host will call to clap_plugin_params->fush().
+   // If the plugin is processing, this will result in no action. The process call
+   // will run normally. If plugin isn't processing, the host will make a subsequent
+   // call to clap_plugin_params->flush(). As a result, this function is always
+   // safe to call from a non-audio thread (typically the UI thread on a gesture)
+   // whether processing is active or not.
    //
    // This must not be called on the [audio-thread].
    // [thread-safe,!audio-thread]