Tig преди 10 месеца
родител
ревизия
071167ba27

+ 55 - 53
Terminal.Gui/Drawing/Alignment.cs

@@ -10,72 +10,74 @@ public enum Alignment
 {
     /// <summary>
     ///     The items will be aligned to the start (left or top) of the container.
+    ///     <remarks>
+    ///         <para>
+    ///             If the container is smaller than the total size of the items, the end items will be clipped (their
+    ///             locations
+    ///             will be greater than the container size).
+    ///         </para>
+    ///         <para>
+    ///             The <see cref="AlignmentModes"/> enumeration provides additional options for aligning items in a container.
+    ///         </para>
+    ///     </remarks>
+    ///     <example>
+    ///         <c>
+    ///             |111 2222 33333    |
+    ///         </c>
+    ///     </example>
     /// </summary>
-    /// <remarks>
-    ///     <para>
-    ///         If the container is smaller than the total size of the items, the end items will be clipped (their locations
-    ///         will be greater than the container size).
-    ///     </para>
-    ///     <para>
-    ///         The <see cref="AlignmentModes"/> enumeration provides additional options for aligning items in a container.
-    ///     </para>
-    /// </remarks>
-    /// <example>
-    ///     <c>
-    ///         |111 2222 33333    |
-    ///     </c>
-    /// </example>
     Start = 0,
 
     /// <summary>
     ///     The items will be aligned to the end (right or bottom) of the container.
+    ///     <remarks>
+    ///         <para>
+    ///             If the container is smaller than the total size of the items, the start items will be clipped (their
+    ///             locations
+    ///             will be negative).
+    ///         </para>
+    ///         <para>
+    ///             The <see cref="AlignmentModes"/> enumeration provides additional options for aligning items in a container.
+    ///         </para>
+    ///     </remarks>
+    ///     <example>
+    ///         <c>
+    ///             |    111 2222 33333|
+    ///         </c>
+    ///     </example>
     /// </summary>
-    /// <remarks>
-    ///     <para>
-    ///         If the container is smaller than the total size of the items, the start items will be clipped (their locations
-    ///         will be negative).
-    ///     </para>
-    ///     <para>
-    ///         The <see cref="AlignmentModes"/> enumeration provides additional options for aligning items in a container.
-    ///     </para>
-    /// </remarks>
-    /// <example>
-    ///     <c>
-    ///         |    111 2222 33333|
-    ///     </c>
-    /// </example>
     End,
 
     /// <summary>
     ///     Center in the available space.
+    ///     <remarks>
+    ///         <para>
+    ///             If centering is not possible, the group will be left-aligned.
+    ///         </para>
+    ///         <para>
+    ///             Extra space will be distributed between the items, biased towards the left.
+    ///         </para>
+    ///     </remarks>
+    ///     <example>
+    ///         <c>
+    ///             |  111 2222 33333  |
+    ///         </c>
+    ///     </example>
     /// </summary>
-    /// <remarks>
-    ///     <para>
-    ///     If centering is not possible, the group will be left-aligned.
-    ///     </para>
-    ///     <para>
-    ///         Extra space will be distributed between the items, biased towards the left.
-    ///     </para>
-    /// </remarks>
-    /// <example>
-    ///     <c>
-    ///         |  111 2222 33333  |
-    ///     </c>
-    /// </example>
     Center,
 
     /// <summary>
     ///     The items will fill the available space.
+    ///     <remarks>
+    ///         <para>
+    ///             Extra space will be distributed between the items, biased towards the end.
+    ///         </para>
+    ///     </remarks>
+    ///     <example>
+    ///         <c>
+    ///             |111  2222    33333|
+    ///         </c>
+    ///     </example>
     /// </summary>
-    /// <remarks>
-    ///     <para>
-    ///         Extra space will be distributed between the items, biased towards the end.
-    ///     </para>
-    /// </remarks>
-    /// <example>
-    ///     <c>
-    ///        |111  2222    33333|
-    ///     </c>
-    /// </example>
-    Fill,
-}
+    Fill
+}

+ 13 - 18
Terminal.Gui/Drawing/AlignmentModes.cs

@@ -17,36 +17,31 @@ public enum AlignmentModes
     /// <summary>
     ///     The items will be arranged from end (right/bottom) to start (left/top).
     /// </summary>
