Skip to content

Commit da93c9c

Browse files
committed
Fix parameter order in key state functions for consistency
1 parent 4b7b271 commit da93c9c

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

keyboard/keyboard.cpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ void setKeyboardBrightness(uint8_t command)
213213
/**
214214
* @brief Checks if a key was released.
215215
*
216-
* @param colIndex The column index of the key.
217216
* @param rowIndex The row index of the key.
217+
* @param colIndex The column index of the key.
218218
* @return true if the key was released, false otherwise.
219219
*/
220220
bool keyReleased(int rowIndex, int colIndex)
@@ -225,8 +225,8 @@ bool keyReleased(int rowIndex, int colIndex)
225225
/**
226226
* @brief Checks if a key is being held.
227227
*
228-
* @param colIndex The column index of the key.
229228
* @param rowIndex The row index of the key.
229+
* @param colIndex The column index of the key.
230230
* @return true if the key is being held, false otherwise.
231231
*/
232232
bool keyHeld(int rowIndex, int colIndex)
@@ -237,8 +237,8 @@ bool keyHeld(int rowIndex, int colIndex)
237237
/**
238238
* @brief Checks if a key was pressed.
239239
*
240-
* @param colIndex The column index of the key.
241240
* @param rowIndex The row index of the key.
241+
* @param colIndex The column index of the key.
242242
* @return true if the key was pressed, false otherwise.
243243
*/
244244
bool keyPressed(int rowIndex, int colIndex)
@@ -249,8 +249,8 @@ bool keyPressed(int rowIndex, int colIndex)
249249
/**
250250
* @brief Checks if a key is not pressed.
251251
*
252-
* @param colIndex The column index of the key.
253252
* @param rowIndex The row index of the key.
253+
* @param colIndex The column index of the key.
254254
* @return true if the key is not pressed, false otherwise.
255255
*/
256256
bool keyNotPressed(int rowIndex, int colIndex)
@@ -261,8 +261,8 @@ bool keyNotPressed(int rowIndex, int colIndex)
261261
/**
262262
* @brief Checks if a key exists in the keymap.
263263
*
264-
* @param colIndex The column index of the key.
265264
* @param rowIndex The row index of the key.
265+
* @param colIndex The column index of the key.
266266
* @param keymap The keymap to check.
267267
* @return true if the key exists in the keymap, false otherwise.
268268
*/
@@ -307,8 +307,8 @@ void autoResetKeymapIndex()
307307
/**
308308
* @brief Sets the default character for a key.
309309
*
310-
* @param colIndex The column index of the key.
311310
* @param rowIndex The row index of the key.
311+
* @param colIndex The column index of the key.
312312
*/
313313
void setDefaultCharacter(int rowIndex, int colIndex)
314314
{
@@ -335,8 +335,8 @@ void setDefaultCharacter(int rowIndex, int colIndex)
335335
/**
336336
* @brief Sets the symbol character for a key.
337337
*
338-
* @param colIndex The column index of the key.
339338
* @param rowIndex The row index of the key.
339+
* @param colIndex The column index of the key.
340340
*/
341341
void setSymbolCharacter(int rowIndex, int colIndex)
342342
{

keyboard/keyboard.hpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,44 +74,44 @@ void onRequest();
7474
/**
7575
* @brief Checks if a key was released.
7676
*
77-
* @param colIndex The column index of the key.
7877
* @param rowIndex The row index of the key.
78+
* @param colIndex The column index of the key.
7979
* @return true if the key was released, false otherwise.
8080
*/
8181
bool keyReleased(int rowIndex, int colIndex);
8282

8383
/**
8484
* @brief Checks if a key is being held.
8585
*
86-
* @param colIndex The column index of the key.
8786
* @param rowIndex The row index of the key.
87+
* @param colIndex The column index of the key.
8888
* @return true if the key is being held, false otherwise.
8989
*/
9090
bool keyHeld(int rowIndex, int colIndex);
9191

9292
/**
9393
* @brief Checks if a key was pressed.
9494
*
95-
* @param colIndex The column index of the key.
9695
* @param rowIndex The row index of the key.
96+
* @param colIndex The column index of the key.
9797
* @return true if the key was pressed, false otherwise.
9898
*/
9999
bool keyPressed(int rowIndex, int colIndex);
100100

101101
/**
102102
* @brief Checks if a key is not pressed.
103103
*
104-
* @param colIndex The column index of the key.
105104
* @param rowIndex The row index of the key.
105+
* @param colIndex The column index of the key.
106106
* @return true if the key is not pressed, false otherwise.
107107
*/
108108
bool keyNotPressed(int rowIndex, int colIndex);
109109

110110
/**
111111
* @brief Checks if a key exists in the keymap.
112112
*
113-
* @param colIndex The column index of the key.
114113
* @param rowIndex The row index of the key.
114+
* @param colIndex The column index of the key.
115115
* @param keymap The keymap to check.
116116
* @return true if the key exists in the keymap, false otherwise.
117117
*/
@@ -149,16 +149,16 @@ void autoResetKeymapIndex();
149149
/**
150150
* @brief Sets keyInfo to the correct character for a specific key, from the default keymap only.
151151
*
152-
* @param colIndex The column index of the key.
153152
* @param rowIndex The row index of the key.
153+
* @param colIndex The column index of the key.
154154
*/
155155
void setDefaultCharacter(int rowIndex, int colIndex);
156156

157157
/**
158158
* @brief Sets keyInfo to the correct character for a specific key, from the symbol keymaps only.
159159
*
160-
* @param colIndex The column index of the key.
161160
* @param rowIndex The row index of the key.
161+
* @param colIndex The column index of the key.
162162
*/
163163
void setSymbolCharacter(int rowIndex, int colIndex);
164164

0 commit comments

Comments
 (0)