Documentation: Add getevent input event monitor documentation.#18615
Merged
acassis merged 1 commit intoapache:masterfrom Mar 27, 2026
Merged
Documentation: Add getevent input event monitor documentation.#18615acassis merged 1 commit intoapache:masterfrom
acassis merged 1 commit intoapache:masterfrom
Conversation
Add rst documentation for the getevent tool under Documentation/applications/graphics/input/. Content is placed directly in index.rst following the existing convention used by other graphics application docs. Signed-off-by: liuhongchao <liuhongchao@xiaomi.com>
github-actions
bot
added
Area: Documentation
Contributor
Author
|
This PR adds documentation for the getevent input event monitor tool in rst format. Related to apache/nuttx-apps#3434, where the getevent tool implementation is under review. The documentation was requested by reviewers @acassis and @cederom. |
xiaoxiang781216
approved these changes
Mar 27, 2026
simbit18
approved these changes
Mar 27, 2026
acassis
approved these changes
Mar 27, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Summary
Add rst documentation for the
geteventinput event monitor tool underDocumentation/applications/graphics/input/.This is the companion documentation PR for apache/nuttx-apps#3434.
index.rst: entry point for the graphics/input category, using toctree toallow future additions (monkey, input tool, etc.)
getevent.rst: covers overview, supported event types, configuration,usage, how it works, and example output
Impact
Documentation only. No code changes, no impact on build or hardware.
Testing
Verified with
make htmlunderDocumentation/— no warnings or errors.Confirmed the page renders correctly in the browser and integrates into the
existing graphics toctree.