Add namespace-level XML documentation for all Terminal.Gui.Editor namespaces#234
Merged
Conversation
…espaces Add NamespaceDoc.cs files to each namespace folder so that DocFX generates namespace summaries in the API reference. Documentation content is drawn from README.md descriptions. Namespaces documented: - Terminal.Gui.Editor (root, with hero.gif image) - Terminal.Gui.Editor.Completion - Terminal.Gui.Editor.Document - Terminal.Gui.Editor.Document.Folding - Terminal.Gui.Editor.Document.Search - Terminal.Gui.Editor.Document.Utils - Terminal.Gui.Editor.Highlighting - Terminal.Gui.Editor.Highlighting.Xshd - Terminal.Gui.Editor.Indentation - Terminal.Gui.Editor.Rendering Closes #230 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Adds
NamespaceDoc.csfiles to each namespace folder so that DocFX generates namespace summaries in the API reference. Documentation content is drawn from README.md descriptions.Namespaces Documented
Terminal.Gui.EditorTerminal.Gui.Editor.CompletionTerminal.Gui.Editor.DocumentTerminal.Gui.Editor.Document.FoldingTerminal.Gui.Editor.Document.SearchTerminal.Gui.Editor.Document.UtilsTerminal.Gui.Editor.HighlightingTerminal.Gui.Editor.Highlighting.XshdTerminal.Gui.Editor.IndentationTerminal.Gui.Editor.RenderingImplementation
Each file contains an
[CompilerGenerated] internal static class NamespaceDocwith XML<summary>documentation. This is the standard pattern for namespace docs in DocFX/Sandcastle-generated API references.Closes #230