Repository navigation
Generate doc includes for macros and static fields - #845
Merged
tannergooding merged 1 commit intoNov 4, 2026
Merged
Conversation
tannergooding
approved these changes
Nov 4, 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
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.
Fixes #832.
Fixes #834.
With
--generate doc-includes, macro constants and static variables currently lack XML documentation includes.BeginValueonly emits them for enumerators, and variable declarations do not supply their containing type.Supply the generated class or remapped record name for variable declarations, and emit includes for values with a parent name. Add baseline tests for a macro assigned to a custom class, a static struct constant, and a remapped static member. The baselines cover both output modes and all configuration/platform variants.
Validation on Windows:
dotnet test -c Release --no-build: 4,361 passed, 0 failed, with 4,112 platform variants skipped.RUN_ALL_VARIANTS=1, the full suite reports 8,457 passed and 16 failures in the Unix variants ofWideStringLiteralConstTest/WideStringLiteralStaticConstTest. All 16 failures reproduce with identical messages on unchanged main (0c1c4098a7aab7cb392a2367b75d447bbac05d58); the added documentation tests all pass.The self-hosted bindings were not regenerated because the LLVM headers are unavailable here. Neither generation response file enables
doc-includes, so no binding changes are expected.