doc: lib: add bm_buttons documentation #422
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
changelog-entry-required
eivindj-nordic
force-pushed
the
doc_buttons
branch
from
242bb56 to
424e74a
Compare
|
You can find the documentation preview for this PR here. |
MirkoCovizzi
reviewed
Oct 9, 2025
eivindj-nordic
force-pushed
the
doc_buttons
branch
from
424e74a to
eadc3f0
Compare
anhmolt
reviewed
Oct 13, 2025
eivindj-nordic
force-pushed
the
doc_buttons
branch
2 times, most recently
from
8893adc to
b204d0b
Compare
anhmolt
approved these changes
Oct 14, 2025
doc/nrf-bm/libraries/buttons.rst
Outdated
| To handle debouncing, a timer is started in the GPIOTE event handler. | ||
| The button will only be reported as pushed to the application if the corresponding pin is still active when the timer expires. | ||
|
|
||
| The button handling library uses the ``bm_timer`` module. |
There was a problem hiding this comment.
Thinking this can be removed. It is mentioned above that the library uses a timer, and the bm_timer module is mentioned in the dependencies section.
|
|
||
| This library uses the following |BMshort| libraries: | ||
|
|
||
| * Timer - :kconfig:option:`CONFIG_BM_TIMER` |
There was a problem hiding this comment.
When more of the library documentation is merged, this section (and this section in other modules) could be updated with links.
eivindj-nordic
force-pushed
the
doc_buttons
branch
from
b204d0b to
f5071e8
Compare
eivindj-nordic
force-pushed
the
doc_buttons
branch
from
f5071e8 to
f8c3f6d
Compare
Add documentation for bm_buttons library. Signed-off-by: Eivind Jølsgard <[email protected]>
eivindj-nordic
force-pushed
the
doc_buttons
branch
from
f8c3f6d to
c0d647e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation for bm_buttons library.