Skip to content

Fix CS1734 warning in TransitionShimGenerator attribute XML doc - #415

Merged
dennisdoomen merged 2 commits into
Fallout-build:mainfrom
SonnyRR:fix/cs1734-xml-doc-paramref-warning
Jun 22, 2026
Merged

Fix CS1734 warning in TransitionShimGenerator attribute XML doc#415
dennisdoomen merged 2 commits into
Fallout-build:mainfrom
SonnyRR:fix/cs1734-xml-doc-paramref-warning

Conversation

@SonnyRR

@SonnyRR SonnyRR commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Fixes #414.

Problem

The generated ShimAllPublicTypesUnderAttribute class 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 in TransitionShimGenerator.cs).

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.
@SonnyRR
SonnyRR requested a review from a team as a code owner June 20, 2026 12:04
dennisdoomen
dennisdoomen previously approved these changes Jun 20, 2026
@dennisdoomen dennisdoomen added the bug Something isn't working label Jun 20, 2026
Replace <paramref> with <c> in the ShimAllPublicTypesUnderAttribute
generated XML doc to match the source generator change in eab93a9.
@dennisdoomen
dennisdoomen merged commit 670c2d0 into Fallout-build:main Jun 22, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CS1734 warning from TransitionShimGenerator generated attribute

3 participants