Fix CS1734 warning in TransitionShimGenerator attribute XML doc - #415
Merged
dennisdoomen merged 2 commits intoJun 22, 2026
Merged
Conversation
The generated ShimAllPublicTypesUnderAttribute class has a <summary> XML doc comment that uses <paramref> tags to reference constructor parameters. At the class level, <paramref> can only reference type parameters (generic params), not constructor params — CS1734. Replace <paramref> with <c> inline code tags to resolve the warning without losing the semantic hint.
dennisdoomen
previously approved these changes
Jun 20, 2026
Replace <paramref> with <c> in the ShimAllPublicTypesUnderAttribute generated XML doc to match the source generator change in eab93a9.
dennisdoomen
approved these changes
Jun 21, 2026
ChrisonSimtian
approved these changes
Jun 21, 2026
This was referenced Aug 7, 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 #414.
Problem
The generated
ShimAllPublicTypesUnderAttributeclass uses<paramref>tags in its class-level XML doc comment to reference constructor parameters. At the type level,<paramref>can only reference type parameters (generic params), not constructor params — causing CS1734.Fix
Replace
<paramref name="toNamespacePrefix"/>and<paramref name="fromNamespacePrefix"/>with<c>toNamespacePrefix</c>and<c>fromNamespacePrefix</c>respectively in the attribute's XML doc comment (raw string inTransitionShimGenerator.cs).