commit c95cbcef3631df134752fa396c1d441ee46f266b parent e59f86defaf33cb997045673229c2f4ef3f7007d Author: Alexandre Bique <bique.alexandre@gmail.com> Date: Mon, 26 Dec 2022 18:29:36 +0100 Merge pull request #263 from SamWindell/param-name-edit 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 @@ -217,11 +217,13 @@ typedef struct clap_param_info { // cookie in a faster time than a hashmap lookup per param 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