doc(interrupt): Update interrupt filter configuration to indicate that enabling pin filtering prevents light sleep #575
Conversation
…t enabling pin filtering prevents light sleep
There was a problem hiding this comment.
Pull request overview
This PR adds documentation to indicate that enabling GPIO pin filtering (either PIN_GLITCH_FILTER or FLEX_GLITCH_FILTER) prevents light sleep mode from being enabled. This is important operational information for users who need to understand power management implications.
Key Changes
- Added inline documentation note to the
filter_typemember explaining the light sleep behavior constraint
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| FilterType::NONE; ///< The type of filter to use. If set to FLEX_GLITCH_FILTER, the | ||
| ///< filter_config should be set. | ||
| ///< | ||
| ///< @note If not FilterType::NONE, then light |
There was a problem hiding this comment.
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.
| ///< @note If not FilterType::NONE, then light | |
| ///< \note If not FilterType::NONE, then light |
| FilterType filter_type = | ||
| FilterType::NONE; ///< The type of filter to use. If set to FLEX_GLITCH_FILTER, the | ||
| ///< filter_config should be set. | ||
| ///< |
There was a problem hiding this comment.
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).
| ///< |
No description provided.