feat: include XML documentation in NuGet package (#215) - #221
Open
imnasnainaec wants to merge 11 commits into
Open
feat: include XML documentation in NuGet package (#215)#221imnasnainaec wants to merge 11 commits into
imnasnainaec wants to merge 11 commits into
Conversation
Contributor
Author
|
@tombogle Enabling XML docs this way causes ~1700 warnings on the build (e.g., https://github.com/sillsdev/icu-dotnet/actions/runs/26838163661/job/79137608874?pr=221#step:7:11). Should CS1591 be suppressed? |
imnasnainaec
force-pushed
the
worktree-agent-a122d43412b38c232
branch
2 times, most recently
from
June 10, 2026 17:05
19c3291 to
f260616
Compare
imnasnainaec
force-pushed
the
worktree-agent-a122d43412b38c232
branch
from
June 10, 2026 22:54
c049e2a to
1d3996d
Compare
Contributor
Author
|
URL updates moved to #229 to keep this pr focused on XML docs. |
imnasnainaec
force-pushed
the
worktree-agent-a122d43412b38c232
branch
from
June 11, 2026 13:30
1d3996d to
ca5fa25
Compare
- Enable GenerateDocumentationFile in Directory.Build.props so all projects emit XML docs. - Add .xml to AllowedOutputExtensionsInPackageBuildOutputFolder in icu.net.csproj so the XML file is bundled into the NuGet package for every target framework. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Moves GenerateDocumentationFile out of Directory.Build.props (which applies to all projects) and into icu.net.csproj, avoiding spurious CS1591 warnings in the test projects. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
imnasnainaec
force-pushed
the
worktree-agent-a122d43412b38c232
branch
2 times, most recently
from
June 11, 2026 17:21
53b867a to
197adc0
Compare
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
CS1573 only fires when GenerateDocumentationFile is enabled, which is scoped to icu.net. Suppressing it in Directory.Build.props was applying it to all projects unnecessarily. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Covers BreakEnumerator finalizer, CodepageConversion class, Wrapper.MinSupportedIcuVersion/MaxSupportedIcuVersion, MessageFormatter class/Dispose/Pattern, and ResourceBundle.Dispose. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…docs Adds class, UTransDirection enum, and Dispose docs to Transliterator. Replaces hand-written Dispose() summaries with <inheritdoc/> in BiDi, BreakIterator, Collator, and RegexMatcher. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
imnasnainaec
force-pushed
the
worktree-agent-a122d43412b38c232
branch
from
June 11, 2026 18:09
23e0631 to
9250187
Compare
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
imnasnainaec
force-pushed
the
worktree-agent-a122d43412b38c232
branch
from
June 11, 2026 18:11
9250187 to
79f5d1e
Compare
imnasnainaec
marked this pull request as ready for review
June 11, 2026 18:12
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
2 participants
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
GenerateDocumentationFileinDirectory.Build.propsso all projects emit XML docs..xmltoAllowedOutputExtensionsInPackageBuildOutputFolderinicu.net.csprojso the XML file is bundled into the NuGet package for every target framework.Test plan
.xmlfile is present alongside the.dllin eachlib/folderCloses #215
🤖 Generated with Claude Code
Devin review: https://app.devin.ai/review/sillsdev/icu-dotnet/pull/221