[3.0] Add generator docs#2578
Draft
Exanite wants to merge 65 commits into
Draft
Conversation
Contributor
|
Minimum allowed coverage is Generated by 🐒 cobertura-action against 8484427 |
This is because project path is null during unit tests and I can't figure out if it is possible to set the project path of an AdhocWorkspace project.
…lineArray test case
…ng SuccessfullyExtractsCStyleEnumConstants_ReturnType test case
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
(WIP)
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.