-    /// <remarks>
-    ///     Not implemented.
-    /// </remarks>
     EndToStart = 1,
 
     /// <summary>
     ///     At least one space will be added between items. Useful for justifying text where at least one space is needed.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         If the total size of the items is greater than the container size, the space between items will be ignored
     ///         starting from the end.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     AddSpaceBetweenItems = 2,
 
     /// <summary>
-    ///    When aligning via <see cref="Alignment.Start"/> or <see cref="Alignment.End"/>, the item opposite to the alignment (the first or last item) will be ignored.
-    /// </summary>
-    /// <remarks>
+    ///     When aligning via <see cref="Alignment.Start"/> or <see cref="Alignment.End"/>, the item opposite to the alignment
+    ///     (the first or last item) will be ignored.
     ///     <para>
     ///         If the container is smaller than the total size of the items, the end items will be clipped (their locations
     ///         will be greater than the container size).
     ///     </para>
-    /// </remarks>
-    /// <example>
-    ///     <c>
-    ///         Start: |111 2222     33333|
-    ///         End:   |111     2222 33333|
-    ///     </c>
-    /// </example>
-    IgnoreFirstOrLast = 4,
-}
+    ///     ///
+    ///     <example>
+    ///         <c>
+    ///             Start: |111 2222     33333|
+    ///             End:   |111     2222 33333|
+    ///         </c>
+    ///     </example>
+    /// </summary>
+    IgnoreFirstOrLast = 4
+}

+ 10 - 17
Terminal.Gui/Input/KeyBindingScope.cs

@@ -1,6 +1,4 @@
-
-
-namespace Terminal.Gui;
+namespace Terminal.Gui;
 
 /// <summary>
 ///     Defines the scope of a <see cref="Command"/> that has been bound to a key with
@@ -10,7 +8,6 @@ namespace Terminal.Gui;
 ///     <para>Key bindings are scoped to the most-focused view (<see cref="Focused"/>) by default.</para>
 /// </remarks>
 [Flags]
-
 public enum KeyBindingScope
 {
     /// <summary>The key binding is disabled.</summary>
@@ -23,27 +20,23 @@ public enum KeyBindingScope
     ///     The key binding is scoped to the View's Superview hierarchy and will be triggered even when the View does not have
     ///     focus, as
     ///     long as the SuperView does have focus. This is typically used for <see cref="View.HotKey"/>s.
-    ///     <remarks>
-    ///         <para>
-    ///             The View must be visible.
-    ///         </para>
-    ///         <para>
-    ///             HotKey-scoped key bindings are only invoked if the key down event was not handled by the focused view or
-    ///             any of its subviews.
-    ///         </para>
-    ///     </remarks>
+    ///     <para>
+    ///         The View must be visible.
+    ///     </para>
+    ///     <para>
+    ///         HotKey-scoped key bindings are only invoked if the key down event was not handled by the focused view or
+    ///         any of its subviews.
+    ///     </para>
     /// </summary>
     HotKey = 2,
 
     /// <summary>
     ///     The key binding will be triggered regardless of which view has focus. This is typically used for global
     ///     commands, which are called Shortcuts.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         Application-scoped key bindings are only invoked if the key down event was not handled by the focused view or
     ///         any of its subviews, and if the key was not bound to a <see cref="View.HotKey"/>.
     ///     </para>
-    /// </remarks>
-    Application = 4,
+    /// </summary>
+    Application = 4
 }

+ 1 - 1
Terminal.Gui/View/Layout/DimAutoStyle.cs

@@ -35,7 +35,7 @@ public enum DimAutoStyle
     ///     </para>
     ///     <para>
     ///         If <see cref="DimAuto.MaximumContentDim"/> is set, the dimension will be the maximum of the formatted text and the
-    ///         demension provided by <see cref="DimAuto.MaximumContentDim"/>. Otherwise, the dimension will be that of the formatted text.
+    ///         dimension provided by <see cref="DimAuto.MaximumContentDim"/>. Otherwise, the dimension will be that of the formatted text.
     ///     </para>
     /// </summary>
     Text = 2,

+ 5 - 7
Terminal.Gui/View/Navigation/TabBehavior.cs

