Include XML documentation file in NuGet package#223
Merged
Conversation
Enable GenerateDocumentationFile in the Editor csproj so the XML doc file ships alongside the DLL in lib/net10.0/. This allows DocFX and other documentation tools to extract API summaries from the package. Suppress CS1574/CS1591/CS1723 doc-comment warnings that surface from lifted AvaloniaEdit code and cross-assembly cref references. Add API documentation link to README.md. Closes #222 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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
Enable
GenerateDocumentationFilein the Editor csproj so the XML doc file (Terminal.Gui.Editor.xml) ships alongside the DLL inlib/net10.0/. This allows DocFX and other documentation tools to extract API summaries from the package.Changes
src/Terminal.Gui.Editor/Terminal.Gui.Editor.csproj: Added<GenerateDocumentationFile>true</GenerateDocumentationFile>and suppressed CS1574/CS1591/CS1723 doc-comment warnings (from lifted AvaloniaEdit code and cross-assembly cref references).README.md: Added API documentation link to the Terminal.Gui DocFX site (currently 404, will resolve with Fixes #5367. Include Terminal.Gui.Editor in DocFX API reference Terminal.Gui#5368).Verification
Terminal.Gui.Editor.xmlis present in the packed.nupkgatlib/net10.0/Closes #222