Skip to content

Commit

Permalink
minor doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
finger563 committed Dec 4, 2024
1 parent ce6378f commit 81018f5
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions components/interrupt/include/interrupt.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -118,16 +118,16 @@ class Interrupt : public BaseComponent {
/// \brief The configuration for an interrupt on a GPIO
/// \details This is used to configure the GPIO interrupt
struct PinConfig {
int gpio_num; ///< GPIO number to for this interrupt
event_callback_fn callback; ///< Callback for the interrupt event
bool auto_reenable = true; ///< Whether to auto reenable the
/// interrupt after it is triggered.
/// If false, the interrupt will
/// need to be < reenabled in the
/// callback or some other codepath.
/// If true, the interrupt will < be
/// reenabled automatically.
ActiveLevel active_level; ///< Active level of the GPIO
int gpio_num; ///< GPIO number to for this interrupt
event_callback_fn callback; ///< Callback for the interrupt event
bool auto_reenable = true; ///< Whether to auto reenable the
/// interrupt after it is triggered.
/// If false, the interrupt will
/// need to be reenabled in the
/// callback or some other codepath.
/// If true, the interrupt will be
/// reenabled automatically before the callback is called.
ActiveLevel active_level; ///< Active level of the GPIO
Type interrupt_type = Type::ANY_EDGE; ///< Interrupt type to use for the GPIO
bool pullup_enabled = false; ///< Whether to enable the pullup resistor
bool pulldown_enabled = false; ///< Whether to enable the pulldown resistor
Expand Down

0 comments on commit 81018f5

Please sign in to comment.