Skip to content

Commit fe85872

Browse files
tigCopilot
andcommitted
Include XML documentation file in NuGet package
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>
1 parent cdd58a9 commit fe85872

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
A reusable text-editing `View` for [Terminal.Gui](https://github.com/gui-cs/Terminal.Gui). Drop it into your TUI app and you get the editing experience users already expect (caret movement, selection, clipboard, undo/redo, search & replace, folding, syntax highlighting, word wrap) without writing any of it yourself.
66

7-
Ships as a single NuGet package: **[`Terminal.Gui.Editor`](https://www.nuget.org/packages/Terminal.Gui.Editor)**.
7+
Ships as a single NuGet package: **[`Terminal.Gui.Editor`](https://www.nuget.org/packages/Terminal.Gui.Editor)**. API documentation is published on the [Terminal.Gui DocFX site](https://gui-cs.github.io/Terminal.Gui/api/Terminal.Gui.Editor.html).
88

99
## What this is, and what it isn't
1010

src/Terminal.Gui.Editor/Terminal.Gui.Editor.csproj

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
<PropertyGroup>
44
<RootNamespace>Terminal.Gui.Editor</RootNamespace>
55
<AssemblyName>Terminal.Gui.Editor</AssemblyName>
6+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
7+
<!-- CS1574: XML comment has cref that could not be resolved (cross-assembly refs to Terminal.Gui internals).
8+
CS1591: Missing XML comment for publicly visible type/member (lifted AvaloniaEdit code lacks full docs).
9+
CS1723: XML comment has cref that refers to a type parameter (upstream doc style). -->
10+
<NoWarn>$(NoWarn);CS1574;CS1591;CS1723</NoWarn>
611

712
<PackageId>Terminal.Gui.Editor</PackageId>
813
<Description>Full-featured text editor View for Terminal.Gui — rope-backed document model, multi-caret, folding, search, undo/redo, optional TextMate highlighting. Adapted from AvaloniaEdit.</Description>

0 commit comments

Comments
 (0)