Documentation improvements #3278
Draft
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
terjr
suggested changes
Oct 6, 2025
|
|
||
| **Optional Functions**: | ||
| - ``close()``: Clean up class resources | ||
| - ``sof_cb()``: Start-of-frame processing |
There was a problem hiding this comment.
Suggested change
| - ``sof_cb()``: Start-of-frame processing | |
| - ``sof()``: Start-of-frame processing |
| - ``control_xfer_cb()``: Handle control requests | ||
| - ``xfer_cb()``: Handle data transfer completion | ||
|
|
||
| **Optional Functions**: |
There was a problem hiding this comment.
xfer_isr that was added in 0.19.0 is missing
hathach
reviewed
Oct 9, 2025
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.
Describe the PR
This streamlines documentation quite a bit:
Additional context
Note that an LLM has been used for creating this; there has been quite a lot of manual review work of course (I'm a rather new user of TinyUSB though so please check).
I leave this as a Draft for now; I'm down for investing more work into this but want to make sure first that there's general interest @hathach