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
This commit is contained in:
Aidan MacDonald 2022-11-30 01:32:19 +00:00
parent 528dd0b03d
commit d7557e8da8

View file

@ -163,8 +163,9 @@ struct settings_list {
int lang_id; /* -1 for none */ int lang_id; /* -1 for none */
union storage_type default_val; union storage_type default_val;
const char *cfg_name; /* this settings name in the cfg file */ const char *cfg_name; /* this settings name in the cfg file */
const char *cfg_vals; /*comma seperated legal values, or NULL */ const char *cfg_vals; /* comma seperated symbolic values for bool
/* used with F_T_UCHARPTR this is the folder prefix */ * or choice/table settings -- the i'th value
* maps to the integer i */
union { union {
const void *RESERVED; /* to stop compile errors, will be removed */ const void *RESERVED; /* to stop compile errors, will be removed */
const struct sound_setting *sound_setting; /* use F_T_SOUND for this */ const struct sound_setting *sound_setting; /* use F_T_SOUND for this */