Skip to content

Commit

Permalink
docs: fix spelling mistake in docstring of DEBOUNCE_THRESH constant a…
Browse files Browse the repository at this point in the history
…cross classes

Signed-off-by: Aditya Agarwal <[email protected]>
  • Loading branch information
Aditya-A-garwal committed Mar 24, 2024
1 parent 46eddbf commit fbed278
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion lib/gui/include/widgets/bitmap.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Bitmap : public BasicWidget, public InteractiveWidget {

protected:

/** The cooldown period between two pressed (used to prevent "bouncing", where a single press is detected as multiple) */
/** The cooldown period between two presses (used to prevent "bouncing", where a single press is detected as multiple) */
constexpr static unsigned DEBOUNCE_THRESH = 200;

/** Reference to parent frame */
Expand Down
2 changes: 1 addition & 1 deletion lib/gui/include/widgets/button.h
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ class Button : public BasicWidget, public InteractiveWidget {

protected:

/** The cooldown period between two pressed (used to prevent "bouncing", where a single press is detected as multiple) */
/** The cooldown period between two presses (used to prevent "bouncing", where a single press is detected as multiple) */
constexpr static unsigned DEBOUNCE_THRESH = 200;

constexpr static unsigned DEFAULT_WIDTH = 64;
Expand Down
2 changes: 1 addition & 1 deletion lib/gui/include/widgets/colorselector.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class ColorSelector : public BasicWidget, public InteractiveWidget {

protected:

/** The cooldown period between two pressed (used to prevent "bouncing", where a single press is detected as multiple) */
/** The cooldown period between two presses (used to prevent "bouncing", where a single press is detected as multiple) */
constexpr static unsigned DEBOUNCE_THRESH = 200;

constexpr static unsigned PAINT_RADIUS = 12;
Expand Down
4 changes: 2 additions & 2 deletions lib/gui/include/widgets/label.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @file label.h
* @author Aditya Agarwal ([email protected])
* @brief File that declares the `Label` class, which is a simple and flexible implementation of a box to display readonly text
* @brief File that declares the `Label` class, which is a simple and flexible implementation of a box to display text
*
*/

Expand Down Expand Up @@ -108,7 +108,7 @@ class LabelStyle {
};

/**
* @brief Class that provides a simple and flexible implementation of a box to display readonly text, includes styling
* @brief Class that provides a simple and flexible implementation of a box to display text, includes styling
*
*/
class Label : public BasicWidget {
Expand Down

0 comments on commit fbed278

Please sign in to comment.