alvierahman90/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Docs: Fix some minor errors in tap dance example (#3530)

Browse Source 
* Fix some minor errors in tap dance example

Fix for #3529
Fix minor errors in the code examples for __Example 4: 'Quad Function Tap-Dance'__ and relevant documentation. 
Clarified the need to include the header file in `keymap.c`.

* Use #pragma once in header guard

Fix for #3529
Implement change requested in #3530
This commit is contained in:
Emmanuel Odongo 2018-08-01 02:50:02 +02:00 committed by Drashna Jaelre
parent cbf200e9dd
commit bb86d8a00c
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/feature_tap_dance.md
View File

@ -196,22 +196,20 @@ SRC += your_name.c
Pretty simple. It is a nice way to keep some rules common on all your keymaps. Pretty simple. It is a nice way to keep some rules common on all your keymaps.
### In `/qmk_firmware/users/<your_name>/<you_name>.h` ### In `/qmk_firmware/users/<your_name>/<your_name>.h`
You will need a few things in this file: You will need a few things in this file:
```c ```c
#ifndef YOUR_NAME #pragma once
#define YOUR_NAME
#include "quantum.h" #include "quantum.h"
#include "process_keycode/process_tap_dance.h" #include "process_keycode/process_tap_dance.h"
typedef struct { typedef struct {
bool is_press_action; bool is_press_action;
int state; int state;
} xtap; } tap;
enum { enum {
SINGLE_TAP = 1, SINGLE_TAP = 1,
@ -225,9 +223,9 @@ enum {
//Tap dance enums //Tap dance enums
enum { enum {
CTL_X = 0, X_CTL = 0,
SOME_OTHER_DANCE SOME_OTHER_DANCE
} };
int cur_dance (qk_tap_dance_state_t *state); int cur_dance (qk_tap_dance_state_t *state);
@ -241,7 +239,7 @@ void x_reset (qk_tap_dance_state_t *state, void *user_data);
And then in your user's `.c` file you implement the functions above: And then in your user's `.c` file you implement the functions above:
```c ```c
#include "gordon.h" #include "<your_name>.h"
#include "quantum.h" #include "quantum.h"
#include "action.h" #include "action.h"
#include "process_keycode/process_tap_dance.h" #include "process_keycode/process_tap_dance.h"
@ -335,4 +333,4 @@ qk_tap_dance_action_t tap_dance_actions[] = {
}; };
``` ```
And then simply use TD(X_CTL) anywhere in your keymap. And then simply use `TD(X_CTL)` anywhere in your keymap after including `<your_name>.h`.