Skip to content

Fix XML documentation warnings in generated EmbedFiggleFontAttribute#53

Merged
drewnoakes merged 2 commits intomasterfrom
copilot/fix-figgle-font-warnings
Mar 9, 2026
Merged

Fix XML documentation warnings in generated EmbedFiggleFontAttribute#53
drewnoakes merged 2 commits intomasterfrom
copilot/fix-figgle-font-warnings

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 8, 2026

When <GenerateDocumentationFile>true</GenerateDocumentationFile> is enabled, projects using Figgle.Generator get two compiler warnings from the always-generated EmbedFiggleFontAttribute.cs:

  • CS1734: <paramref name="FiggleFont" /> in the constructor doc — FiggleFont is not a parameter name (memberName and fontName are)
  • CS1574: <see cref="FiggleFont" /> in the MemberName summary — FiggleFont type can't be resolved when Figgle.dll is not a direct project reference (the typical setup when using the generator for compile-time-only rendering)

Both occur in EmbedFiggleFontAttribute.cs even when only GenerateFiggleText is used, since both attribute sources are always emitted.

Changes

  • In EmbedFontSourceGenerator.cs AttributeSource: replace <see cref="FiggleFont" /> and <paramref name="FiggleFont" /> with <c>FiggleFont</c> — avoids type resolution entirely while preserving the doc intent

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • http://api.nuget.org:443/sha2-assured-cs-g1.crl
    • Triggering command: /usr/bin/dotnet dotnet restore (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Warnings using GenerateFiggleText from FiggleFont.Generator</issue_title>
<issue_description>Using this code in my application

[GenerateFiggleText(memberName: "Title", fontName: "standard", sourceText: "My text")]
internal static partial class MyBanner { }

there are 2 warnings on building coming from autogenerated code

<My .cproj folder>\obj\Debug\net10.0\Figgle.Generator\Figgle.Generator.EmbedFontSourceGenerator\EmbedFiggleFontAttribute.cs(47,95,47,105): warning CS1574: XML comment has cref attribute 'FiggleFont' that could not be resolved
<My .csproj folder>\obj\Debug\net10.0\Figgle.Generator\Figgle.Generator.EmbedFontSourceGenerator\EmbedFiggleFontAttribute.cs(59,121,59,131): warning CS1734: XML comment on 'EmbedFiggleFontAttribute.EmbedFiggleFontAttribute(string, string)' has a paramref tag for 'FiggleFont', but there is no parameter by that name
</issue_description>

Comments on the Issue (you are @copilot in this section)

@drewnoakes Thanks for reporting this. Will get a fix out.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: drewnoakes <350947+drewnoakes@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix warnings when using GenerateFiggleText from FiggleFont.Generator Fix XML documentation warnings in generated EmbedFiggleFontAttribute Mar 8, 2026
@drewnoakes drewnoakes marked this pull request as ready for review March 8, 2026 23:59
@drewnoakes drewnoakes merged commit 6b324a6 into master Mar 9, 2026
2 checks passed
@drewnoakes drewnoakes deleted the copilot/fix-figgle-font-warnings branch March 9, 2026 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Warnings using GenerateFiggleText from FiggleFont.Generator

2 participants