Explorar el Código

Doc changes addressed by @tig.

BDisp hace 11 meses
padre
commit
b16b4637a8
Se han modificado 2 ficheros con 10 adiciones y 5 borrados
  1. 7 1
      Terminal.Gui/Views/Scroll/Scroll.cs
  2. 3 4
      Terminal.Gui/Views/Scroll/ScrollBar.cs

+ 7 - 1
Terminal.Gui/Views/Scroll/Scroll.cs

@@ -5,8 +5,14 @@ using System.ComponentModel;
 namespace Terminal.Gui;
 
 /// <summary>
-///     Provides a proportional control for scrolling through content. Used within a <see cref="ScrollBar"/>.
+///     Indicates the position and size of scrollable content. The indicator can be dragged with the mouse. Can be
+///     oriented either vertically or horizontally. Used within a <see cref="ScrollBar"/>.
 /// </summary>
+/// <remarks>
+///     <para>
+///         By default, this view cannot be focused and does not support keyboard.
+///     </para>
+/// </remarks>
 public class Scroll : View
 {
     /// <inheritdoc/>

+ 3 - 4
Terminal.Gui/Views/Scroll/ScrollBar.cs

@@ -4,13 +4,12 @@ using System.ComponentModel;
 
 namespace Terminal.Gui;
 
-/// <summary>ScrollBars are views that display a 1-character scrollbar, either horizontal or vertical</summary>
+/// <summary>A proportional scroll bar that can be oriented either horizontally or vertically.</summary>
 /// <remarks>
 ///     <para>
-///         The scrollbar is drawn to be a representation of the Size, assuming that the scroll position is set at
-///         Position.
+///         <see cref="Position"/> indicates the current location between zero and <see cref="Size"/>.
 ///     </para>
-///     <para>If the region to display the scrollbar is larger than three characters, arrow indicators are drawn.</para>
+///     <para>If the scrollbar is larger than three cells, arrow indicators are drawn.</para>
 /// </remarks>
 public class ScrollBar : View
 {