Merge pull request #234 from gui-cs/tig/add-namespace-documentation

Add namespace-level XML documentation for all Terminal.Gui.Editor namespaces

Author: tig

src/Terminal.Gui.Editor/Completion/NamespaceDoc.cs

@@ -0,0 +1,14 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Completion;
+
+/// <summary>
+///     Provides the completion (auto-complete / IntelliSense-style) infrastructure for the editor.
+///     Contains the <see cref="IEditorCompletionProvider" /> interface that consumers implement to supply
+///     completion candidates, and the <see cref="CompletionItem" /> type that describes individual suggestions.
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Document/NamespaceDoc.cs

@@ -0,0 +1,22 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Document;
+
+/// <summary>
+///     <para>
+///         UI-framework-independent document model. This namespace contains the rope-backed
+///         <see cref="TextDocument" />, <see cref="DocumentLine" />, <see cref="TextAnchor" />,
+///         <see cref="UndoStack" />, <see cref="ITextSource" />, <see cref="TextSegment" />, and supporting types
+///         that form the core data layer of the editor.
+///     </para>
+///     <para>
+///         The document layer has no dependency on Terminal.Gui and can be used independently for text manipulation,
+///         analysis, or testing. It is adapted from
+///         <a href="https://github.com/AvaloniaUI/AvaloniaEdit">AvaloniaEdit</a>'s pure-data layers.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Folding/NamespaceDoc.cs

@@ -0,0 +1,24 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Document.Folding;
+
+/// <summary>
+///     <para>
+///         Code-folding infrastructure for collapsing and expanding regions of a document.
+///     </para>
+///     <para>
+///         Contains <see cref="FoldingManager" /> (manages fold state for a document),
+///         <see cref="FoldingSection" /> (represents a single collapsible region),
+///         <see cref="IFoldingStrategy" /> (pluggable strategy interface), and built-in strategies
+///         (<see cref="BraceFoldingStrategy" />, <see cref="XmlFoldingStrategy" />).
+///     </para>
+///     <para>
+///         Foldings auto-expand when the caret moves inside them. Consumers can implement custom
+///         <see cref="IFoldingStrategy" /> instances for language-specific folding rules.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Highlighting/NamespaceDoc.cs

@@ -0,0 +1,24 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Highlighting;
+
+/// <summary>
+///     <para>
+///         Syntax highlighting engine driven by xshd (XML Syntax Highlighting Definition) files.
+///     </para>
+///     <para>
+///         The core types are <see cref="IHighlightingDefinition" /> (describes a language's highlighting rules),
+///         <see cref="DocumentHighlighter" /> (applies rules to a <see cref="Document.TextDocument" /> producing
+///         <see cref="HighlightedLine" />s), and <see cref="HighlightingManager" /> (registry of built-in and
+///         user-loaded definitions, with lookup by name or file extension).
+///     </para>
+///     <para>
+///         Built-in definitions include C#, C++, Java, JavaScript, Python, PowerShell, TSQL, VB, JSON, HTML, XML,
+///         CSS, and Markdown. Highlight colors compose with the active Terminal.Gui color scheme.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Highlighting/Xshd/NamespaceDoc.cs

@@ -0,0 +1,24 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Highlighting.Xshd;
+
+/// <summary>
+///     <para>
+///         xshd (XML Syntax Highlighting Definition) file format support: loaders, savers, and AST types.
+///     </para>
+///     <para>
+///         Contains <see cref="HighlightingLoader" /> (reads xshd XML into an <see cref="XshdSyntaxDefinition" />
+///         and compiles it into an <see cref="Terminal.Gui.Editor.Highlighting.IHighlightingDefinition" />),
+///         <see cref="SaveXshdVisitor" /> (serializes definitions back to XML), and the AST node types
+///         (<see cref="XshdRuleSet" />, <see cref="XshdSpan" />, <see cref="XshdRule" />,
+///         <see cref="XshdKeywords" />, <see cref="XshdColor" />, etc.) that represent the parsed structure.
+///     </para>
+///     <para>
+///         Supports both xshd v1 and v2 formats via <see cref="V1Loader" /> and <see cref="V2Loader" />.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Indentation/NamespaceDoc.cs

@@ -0,0 +1,20 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Indentation;
+
+/// <summary>
+///     <para>
+///         Pluggable indentation strategies that control how the editor auto-indents new lines.
+///     </para>
+///     <para>
+///         Contains the <see cref="IIndentationStrategy" /> interface and the built-in
+///         <see cref="DefaultIndentationStrategy" /> (copies the previous line's leading whitespace on Enter).
+///         Consumers can implement custom strategies for language-aware indentation (e.g., increasing indent
+///         after an opening brace).
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/NamespaceDoc.cs

