Skip to content

doc(interrupt): Update interrupt filter configuration to indicate that enabling pin filtering prevents light sleep #575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
finger563 merged 1 commit into from
Dec 17, 2025
Merged

doc(interrupt): Update interrupt filter configuration to indicate that enabling pin filtering prevents light sleep #575

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions components/interrupt/include/interrupt.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ class Interrupt : public BaseComponent {
FilterType filter_type =
FilterType::NONE; ///< The type of filter to use. If set to FLEX_GLITCH_FILTER, the
///< filter_config should be set.
///<
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The empty comment line seems unnecessary. The note could be added directly after the existing comment on line 136, or the empty line could be removed and the note placed immediately after. This would be more consistent with other multi-line member comments in the file (see lines 123-129 for example).

Suggested change
///<

Copilot uses AI. Check for mistakes.
///< @note If not FilterType::NONE, then light
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation uses @note but the codebase consistently uses \note for Doxygen notes (see lines 100 and 102 in the same file). Please change @note to \note to maintain consistency with the existing documentation style.

Suggested change
///< @note If not FilterType::NONE, then light
///< \note If not FilterType::NONE, then light

Copilot uses AI. Check for mistakes.
/// sleep will be disabled.
FilterConfig filter_config{}; ///< The configuration for the filter. This is only used if
///< filter_type is set to FLEX_GLITCH_FILTER
};
Expand Down