Tons of V2 API doc fixes (#3932)

* Tons of API doc updates

* tweaked scenario

* try to fix unit test crash in ubuntu action

* try to fix unit test crash in ubuntu action2

Author: tig

Terminal.Gui/Application/Application.Mouse.cs

@@ -254,20 +254,20 @@ internal static void RaiseMouseEvent (MouseEventArgs mouseEvent)
 
 #pragma warning disable CS1574 // XML comment has cref attribute that could not be resolved
     /// <summary>
-    /// Raised when a mouse event occurs. Can be cancelled by setting <see cref="MouseEventArgs.Handled"/> to <see langword="true"/>.
+    /// Raised when a mouse event occurs. Can be cancelled by setting <see cref="HandledEventArgs.Handled"/> to <see langword="true"/>.
     /// </summary>
     /// <remarks>
     ///     <para>
     ///         <see cref="MouseEventArgs.ScreenPosition"/> coordinates are screen-relative.
     ///     </para>
     ///     <para>
-    ///         <see cref="MouseEventArgs.View"/> will be the deepest view under the under the mouse.
+    ///         <see cref="MouseEventArgs.View"/> will be the deepest view under the mouse.
     ///     </para>
     ///     <para>
     ///         <see cref="MouseEventArgs.Position"/> coordinates are view-relative. Only valid if <see cref="MouseEventArgs.View"/> is set.
     ///     </para>
     ///     <para>
-    ///         Use this evento to handle mouse events at the application level, before View-specific handling.
+    ///         Use this even to handle mouse events at the application level, before View-specific handling.
     ///     </para>
     /// </remarks>
     public static event EventHandler<MouseEventArgs>? MouseEvent;

Terminal.Gui/Drawing/Glyphs.cs

@@ -1,13 +1,14 @@
-namespace Terminal.Gui;
+#nullable enable
+namespace Terminal.Gui;
 
 /// <summary>Defines the standard set of glyphs used to draw checkboxes, lines, borders, etc...</summary>
 /// <remarks>
 ///     <para>
-///         Access with <see cref="CM.Glyphs"/> (which is a global using alias for
-///         <see cref="ConfigurationManager.Glyphs"/>).
+///         Access with <see cref="Glyphs"/> (which is a global using alias for
+///         <see cref="Glyphs"/>).
 ///     </para>
 ///     <para>
-///         The default glyphs can be changed via the <see cref="ConfigurationManager"/>. Within a <c>config.json</c>
+///         The default glyphs can be changed per-<see cref="ThemeScope"/> in <see cref="ConfigurationManager"/>. Within a <c>config.json</c>
 ///         file the Json property name is the property name prefixed with "Glyphs.".
 ///     </para>
 ///     <para>

Terminal.Gui/Drawing/Region.cs

@@ -1,5 +1,7 @@
 #nullable enable
 
+namespace Terminal.Gui;
+
 using System.Buffers;
 
 /// <summary>
@@ -96,7 +98,7 @@ public void Intersect (Region region)
         {
             foreach (Rectangle rect2 in region._rectangles)
             {
-                Rectangle intersected = Rectangle.Intersect (rect1, rect2);
+                Rectangle intersected = Rectangle.Intersect (rect1, rect2); 
 
                 if (!intersected.IsEmpty)
                 {

Terminal.Gui/Input/CommandContext.cs

@@ -5,7 +5,7 @@ namespace Terminal.Gui;
 /// <summary>
 ///     Provides context for a <see cref="Command"/> invocation.
 /// </summary>
-/// <seealso cref="View.Invoke(Command)"/>.
+/// <seealso cref="View.InvokeCommand"/>.
 #pragma warning restore CS1574 // XML comment has cref attribute that could not be resolved
 public record struct CommandContext<TBinding> : ICommandContext
 {

Terminal.Gui/View/Adornment/Adornment.cs

@@ -1,6 +1,6 @@
 #nullable enable
-using Terminal.Gui;
-using Attribute = Terminal.Gui.Attribute;
+namespace Terminal.Gui;
+
 
 /// <summary>
 ///     Adornments are a special form of <see cref="View"/> that appear outside the <see cref="View.Viewport"/>:

Terminal.Gui/View/Adornment/Border.cs

@@ -12,36 +12,24 @@ namespace Terminal.Gui;
 ///     <para>
 ///         The <see cref="View.Title"/> of <see cref="Adornment.Parent"/> will be drawn based on the value of
 ///         <see cref="Thickness.Top"/>:
+///         <example>
+///             // If Thickness.Top is 1:
+///             ┌┤1234├──┐
+///             │        │
+///             └────────┘
+///             // If Thickness.Top is 2:
+///              ┌────┐
+///             ┌┤1234├──┐
+///             │        │
+///             └────────┘
+///             If Thickness.Top is 3:
+///              ┌────┐
+///             ┌┤1234├──┐
+///             │└────┘  │
+///             │        │
+///             └────────┘
+///         </example>
 ///     </para>
-///     <para>
-///         If <c>1</c>:
-///         <code>
-/// ┌┤1234├──┐
-/// │        │
-/// └────────┘
-/// </code>
-///     </para>
-///     <para>
-///         If <c>2</c>:
-///         <code>
-///  ┌────┐
-/// ┌┤1234├──┐
-/// │        │
-/// └────────┘
-/// </code>
-///     </para>
-///     <para>
-///         If <c>3</c>:
-///         <code>
-///  ┌────┐
-/// ┌┤1234├──┐
-/// │└────┘  │
-/// │        │
-/// └────────┘
-/// </code>
-///     </para>
-///     <para/>
-///     <para>See the <see cref="Adornment"/> class.</para>
 /// </remarks>
 public class Border : Adornment
 {
@@ -77,13 +65,14 @@ private void OnThicknessChanged (object? sender, EventArgs e)
             ShowHideDrawIndicator ();
         }
     }
+
     private void ShowHideDrawIndicator ()
     {
         if (View.Diagnostics.HasFlag (ViewDiagnosticFlags.DrawIndicator) && Thickness != Thickness.Empty)
         {
             if (DrawIndicator is null)
             {
-                DrawIndicator = new SpinnerView ()
+                DrawIndicator = new()
                 {
                     Id = "DrawIndicator",
                     X = 1,
@@ -282,7 +271,6 @@ private void Border_Highlight (object? sender, CancelEventArgs<HighlightStyle> e
             ColorScheme = cs;
         }
 
-
         if (e.NewValue == HighlightStyle.None && _savedForeColor.HasValue)
         {
             var cs = new ColorScheme (ColorScheme)
@@ -304,9 +292,10 @@ protected override bool OnMouseEvent (MouseEventArgs mouseEvent)
     {
         // BUGBUG: See https://github.com/gui-cs/Terminal.Gui/issues/3312
         if (!_dragPosition.HasValue && mouseEvent.Flags.HasFlag (MouseFlags.Button1Pressed)
-                                // HACK: Prevents Window from being draggable if it's Top
-                                //&& Parent is Toplevel { Modal: true }
-                                )
+
+            // HACK: Prevents Window from being draggable if it's Top
+            //&& Parent is Toplevel { Modal: true }
+           )
         {
             Parent!.SetFocus ();
 
@@ -501,8 +490,9 @@ protected override bool OnMouseEvent (MouseEventArgs mouseEvent)
                                                            parentLoc.Y - _startGrabPoint.Y,
                                                            out int nx,
                                                            out int ny
-                                                          //,
-                                                          // out _
+
+                                                           //,
+                                                           // out _
                                                           );
 
                         Parent.X = parentLoc.X - _startGrabPoint.X;
@@ -712,7 +702,12 @@ protected override bool OnDrawingContent ()
             }
         }
 
-        if (Parent is { } && canDrawBorder && Thickness.Top > 0 && maxTitleWidth > 0 && Settings.FastHasFlags (BorderSettings.Title) && !string.IsNullOrEmpty (Parent?.Title))
+        if (Parent is { }
+            && canDrawBorder
+            && Thickness.Top > 0
+            && maxTitleWidth > 0
+            && Settings.FastHasFlags (BorderSettings.Title)
+            && !string.IsNullOrEmpty (Parent?.Title))
         {
             Attribute focus = Parent.GetNormalColor ();
 
@@ -723,11 +718,12 @@ protected override bool OnDrawingContent ()
             }
 
             Rectangle titleRect = new (borderBounds.X + 2, titleY, maxTitleWidth, 1);
-            Parent.TitleTextFormatter.Draw (titleRect
-                                           ,
+
+            Parent.TitleTextFormatter.Draw (
+                                            titleRect,
                                             Parent.HasFocus ? focus : GetNormalColor (),
                                             Parent.HasFocus ? focus : GetHotNormalColor ());
-            Parent?.LineCanvas.Exclude(new(titleRect));
+            Parent?.LineCanvas.Exclude (new (titleRect));
         }
 
         if (canDrawBorder && LineStyle != LineStyle.None)
@@ -944,13 +940,15 @@ protected override bool OnDrawingContent ()
             }
         }
 
-        return true; ;
+        return true;
+
+        ;
     }
 
     /// <summary>
     ///     Gets the subview used to render <see cref="ViewDiagnosticFlags.DrawIndicator"/>.
     /// </summary>
-    public SpinnerView? DrawIndicator { get; private set; } = null;
+    public SpinnerView? DrawIndicator { get; private set; }
 
     private void SetupGradientLineCanvas (LineCanvas lc, Rectangle rect)
     {
@@ -1392,13 +1390,13 @@ private void AddArrangeModeKeyBindings ()
 
         HotKeyBindings.Add (Key.Esc, Command.Quit);
         HotKeyBindings.Add (Application.ArrangeKey, Command.Quit);
-        HotKeyBindings.Add (Key.CursorUp,  Command.Up);
+        HotKeyBindings.Add (Key.CursorUp, Command.Up);
         HotKeyBindings.Add (Key.CursorDown, Command.Down);
         HotKeyBindings.Add (Key.CursorLeft, Command.Left);
         HotKeyBindings.Add (Key.CursorRight, Command.Right);
 
         HotKeyBindings.Add (Key.Tab, Command.Tab);
-        HotKeyBindings.Add (Key.Tab.WithShift,  Command.BackTab);
+        HotKeyBindings.Add (Key.Tab.WithShift, Command.BackTab);
     }
 
     private void ApplicationOnMouseEvent (object? sender, MouseEventArgs e)

Terminal.Gui/View/View.Drawing.cs

@@ -398,14 +398,12 @@ private void DoDrawText ()
     protected virtual bool OnDrawingText () { return false; }
 
 
-#pragma warning disable CS1574 // XML comment has cref attribute that could not be resolved
     /// <summary>Raised when the <see cref="Text"/> of the View is to be drawn.</summary>
     /// <returns>
-    ///     Set <see cref="DrawEventArgs.Cancel"/> to <see langword="true"/> to stop further drawing of
+    ///     Set <see cref="CancelEventArgs.Cancel"/> to <see langword="true"/> to stop further drawing of
     ///     <see cref="Text"/>.
     /// </returns>
     public event EventHandler<DrawEventArgs>? DrawingText;
-#pragma warning restore CS1574 // XML comment has cref attribute that could not be resolved
 
     /// <summary>
     ///     Draws the <see cref="Text"/> of the View using the <see cref="TextFormatter"/>.
@@ -503,16 +501,14 @@ private void DoDrawSubviews ()
     protected virtual bool OnDrawingSubviews () { return false; }
 
 
-#pragma warning disable CS1574 // XML comment has cref attribute that could not be resolved
     /// <summary>Raised when the <see cref="Subviews"/> are to be drawn.</summary>
     /// <remarks>
     /// </remarks>
     /// <returns>
-    ///     Set <see cref="DrawEventArgs.Cancel"/> to <see langword="true"/> to stop further drawing of
+    ///     Set <see cref="CancelEventArgs.Cancel"/> to <see langword="true"/> to stop further drawing of
     ///     <see cref="Subviews"/>.
     /// </returns>
     public event EventHandler<DrawEventArgs>? DrawingSubviews;
-#pragma warning restore CS1574 // XML comment has cref attribute that could not be resolved
 
     /// <summary>
     ///     Draws the <see cref="Subviews"/>.