From d39015a4011e53612e117ac4091444bf67792105 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacek=20Kr=C3=B3likowski?= Date: Thu, 4 Dec 2025 13:15:43 +0100 Subject: [PATCH] [DOCS] Add `keycodes` to `info.json` docs. More precise matrix masking info (#25801) --- docs/reference_info_json.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index 91ab7f4577a..301e4b12dd0 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md @@ -327,6 +327,21 @@ Configures the [LED Indicators](features/led_indicators) feature. * `scroll_lock` Pin * The GPIO pin connected to the Scroll Lock LED. +## (Custom) Keycodes {#keycodes} + +Defines [custom keycodes](custom_quantum_functions#definining-a-new-keycode) for use within keymaps. + +* `keycodes` Array: Object + * A list of keycode objects. + * `key` String Required + * The enum name of the custom keycode. + * Example: `LAYER_CHANGE_BEEP_ON` + * `label` String + * A short description of the custom keycode. + * `aliases` Array: String + * A list of shortened names for the custom keycode. + * Example: `["LCBON", "LCB_ON"]` + ## Layouts {#layouts} The `layouts` portion of the dictionary contains several nested dictionaries. The outer layer consists of QMK layout names, for example `LAYOUT_60_ansi` or `LAYOUT_60_iso`. @@ -513,7 +528,7 @@ Configures the [LED Matrix](features/led_matrix) feature. * The amount of time to wait between row/col selection and col/row pin reading, in microseconds. * Default: `30` (30 µs) * `masked` Boolean - * Whether configured intersections should be ignored. + * Whether unconfigured intersections should be ignored. * Default: `false` * `rows` Array: Pin * A list of GPIO pins connected to the matrix rows.