[tools] Enable xml doc generation for dotnet-linker.#24950
Conversation
This way we get validation of any xml docs in dotnet-linker. Also make all warnings errors, since we're now warning-free.
There was a problem hiding this comment.
Pull request overview
Enables XML documentation generation for the tools/dotnet-linker project so XML doc comments are validated during build, and tightens build hygiene by treating all warnings as errors.
Changes:
- Turn on
GenerateDocumentationFileandTreatWarningsAsErrorsfortools/dotnet-linker. - Suppress
CS1591(missing XML docs) for dotnet-linker since its APIs aren’t intended for public consumption. - Fix XML doc markup that would produce documentation warnings/errors when docs are generated (external link handling and a
BUNDLER-specific doc block).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tools/dotnet-linker/dotnet-linker.csproj | Enables XML doc generation and treats all warnings as errors; suppresses CS1591. |
| tools/common/StringUtils.cs | Updates XML doc link syntax to use href for an external URL. |
| src/Foundation/ExportAttribute.cs | Avoids emitting a <see cref="..."> to a type not present in the BUNDLER build by conditionally excluding that doc block. |
✅ [CI Build #4ae39b7] Build passed (Build packages) ✅Pipeline on Agent |
✅ [PR Build #4ae39b7] Build passed (Detect API changes) ✅Pipeline on Agent |
✅ API diff for current PR / commitNET (empty diffs)✅ API diff vs stableNET (empty diffs)ℹ️ Generator diffGenerator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes) Pipeline on Agent |
✅ [CI Build #4ae39b7] Build passed (Build macOS tests) ✅Pipeline on Agent |
🚀 [CI Build #4ae39b7] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 156 tests passed 🎉 Tests counts✅ cecil: All 1 tests passed. Html Report (VSDrops) Download macOS tests✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download Pipeline on Agent |
This way we get validation of any xml docs in dotnet-linker.
Also make all warnings errors, since we're now warning-free.