Merge pull request #5944 from MarchingCube/control-docs

danwalmsley · danwalmsley · commit 58041b505d30 · 2021-05-19T15:32:36.000+01:00
Class level docs for basic controls.
diff --git a/src/Avalonia.Controls/DateTimePickers/TimePicker.cs b/src/Avalonia.Controls/DateTimePickers/TimePicker.cs
@@ -8,7 +8,7 @@
 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
@@ -4,14 +4,35 @@
 
 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
@@ -17,7 +17,7 @@
 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
@@ -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
@@ -8,6 +8,9 @@
 
 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
@@ -8,6 +8,9 @@
 
 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
@@ -4,6 +4,9 @@
 
 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
@@ -17,6 +17,9 @@
 
 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
     {

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`namespace Avalonia.Controls`
`9`	`9`	`{`
`10`	`10`	`/// <summary>`
`11`		`- /// A control to allow the user to select a time`
	`11`	`+ /// A control to allow the user to select a time.`
`12`	`12`	`/// </summary>`
`13`	`13`	`[PseudoClasses(":hasnotime")]`
`14`	`14`	`public class TimePicker : TemplatedControl`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`namespace Avalonia.Controls`
`18`	`18`	`{`
`19`	`19`	`/// <summary>`
`20`		`- /// Grid`
	`20`	`+ /// Defines a flexible grid area that consists of columns and rows.`
`21`	`21`	`/// </summary>`
`22`	`22`	`public class Grid : Panel`
`23`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,9 @@`
`8`	`8`
`9`	`9`	`namespace Avalonia.Controls`
`10`	`10`	`{`
	`11`	`+ /// <summary>`
	`12`	`+ /// Represents a button that allows a user to select a single option from a group of options.`
	`13`	`+ /// </summary>`
`11`	`14`	`public class RadioButton : ToggleButton`
`12`	`15`	`{`
`13`	`16`	`private class RadioButtonGroupManager`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace Avalonia.Controls`
`6`	`6`	`{`
	`7`	`+ /// <summary>`
	`8`	`+ /// Represents a control that raises its <see cref="Button.Click"/> event repeatedly when it is pressed and held.`
	`9`	`+ /// </summary>`
`7`	`10`	`public class RepeatButton : Button`
`8`	`11`	`{`
`9`	`12`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,9 @@`
`17`	`17`
`18`	`18`	`namespace Avalonia.Controls`
`19`	`19`	`{`
	`20`	`+ /// <summary>`
	`21`	`+ /// Represents a control that can be used to display or edit unformatted text.`
	`22`	`+ /// </summary>`
`20`	`23`	`[PseudoClasses(":empty")]`
`21`	`24`	`public class TextBox : TemplatedControl, UndoRedoHelper<TextBox.UndoRedoState>.IUndoRedoHost`
`22`	`25`	`{`