summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAidan MacDonald <amachronic@protonmail.com>2022-11-30 01:32:19 +0000
committerAidan MacDonald <amachronic@protonmail.com>2022-12-01 14:24:51 -0500
commitd7557e8da81e8087e2c1a23395d0f1c15affb67f (patch)
treeae0cbb7fa21c544e442cafe8c538742674aff3a8
parent528dd0b03d27fa82b97e3fe785969b90f32cdeff (diff)
downloadrockbox-d7557e8da8.tar.gz
rockbox-d7557e8da8.zip
settings: Update doc comment for struct settings_list::cfg_vals
cfg_vals has not been used in conjunction with F_T_UCHARPTR for quite a while. Change-Id: I7f710201484ca25aab112897123afd07abdfd4c2
-rw-r--r--apps/settings_list.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/apps/settings_list.h b/apps/settings_list.h
index d4862874d5..d725bbef59 100644
--- a/apps/settings_list.h
+++ b/apps/settings_list.h
@@ -163,8 +163,9 @@ struct settings_list {
int lang_id; /* -1 for none */
union storage_type default_val;
const char *cfg_name; /* this settings name in the cfg file */
- const char *cfg_vals; /*comma seperated legal values, or NULL */
- /* used with F_T_UCHARPTR this is the folder prefix */
+ const char *cfg_vals; /* comma seperated symbolic values for bool
+ * or choice/table settings -- the i'th value
+ * maps to the integer i */
union {
const void *RESERVED; /* to stop compile errors, will be removed */
const struct sound_setting *sound_setting; /* use F_T_SOUND for this */