Formatting fix.

This commit is contained in:
Pascal Getreuer 2025-01-22 00:06:42 -08:00
parent 8eaf67de76
commit 2a2771068c
2 changed files with 2 additions and 29 deletions

View File

@ -69,36 +69,10 @@ typedef struct keycode_string_name_t {
uint16_t keycode;
const char* name;
} keycode_string_name_t;
// typedef struct keycode_string_name_t keycode_string_name_t;
/**
* @brief Names for additional keycodes for `get_keycode_string()`.
*
* @note The table *must* end with `KEYCODE_STRING_NAMES_END`.
*
* Define the `custom_keycode_names` table in your keymap.c to add names for
* additional keycodes to `keycode_string()`. This table may also be used to
* override how `keycode_string()` formats a keycode. For example, supposing
* keymap.c defines `MYMACRO1` and `MYMACRO2` as custom keycodes:
*
* const keycode_string_name_t keycode_string_names_user[] = {
* KEYCODE_STRING_NAME(MYMACRO1),
* KEYCODE_STRING_NAME(MYMACRO2),
* KEYCODE_STRING_NAME(KC_EXLM),
* KEYCODE_STRING_NAMES_END // End of table sentinel.
* };
*
* The above defines names for `MYMACRO1` and `MYMACRO2`, and overrides
* `KC_EXLM` to format as "KC_EXLM" instead of the default "S(KC_1)".
*/
// extern const keycode_string_name_t* keycode_string_names_user;
/** Same as `keycode_string_names_user`, but for use at the keyboard level. */
// extern const keycode_string_name_t* keycode_string_names_kb;
/** Helper to define a keycode_string_name_t. */
# define KEYCODE_STRING_NAME(kc) {(kc), PSTR(#kc)}
/** Makes end-of-table sentinel for a table of keycode_string_name_t. */
# define KEYCODE_STRING_NAMES_END {0, NULL}
# define KEYCODE_STRING_NAME(kc) \
{ (kc), PSTR(#kc) }
#else

View File

@ -20,4 +20,3 @@
#define KEYCODE_STRING_NAMES_USER
#define KEYCODE_STRING_NAMES_KB