From 9b48da09ca7f5b9bf0a6a1b4082b4aad4cb89302 Mon Sep 17 00:00:00 2001
From: Dariusz Komosinski <darek.komosinski@gmail.com>
Date: Tue, 18 May 2021 23:49:49 +0200
Subject: [PATCH] Add at least basic class level docs for several controls.

---
 .../DateTimePickers/TimePicker.cs             |  2 +-
 src/Avalonia.Controls/Expander.cs             | 21 +++++++++++++++++++
 src/Avalonia.Controls/Grid.cs                 |  2 +-
 .../Primitives/ScrollBarVisibility.cs         | 18 ++++++++++++++++
 src/Avalonia.Controls/RadioButton.cs          |  3 +++
 src/Avalonia.Controls/RelativePanel.cs        |  3 +++
 src/Avalonia.Controls/RepeatButton.cs         |  3 +++
 src/Avalonia.Controls/TextBox.cs              |  3 +++
 8 files changed, 53 insertions(+), 2 deletions(-)

diff --git a/src/Avalonia.Controls/DateTimePickers/TimePicker.cs b/src/Avalonia.Controls/DateTimePickers/TimePicker.cs
index e4ff5e9e5b..d0cf772c01 100644
--- a/src/Avalonia.Controls/DateTimePickers/TimePicker.cs
+++ b/src/Avalonia.Controls/DateTimePickers/TimePicker.cs
@@ -8,7 +8,7 @@ using System.Globalization;
 namespace Avalonia.Controls
 {
     /// <summary>
-    /// A control to allow the user to select a time
+    /// A control to allow the user to select a time.
     /// </summary>
     [PseudoClasses(":hasnotime")]
     public class TimePicker : TemplatedControl
diff --git a/src/Avalonia.Controls/Expander.cs b/src/Avalonia.Controls/Expander.cs
index 9ff2e41fa9..052b42a233 100644
--- a/src/Avalonia.Controls/Expander.cs
+++ b/src/Avalonia.Controls/Expander.cs
@@ -4,14 +4,35 @@ using Avalonia.Controls.Primitives;
 
 namespace Avalonia.Controls
 {
+    /// <summary>
+    /// Direction in which an <see cref="Expander"/> control opens.
+    /// </summary>
     public enum ExpandDirection
     {
+        /// <summary>
+        /// Opens down.
+        /// </summary>
         Down,
+
+        /// <summary>
+        /// Opens up.
+        /// </summary>
         Up,
+
+        /// <summary>
+        /// Opens left.
+        /// </summary>
         Left,
+
+        /// <summary>
+        /// Opens right.
+        /// </summary>
         Right
     }
 
+    /// <summary>
+    /// A control with a header that has a collapsible content section.
+    /// </summary>
     [PseudoClasses(":expanded", ":up", ":down", ":left", ":right")]
     public class Expander : HeaderedContentControl
     {
diff --git a/src/Avalonia.Controls/Grid.cs b/src/Avalonia.Controls/Grid.cs
index 105a2744e5..c7d598006d 100644
--- a/src/Avalonia.Controls/Grid.cs
+++ b/src/Avalonia.Controls/Grid.cs
@@ -17,7 +17,7 @@ using Avalonia.VisualTree;
 namespace Avalonia.Controls
 {
     /// <summary>
-    /// Grid
+    /// Defines a flexible grid area that consists of columns and rows.
     /// </summary>
     public class Grid : Panel
     {
diff --git a/src/Avalonia.Controls/Primitives/ScrollBarVisibility.cs b/src/Avalonia.Controls/Primitives/ScrollBarVisibility.cs
index 90727a3505..e62e087140 100644
--- a/src/Avalonia.Controls/Primitives/ScrollBarVisibility.cs
+++ b/src/Avalonia.Controls/Primitives/ScrollBarVisibility.cs
@@ -1,10 +1,28 @@
 namespace Avalonia.Controls.Primitives
 {
+    /// <summary>
+    /// Specifies the visibility of a <see cref="ScrollBar"/> for scrollable content.
+    /// </summary>
     public enum ScrollBarVisibility
     {
+        /// <summary>
+        /// No scrollbars and no scrolling in this dimension.
+        /// </summary>
         Disabled,
+
+        /// <summary>
+        /// The scrollbar should be visible only if there is more content than fits in the viewport.
+        /// </summary>
         Auto,
+
+        /// <summary>
+        /// The scrollbar should never be visible.  No space should ever be reserved for the scrollbar.
+        /// </summary>
         Hidden,
+
+        /// <summary>
+        /// The scrollbar should always be visible.  Space should always be reserved for the scrollbar.
+        /// </summary>
         Visible,
     }
 }
diff --git a/src/Avalonia.Controls/RadioButton.cs b/src/Avalonia.Controls/RadioButton.cs
index 4bda241497..681278d247 100644
--- a/src/Avalonia.Controls/RadioButton.cs
+++ b/src/Avalonia.Controls/RadioButton.cs
@@ -8,6 +8,9 @@ using Avalonia.VisualTree;
 
 namespace Avalonia.Controls
 {
+    /// <summary>
+    /// Represents a button that allows a user to select a single option from a group of options.
+    /// </summary>
     public class RadioButton : ToggleButton
     {
         private class RadioButtonGroupManager
diff --git a/src/Avalonia.Controls/RelativePanel.cs b/src/Avalonia.Controls/RelativePanel.cs
index 2305d8fb9e..c5de004f09 100644
--- a/src/Avalonia.Controls/RelativePanel.cs
+++ b/src/Avalonia.Controls/RelativePanel.cs
@@ -8,6 +8,9 @@ using Avalonia.Layout;
 
 namespace Avalonia.Controls
 {
+    /// <summary>
+    /// Defines an area within which you can position and align child objects in relation to each other or the parent panel.
+    /// </summary>
     public partial class RelativePanel : Panel
     {
         private readonly Graph _childGraph;
diff --git a/src/Avalonia.Controls/RepeatButton.cs b/src/Avalonia.Controls/RepeatButton.cs
index fcd6607feb..ba770634d9 100644
--- a/src/Avalonia.Controls/RepeatButton.cs
+++ b/src/Avalonia.Controls/RepeatButton.cs
@@ -4,6 +4,9 @@ using Avalonia.Threading;
 
 namespace Avalonia.Controls
 {
+    /// <summary>
+    /// Represents a control that raises its <see cref="Button.Click"/> event repeatedly when it is pressed and held.
+    /// </summary>
     public class RepeatButton : Button
     {
         /// <summary>
diff --git a/src/Avalonia.Controls/TextBox.cs b/src/Avalonia.Controls/TextBox.cs
index 69da667011..42030c2860 100644
--- a/src/Avalonia.Controls/TextBox.cs
+++ b/src/Avalonia.Controls/TextBox.cs
@@ -17,6 +17,9 @@ using Avalonia.Controls.Metadata;
 
 namespace Avalonia.Controls
 {
+    /// <summary>
+    /// Represents a control that can be used to display or edit unformatted text.
+    /// </summary>
     [PseudoClasses(":empty")]
     public class TextBox : TemplatedControl, UndoRedoHelper<TextBox.UndoRedoState>.IUndoRedoHost
     {