diff options
| author | Wojciech Siewierski <wojciech.siewierski@onet.pl> | 2017-05-04 22:39:02 +0200 |
|---|---|---|
| committer | Wojciech Siewierski <wojciech.siewierski@onet.pl> | 2017-05-04 22:39:02 +0200 |
| commit | 8e94c9b4cba4cf3479154a11faacfa2bbad50098 (patch) | |
| tree | fb23e1603d11d708fc743741ecddb72dc479e9a5 | |
| parent | 4b50ea15a954de2e6062aa7228bd1f9f76669ce7 (diff) | |
| download | qmk_firmware-8e94c9b4cba4cf3479154a11faacfa2bbad50098.tar.gz qmk_firmware-8e94c9b4cba4cf3479154a11faacfa2bbad50098.tar.xz | |
dynamic_macro.h: Make the documentation more clear
| -rw-r--r-- | quantum/dynamic_macro.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/quantum/dynamic_macro.h b/quantum/dynamic_macro.h index c4017aec9..6aae7d230 100644 --- a/quantum/dynamic_macro.h +++ b/quantum/dynamic_macro.h @@ -99,7 +99,7 @@ void dynamic_macro_play( * * @param macro_buffer[in] The start of the used macro buffer. * @param macro_pointer[in,out] The current buffer position. - * @param macro2_end[in] The last buffer element it is safe to use before overwriting the other macro. + * @param macro2_end[in] The end of the other macro. * @param direction[in] Either +1 or -1, which way to iterate the buffer. * @param record[in] The current keypress. */ @@ -115,6 +115,9 @@ void dynamic_macro_record_key( return; } + /* The other end of the other macro is the last buffer element it + * is safe to use before overwriting the other macro. + */ if (*macro_pointer - direction != macro2_end) { **macro_pointer = *record; *macro_pointer += direction; @@ -170,7 +173,7 @@ bool process_record_dynamic_macro(uint16_t keycode, keyrecord_t *record) * ¯o_buffer macro_end * v v * +------------------------------------------------------------+ - * |>>>>>> MACRO1 >>>>>>| |<<<<<<<<<<<<< MACRO2 <<<<<<<<<<<<<| + * |>>>>>> MACRO1 >>>>>> <<<<<<<<<<<<< MACRO2 <<<<<<<<<<<<<| * +------------------------------------------------------------+ * ^ ^ * r_macro_end r_macro_buffer |