clap

commit 3eeb4820608ba5b714ed2b32dbf13b57b24c31e2
parent a27cace9da9ae325213d6940d358921e78a03f9d
Author: Sam Windell <info@frozenplain.com>
Date:   Mon, 26 Dec 2022 17:01:55 +0000

Document more precise use of param name vs module

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

1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/include/clap/ext/params.h b/include/clap/ext/params.h
@@ -221,11 +221,13 @@ typedef struct clap_param_info {
    //    per event.
    void *cookie;
 
-   // the display name
+   // The display name. eg: "Volume". This does not need to be unique. Do not include the module
+   // text in this. The host should concatenate/format the module + name in the case where showing
+   // the name alone would be too vague.
    char name[CLAP_NAME_SIZE];
 
-   // the module path containing the param, eg:"oscillators/wt1"
-   // '/' will be used as a separator to show a tree like structure.
+   // The module path containing the param, eg: "Oscillators/Wavetable 1".
+   // '/' will be used as a separator to show a tree-like structure.
    char module[CLAP_PATH_SIZE];
 
    double min_value;     // minimum plain value