Bunch of reformatting, improvements to comments

This commit is contained in:
Christopher Browne 2016-01-29 12:49:43 -05:00
parent 753ffa4eed
commit 5e64f710dc

View File

@ -1,31 +1,30 @@
// This is the canonical layout file for the Quantum project. If you want to add another keyboard,
// this is the style you want to emulate.
#include "planck.h" #include "planck.h"
#ifdef BACKLIGHT_ENABLE #ifdef BACKLIGHT_ENABLE
#include "backlight.h" #include "backlight.h"
#endif #endif
// Each layer gets a name for readability, which is then used in the keymap matrix below. /* Each layer is given a name to aid in readability, which is then
// The underscores don't mean anything - you can have a layer called STUFF or any other name. used in the keymap matrix below. The underscores do not denote
// Layer names don't all need to be of the same length, obviously, and you can also skip them anything - you can have a layer called STUFF or any other name.
// entirely and just use numbers.
/* #define _QW 0 */ Layer names don't all need to be of the same length, obviously, and
/* #define _CM 1 */ you could also skip them entirely and just use numbers, though that
/* #define _DV 2 */ means needing to manage the numbers.
/* #define _LW 3 */
/* #define _RS 4 */ It is preferable to keep the symbols short so that a line worth of
key mappings fits compactly onto a line of code. */
enum layers { enum layers {
_QW = 0, _QW = 0, /* Qwerty mapping */
_CM, _CM, /* Colemak */
_DV, _DV, /* Dvorak */
_WK, _WK, /* Workman */
_LW, _LW, /* Lower layer, where top line has symbols !@#$%^&*() */
_RS, _RS, /* Raised layer, where top line has digits 1234567890 */
_KP _KP, /* Key pad */
}; };
/* Note that Planck has dimensions 4 rows x 12 columns */
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_QW] = { /* Qwerty */ [_QW] = { /* Qwerty */
@ -72,6 +71,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
} }
}; };
/* I'm planning to use this to set up some macros, including one to
expand into "cbbrowne", more to prove it can be done than anything
else.
*/
enum macro_id { enum macro_id {
M_P0, M_P0,