muflax
/
ergodox-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fixed a comment, and made a few var names more consistent

partial-rewrite
Ben Blazak 2013-04-19 16:44:57 -07:00
parent 316f54596e
commit a6ec78cd34
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
firmware/keyboard/ergodox/layout/common/definitions.h
View File

@ -5,7 +5,8 @@
* ------------------------------------------------------------------------- */
/** description
* A central place for the `#include`s relevant to the layout files
* A central place for all `#include`s and common definitions relevant to the
* layout files
*/
@ -78,32 +79,32 @@ void KF(nop) (void) {}
// ----------------------------------------------------------------------------
/** typedefs/key_t/description
/** typedefs/_key_t/description
* The type we will use for our "key"s
*
* Notes:
* - Keys will be of the form
* `key_t key = { &press_function, &release_function };`
* `_key_t key = { &press_function, &release_function };`
*
* - The fact that keys are of this type (composed of two
* `void (*function)(void)` pointers) is assumed throughout most of these
* layout files
*/
typedef void (*key_t[2])(void);
typedef void (*_key_t[2])(void);
/** typedefs/layout_t/description
/** typedefs/_layout_t/description
* The type we will use for our layout matrix
*
* Notes:
* - The first dimension of the matrix (left blank in the typedef since it
* varies between layouts) is "layers"
*/
typedef const key_t PROGMEM layout_t[][OPT__KB__ROWS][OPT__KB__COLUMNS];
typedef const _key_t PROGMEM _layout_t[][OPT__KB__ROWS][OPT__KB__COLUMNS];
/** variables/layout/description
* The variable containing our layout matrix
*/
layout_t _layout;
_layout_t _layout;
/** variables/sticky_key/description
* A pointer to the release function of the last sticky key pressed