Add documentation for the cstruct-stubgen tool #87
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
Collaborator
Author
|
I didn't add it yet, but I was wondering whether I should add a gif with the code autocompletion to the example. |
Member
|
A screenshot with VS Code IntelliSense autocomplete filled should suffice. |
Schamper
requested changes
Jul 17, 2025
Schamper
requested changes
Jul 31, 2025
Collaborator
Author
|
Should we add an additional note that it only generates the cstruct typings and ignores any other function in the file? |
Schamper
requested changes
Jul 31, 2025
Member
Yes. |
Schamper
requested changes
Jul 31, 2025
Schamper
approved these changes
Aug 1, 2025
Co-authored-by: Erik Schamper <1254028+Schamper@users.noreply.github.com>
Co-authored-by: Erik Schamper <1254028+Schamper@users.noreply.github.com>
Miauwkeru
force-pushed
the
cstruct-stubgen-documentation
branch
from
7def690 to
049d8d4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #83