Skip to content

Commit

Permalink
docs: 📝 Remove @brief from member vars in Button class
Browse files Browse the repository at this point in the history
  • Loading branch information
ion098 authored Aug 12, 2024
1 parent f34e6d7 commit 402a090
Showing 1 changed file with 7 additions and 25 deletions.
32 changes: 7 additions & 25 deletions include/gamepad/controller.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,35 +23,17 @@ enum EventType {
class Button {
friend class Controller;
public:
/**
* @brief Whether the button has just been pressed
*
*/
/* Whether the button has just been pressed */
bool rising_edge = false;
/**
* @brief Whether the button has just been released
*
*/
/* Whether the button has just been released */
bool falling_edge = false;
/**
* @brief Whether the button is currently held down
*
*/
/* Whether the button is currently held down */
bool is_pressed = false;
/**
* @brief How long the button has been held down
*
*/
/* How long the button has been held down */
uint32_t time_held = 0;
/**
* @brief How long the button has been released
*
*/
/* How long the button has been released */
uint32_t time_released = 0;
/**
* @brief How long the threshold should be for the longPress and shortRelease events
*
*/
/* How long the threshold should be for the longPress and shortRelease events */
uint32_t long_press_threshold = 500;
/**
* @brief Register a function to run when the button is pressed.
Expand Down Expand Up @@ -194,4 +176,4 @@ class Controller {
void updateButton(pros::controller_digital_e_t button_id);
pros::Controller controller;
}; // namespace Gamepad
} // namespace Gamepad
} // namespace Gamepad

0 comments on commit 402a090

Please sign in to comment.