[3.0] Add generator docs#2578
Draft
Exanite wants to merge 95 commits into
Draft
Conversation
…rary" I saw that static-vs-instance-bindings.md used the terms "API" and "native API" to describe the APIs being bound to using SilkTouch. I'm deciding to keep this pattern moving forward for consistency.
12 tasks
(cherry picked from commit 3192da8be03dffedae9319636018ee901f959716)
Exanite
commented
Jun 10, 2026
Exanite
left a comment
Exanite
left a comment
Member
Author
There was a problem hiding this comment.
Self review completed. I didn't deeply review the docs I wrote, but I skimmed through each of them a couple of times. My goal is to get the information out there first, then refine the docs in the future. There's also a few sections I left as TODOs because I don't have enough knowledge to fill them out.
| /// <list type="bullet"> | ||
| /// <item><description> | ||
| /// Replacing function pointers identified by their <see cref="NativeTypeNameAttribute"/>s with delegates and | ||
| /// <c>Pfn</c>-prefixed structures. |
Member
Author
There was a problem hiding this comment.
I changed this since these aren't actually Pfn-prefixed and simply use the native name of the function pointer type.
Member
Author
|
I'll mark this PR as ready for review once #2587 has been merged. |
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
1 participant
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 of the PR
This replaces my previous WIP PR for adding generator usage documentation (#2545) in favor of providing a more complete set of docs relating to both using the generator and how the generator internals work.
Related issues, Discord discussions, or proposals
Related discord thread: https://discord.com/channels/521092042781229087/1500974857079492749
Further Comments
There are sections that I left empty (marked with TODOs) since I don't have enough knowledge to fill out those sections.
Tasks
ExtractNestedTypingconstant extraction does not handle nor rewrite fields that are typed as a predefined type, but are natively typed as an enum (test case:SuccessfullyExtractsCStyleEnumConstants_Field)ExtractNestedTypingconstant extraction does not handle nor rewrite return types that are typed as a predefined type, but are natively typed as an enum (test case:SuccessfullyExtractsCStyleEnumConstants_ReturnType)ExtractNestedTypingdoes not annotate extracted enums with the[NativeName]attribute. Eg:SDL_BlendMode.IEquatable<T>interface.From my tracking issue: