summaryrefslogtreecommitdiffstats
path: root/docs/keymap.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-03-26 01:44:17 +0200
committerskullydazed <skullydazed@users.noreply.github.com>2018-03-26 01:44:17 +0200
commit07b90db89758c42f7aacf52d93446b9407b87a98 (patch)
tree29392050d8c473eb0c6874977477ba32a9176f3b /docs/keymap.md
parent0c665696d7b498bd278d05eed3b52c1fac89ff29 (diff)
downloadqmk_firmware-07b90db89758c42f7aacf52d93446b9407b87a98.tar.gz
qmk_firmware-07b90db89758c42f7aacf52d93446b9407b87a98.tar.xz
Fixes and updates to docs (#2611)
* Fix advanced keycode headers * Add caveat for OSM over Remote Desktop * Hopefully add better anchors to docs * Add Action code list reference * Formatting of RGB Underglow doc * Add brew update issue on macOS * Revert formatting * Revert RGB doc formatting * Make Config Options doc's sections linkable
Diffstat (limited to 'docs/keymap.md')
-rw-r--r--docs/keymap.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/keymap.md b/docs/keymap.md
index 090a92661..b28d21a21 100644
--- a/docs/keymap.md
+++ b/docs/keymap.md
@@ -171,6 +171,8 @@ In this case we've instructed QMK to call the `ACTION_FUNCTION` callback, which
> This `fn_actions[]` interface is mostly for backward compatibility. In QMK, you don't need to use `fn_actions[]`. You can directly use `ACTION_FUNCTION(N)` or any other action code value itself normally generated by the macro in `keymaps[][MATRIX_ROWS][MATRIX_COLS]`. N in `F(N)` can only be 0 to 31. Use of the action code directly in `keymaps` unlocks this limitation.
+You can get a full list of Action Functions in [action_code.h](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action_code.h).
+
#### `action_function()`
To actually handle the keypress event we define an `action_function()`. This function will be called when the key is pressed, and then again when the key is released. We have to handle both situations within our code, as well as determining whether to send/release `KC_ESC` or `KC_GRAVE`.