@@ -6,25 +6,23 @@
 public enum TabBehavior
 {
     /// <summary>
-    ///     The View will not be a stop-poknt for keyboard-based navigation.
-    /// </summary>
-    /// <remarks>
+    ///     The View will not be a stop-point for keyboard-based navigation.
     ///     <para>
     ///         This flag has no impact on whether the view can be focused via means other than the keyboard. Use
     ///         <see cref="View.CanFocus"/>
     ///         to control whether a View can focus or not.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     NoStop = 0,
 
     /// <summary>
-    ///     The View will be a stop-point for keybaord-based navigation across Views (e.g. if the user presses `Tab`).
+    ///     The View will be a stop-point for keyboard-based navigation across Views (e.g. if the user presses `Tab`).
     /// </summary>
     TabStop = 1,
 
     /// <summary>
-    ///     The View will be a stop-point for keyboard-based navigation across groups (e.g. if the user presses
-    ///     <see cref="Application.NextTabGroupKey"/> (`Ctrl-PageDown`).
+    ///     The View will be a stop-point for keyboard-based navigation across groups. (e.g. if the user presses
+    ///     <see cref="Application.NextTabGroupKey"/> (`Ctrl+PageDown`)).
     /// </summary>
     TabGroup = 2
 }

+ 15 - 12
Terminal.Gui/View/ViewArrangement.cs

@@ -7,6 +7,10 @@
 /// </summary>
 /// <remarks>
 ///     <para>
+///         See the View Arrangement Deep Dive for more information:
+///         <see href="https://gui-cs.github.io/Terminal.GuiV2Docs/docs/arrangement.html"/>
+///     </para>
+///     <para>
 ///         Sizing or moving a view is only possible if the <see cref="View"/> is part of a <see cref="View.SuperView"/>
 ///         and
 ///         the relevant position and dimensions of the <see cref="View"/> are independent of other SubViews
@@ -37,11 +41,11 @@ public enum ViewArrangement
 
     /// <summary>
     ///     The top edge of the view can be resized.
+    ///     <para>
+    ///         This flag is mutually exclusive with <see cref="Movable"/>. If both are set, <see cref="Movable"/> takes
+    ///         precedence.
+    ///     </para>
     /// </summary>
-    /// <remarks>
-    ///     This flag is mutually exclusive with <see cref="Movable"/>. If both are set, <see cref="Movable"/> takes
-    ///     precedence.
-    /// </remarks>
     TopResizable = 8,
 
     /// <summary>
@@ -51,21 +55,20 @@ public enum ViewArrangement
 
     /// <summary>
     ///     The view can be resized in any direction.
+    ///     <para>
+    ///         If <see cref="Movable"/> is also set, the top will not be resizable.
+    ///     </para>
     /// </summary>
-    /// <remarks>
-    ///     If <see cref="Movable"/> is also set, the top will not be resizable.
-    /// </remarks>
     Resizable = LeftResizable | RightResizable | TopResizable | BottomResizable,
 
     /// <summary>
-    ///     The view overlap other views.
-    /// </summary>
-    /// <remarks>
+    ///     The view overlaps other views (the order of <see cref="View.Subviews"/> dicates the Z-order). If this flag is not
+    ///     set the view will operate in tiled mode.
     ///     <para>
     ///         When set, Tab and Shift-Tab will be constrained to the subviews of the view (normally, they will navigate to
     ///         the next/prev view in the next/prev Tabindex).
     ///         Use Ctrl-Tab (Ctrl-PageDown) / Ctrl-Shift-Tab (Ctrl-PageUp) to move between overlapped views.
     ///     </para>
-    /// </remarks>
-    Overlapped = 32,
+    /// </summary>
+    Overlapped = 32
 }

+ 14 - 23
Terminal.Gui/View/ViewportSettings.cs

@@ -3,6 +3,9 @@
 /// <summary>
 ///     Settings for how the <see cref="View.Viewport"/> behaves relative to the View's Content area.
 /// </summary>
