From fbed278aa9bf76b80afffe4c01ec42686938112a Mon Sep 17 00:00:00 2001 From: Aditya Agarwal Date: Sun, 24 Mar 2024 18:54:56 +0530 Subject: [PATCH] docs: fix spelling mistake in docstring of DEBOUNCE_THRESH constant across classes Signed-off-by: Aditya Agarwal --- lib/gui/include/widgets/bitmap.h | 2 +- lib/gui/include/widgets/button.h | 2 +- lib/gui/include/widgets/colorselector.h | 2 +- lib/gui/include/widgets/label.h | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/gui/include/widgets/bitmap.h b/lib/gui/include/widgets/bitmap.h index 4588589..2d3fff4 100644 --- a/lib/gui/include/widgets/bitmap.h +++ b/lib/gui/include/widgets/bitmap.h @@ -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 */ diff --git a/lib/gui/include/widgets/button.h b/lib/gui/include/widgets/button.h index 3cf071c..0948e3c 100644 --- a/lib/gui/include/widgets/button.h +++ b/lib/gui/include/widgets/button.h @@ -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; diff --git a/lib/gui/include/widgets/colorselector.h b/lib/gui/include/widgets/colorselector.h index e365197..267e44c 100644 --- a/lib/gui/include/widgets/colorselector.h +++ b/lib/gui/include/widgets/colorselector.h @@ -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; diff --git a/lib/gui/include/widgets/label.h b/lib/gui/include/widgets/label.h index bedd94d..4f9d4ef 100644 --- a/lib/gui/include/widgets/label.h +++ b/lib/gui/include/widgets/label.h @@ -1,7 +1,7 @@ /** * @file label.h * @author Aditya Agarwal (aditya.agarwal@dumblebots.com) - * @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 * */ @@ -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 {