@@ -0,0 +1,29 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor;
+
+/// <summary>
+///     <para>
+///         <img src="https://raw.githubusercontent.com/gui-cs/Editor/develop/Docs/images/hero.gif"
+///             alt="Terminal.Gui.Editor (ted demo app)" />
+///     </para>
+///     <para>
+///         A reusable text-editing <see cref="Terminal.Gui.ViewBase.View" /> for Terminal.Gui. Drop it into your TUI app
+///         and you get the editing experience users already expect: caret movement, selection, clipboard, undo/redo,
+///         search &amp; replace, folding, syntax highlighting, word wrap, multi-caret editing, and more.
+///     </para>
+///     <para>
+///         The <see cref="Editor" /> class is a <c>View</c> subclass that consumes the
+///         <see cref="Document.TextDocument" /> through a cell-grid rendering pipeline
+///         (<see cref="Rendering.VisualLineBuilder" /> → <see cref="Rendering.CellVisualLine" />, with pluggable
+///         <see cref="Rendering.IVisualLineTransformer" />s and <see cref="Rendering.IBackgroundRenderer" />s).
+///     </para>
+///     <para>
+///         Ships as a single NuGet package: <b>Terminal.Gui.Editor</b>.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Rendering/NamespaceDoc.cs

@@ -0,0 +1,34 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Rendering;
+
+/// <summary>
+///     <para>
+///         Cell-grid rendering pipeline that transforms document lines into visual output.
+///     </para>
+///     <para>
+///         The pipeline flows: <see cref="VisualLineBuilder" /> → <see cref="CellVisualLine" /> (composed of
+///         <see cref="CellVisualLineElement" />s such as <see cref="TextRunElement" />, <see cref="TabElement" />,
+///         <see cref="NewlineGlyphElement" />, and <see cref="FoldingMarkerElement" />).
+///     </para>
+///     <para>
+///         Pluggable extension points:
+///         <list type="bullet">
+///             <item>
+///                 <see cref="IVisualLineTransformer" /> — mutates element attributes (syntax highlighting, fold
+///                 markers).
+///             </item>
+///             <item><see cref="IBackgroundRenderer" /> — paints cell rectangles (selection, current line, search hits).</item>
+///             <item><see cref="IOverlayRenderer" /> — draws overlays above the text (multi-caret indicators).</item>
+///         </list>
+///     </para>
+///     <para>
+///         Visual lines are cached with LRU eviction and selectively invalidated from
+///         <see cref="Document.TextDocument.Changed" /> offset/length ranges.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Search/NamespaceDoc.cs

@@ -0,0 +1,24 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Document.Search;
+
+/// <summary>
+///     <para>
+///         Pluggable search strategies for find and replace operations.
+///     </para>
+///     <para>
+///         Contains <see cref="ISearchStrategy" /> (the strategy interface), built-in implementations
+///         (<see cref="RegexSearchStrategy" /> and normal/whole-word string search), and
+///         <see cref="SearchStrategyFactory" /> for constructing strategies by mode and options.
+///     </para>
+///     <para>
+///         Search strategies operate on <see cref="Terminal.Gui.Editor.Document.ITextSource" /> and return
+///         match results as offset/length pairs. The editor's find/replace UI and
+///         <see cref="Terminal.Gui.Editor.Rendering.SearchHitRenderer" /> consume these results.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;

src/Terminal.Gui.Editor/Utils/NamespaceDoc.cs

@@ -0,0 +1,25 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+
+namespace Terminal.Gui.Editor.Document.Utils;
+
+/// <summary>
+///     <para>
+///         Shared utility types used by the document layer and other subsystems.
+///     </para>
+///     <para>
+///         Includes the <see cref="Rope{T}" /> data structure (a balanced B-tree for efficient insert/delete in large
+///         sequences), <see cref="Deque{T}" /> (double-ended queue), <see cref="CompressingTreeList{T}" /> (run-length
+///         compressed list), <see cref="FileReader" /> (encoding-detecting file reader),
+///         <see cref="IFreezable" /> (immutability pattern), and various string/text helpers.
+///     </para>
+///     <para>
+///         These types are adapted from
+///         <a href="https://github.com/AvaloniaUI/AvaloniaEdit">AvaloniaEdit</a>'s utility layer and have no
+///         dependency on Terminal.Gui.
+///     </para>
+/// </summary>
+[CompilerGenerated]
+internal static class NamespaceDoc;