+/// <remarks>
+///     See the Layout Deep Dive for more information: <see href="https://gui-cs.github.io/Terminal.GuiV2Docs/docs/layout.html"/>
+/// </remarks>
 [Flags]
 public enum ViewportSettings
 {
@@ -15,43 +18,35 @@ public enum ViewportSettings
     ///     If set, <see cref="View.Viewport"/><c>.X</c> can be set to negative values enabling scrolling beyond the left of
     ///     the
     ///     content area.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         When not set, <see cref="View.Viewport"/><c>.X</c> is constrained to positive values.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     AllowNegativeX = 1,
 
     /// <summary>
     ///     If set, <see cref="View.Viewport"/><c>.Y</c> can be set to negative values enabling scrolling beyond the top of the
     ///     content area.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         When not set, <see cref="View.Viewport"/><c>.Y</c> is constrained to positive values.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     AllowNegativeY = 2,
 
     /// <summary>
     ///     If set, <see cref="View.Viewport"/><c>.Size</c> can be set to negative coordinates enabling scrolling beyond the
     ///     top-left of the
     ///     content area.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         When not set, <see cref="View.Viewport"/><c>.Size</c> is constrained to positive coordinates.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     AllowNegativeLocation = AllowNegativeX | AllowNegativeY,
 
     /// <summary>
     ///     If set, <see cref="View.Viewport"/><c>.X</c> can be set values greater than <see cref="View.GetContentSize ()"/>
     ///     <c>.Width</c> enabling scrolling beyond the right
     ///     of the content area.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         When not set, <see cref="View.Viewport"/><c>.X</c> is constrained to <see cref="View.GetContentSize ()"/>
     ///         <c>.Width - 1</c>.
@@ -61,15 +56,13 @@ public enum ViewportSettings
     ///     <para>
     ///         The practical effect of this is that the last column of the content will always be visible.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     AllowXGreaterThanContentWidth = 4,
 
     /// <summary>
     ///     If set, <see cref="View.Viewport"/><c>.Y</c> can be set values greater than <see cref="View.GetContentSize ()"/>
     ///     <c>.Height</c> enabling scrolling beyond the right
     ///     of the content area.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         When not set, <see cref="View.Viewport"/><c>.Y</c> is constrained to <see cref="View.GetContentSize ()"/>
     ///         <c>.Height - 1</c>.
@@ -79,21 +72,19 @@ public enum ViewportSettings
     ///     <para>
     ///         The practical effect of this is that the last row of the content will always be visible.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     AllowYGreaterThanContentHeight = 8,
 
     /// <summary>
     ///     If set, <see cref="View.Viewport"/><c>.Size</c> can be set values greater than <see cref="View.GetContentSize ()"/>
     ///     enabling scrolling beyond the bottom-right
     ///     of the content area.
-    /// </summary>
-    /// <remarks>
     ///     <para>
     ///         When not set, <see cref="View.Viewport"/> is constrained to <see cref="View.GetContentSize ()"/><c> -1</c>.
     ///         This means the last column and row of the content will remain visible even if there is an attempt to
     ///         scroll the Viewport past the last column or row.
     ///     </para>
-    /// </remarks>
+    /// </summary>
     AllowLocationGreaterThanContentSize = AllowXGreaterThanContentWidth | AllowYGreaterThanContentHeight,
 
     /// <summary>
@@ -106,10 +97,10 @@ public enum ViewportSettings
     ///     If set <see cref="View.Clear()"/> will clear only the portion of the content
     ///     area that is visible within the <see cref="View.Viewport"/>. This is useful for views that have a
     ///     content area larger than the Viewport and want the area outside the content to be visually distinct.
+    ///     <para>
+    ///         <see cref="ClipContentOnly"/> must be set for this setting to work (clipping beyond the visible area must be
+    ///         disabled).
+    ///     </para>
     /// </summary>
-    /// <remarks>
-    ///     <see cref="ClipContentOnly"/> must be set for this setting to work (clipping beyond the visible area must be
-    ///     disabled).
-    /// </remarks>
     ClearContentOnly = 32
-}
+}

+ 3 - 1
docfx/templates/modern/public/main.css

@@ -34,4 +34,6 @@ h6, .h6, h5, .h5, h4, .h4, h3, .h3, h2, .h2, h1, .h1 {
 
 .toc .flex-fill {
     font-size: var(--bs-body-font-size);
-}
+}
+
+.inheritedMembers { display: none; }

+ 1 - 0
docfx/templates/singulinkfx/styles/main.css

@@ -0,0 +1 @@
+.inheritedMembers { display: none; }