Skip to content

Commit 0009354

Browse files
author
dave
committed
Minor documentation improvement.
1 parent 85960c1 commit 0009354

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/BaseRenderers.h

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,16 @@ bool isItemActionable(MenuItem* item);
3636
/**
3737
* an enumeration of possible values that are given to either custom render functions or used internally
3838
* by renderers to describe the state of the select button. Values should be self explanatory. High
39-
* compatability with bool for determining if the button is pressed.
39+
* compatibility with bool for determining if the button is pressed.
4040
*/
41-
enum RenderPressMode: uint8_t { RPRESS_NONE = 0, RPRESS_PRESSED = 1, RPRESS_HELD = 2 };
41+
enum RenderPressMode: uint8_t {
42+
/** The select button is not pressed */
43+
RPRESS_NONE = 0,
44+
/** The select button has been pressed */
45+
RPRESS_PRESSED = 1,
46+
/** The selected button is held down */
47+
RPRESS_HELD = 2
48+
};
4249

4350
/**
4451
* Used to take over rendering for a period of time. Normally one calls renderer.takeOverDisplay(..)

0 commit comments

Comments
 (0)