From 5b29ea012e8fc8c734e105fb67f5595130bf23c9 Mon Sep 17 00:00:00 2001
From: dnesov <contact.dnesov@gmail.com>
Date: Fri, 20 Jun 2025 20:16:36 +0200
Subject: [PATCH] Add documentation to containers.

---
 Voile/Source/UI/Containers/FlexContainer.cs   | 42 +++++++++++++++++++
 Voile/Source/UI/Containers/GridContainer.cs   | 12 ++++++
 .../UI/Containers/HorizontalContainer.cs      |  6 +++
 .../Source/UI/Containers/VerticalContainer.cs |  6 +++
 4 files changed, 66 insertions(+)

diff --git a/Voile/Source/UI/Containers/FlexContainer.cs b/Voile/Source/UI/Containers/FlexContainer.cs
index f706a52..d252865 100644
--- a/Voile/Source/UI/Containers/FlexContainer.cs
+++ b/Voile/Source/UI/Containers/FlexContainer.cs
@@ -11,27 +11,69 @@ public enum FlexDirection
 
 public enum JustifyContent
 {
+    /// <summary>
+    /// Align children to the start of the line.
+    /// </summary>
     Start,
+    /// <summary>
+    /// Align children to the center of the line.
+    /// </summary>
     Center,
+    /// <summary>
+    /// Align children to the end of the line.
+    /// </summary>
     End,
+    /// <summary>
+    /// Equal space between items (no space at edges if multiple).
+    /// </summary>
     SpaceBetween
 }
 
 public enum AlignItems
 {
+    /// <summary>
+    /// Align to the top or left (cross-axis)
+    /// </summary>
     Start,
+    /// <summary>
+    /// Center along the cross-axis.
+    /// </summary>
     Center,
+    /// <summary>
+    /// Align to the bottom or right.
+    /// </summary>
     End
 }
 
+/// <summary>
+/// A flexible layout container that arranges its child elements in rows or columns, similar to CSS flexbox. Supports wrapping, alignment, spacing, and space distribution.
+/// </summary>
 public class FlexContainer : Container
 {
+    /// <summary>
+    /// Layout direction to use with this <see cref="FlexContainer"/>.
+    /// </summary>
     public FlexDirection Direction { get; set; } = FlexDirection.Row;
+    /// <summary>
+    /// Controls main-axis alignment of child elements. By default, children will be positioned at the start of a line. 
+    /// </summary>
     public JustifyContent Justify { get; set; } = JustifyContent.Start;
+    /// <summary>
+    /// Controls cross-axis alignment (start, center, end).
+    /// </summary>
     public AlignItems Align { get; set; } = AlignItems.Start;
+    /// <summary>
+    /// If true, children wrap onto multiple lines (rows or columns).
+    /// </summary>
     public bool Wrap { get; set; } = false;
+    /// <summary>
+    /// Space between child elements.
+    /// </summary>
     public float Gap { get; set; } = 16f;
 
+    /// <summary>
+    /// (Reserved) If true, distributes extra space among children (not implemented)
+    /// </summary>
     public bool DistributeRemainingSpace { get; set; } = false;
 
     public FlexContainer() : base() { }
diff --git a/Voile/Source/UI/Containers/GridContainer.cs b/Voile/Source/UI/Containers/GridContainer.cs
index 7c3c627..c463a9c 100644
--- a/Voile/Source/UI/Containers/GridContainer.cs
+++ b/Voile/Source/UI/Containers/GridContainer.cs
@@ -3,10 +3,22 @@ using Voile.Rendering;
 
 namespace Voile.UI.Containers;
 
+/// <summary>
+/// A grid container arranges its children in a grid layout with a given column count, and column and row spacing between child elements.
+/// </summary>
 public class GridContainer : Container
 {
+    /// <summary>
+    /// Amount of columns this grid has.
+    /// </summary>
     public int Columns { get; set; } = 2;
+    /// <summary>
+    /// Spacing between each grid column.
+    /// </summary>
     public float ColumnSpacing { get; set; } = 16.0f;
+    /// <summary>
+    /// Spacing between each grid row.
+    /// </summary>
     public float RowSpacing { get; set; } = 16.0f;
 
     public GridContainer(Rect minimumSize, List<IElement> children, int columns = 2, float colSpacing = 16.0f, float rowSpacing = 16.0f)
diff --git a/Voile/Source/UI/Containers/HorizontalContainer.cs b/Voile/Source/UI/Containers/HorizontalContainer.cs
index 3e8969b..e1934c3 100644
--- a/Voile/Source/UI/Containers/HorizontalContainer.cs
+++ b/Voile/Source/UI/Containers/HorizontalContainer.cs
@@ -3,8 +3,14 @@ using Voile.Rendering;
 
 namespace Voile.UI.Containers;
 
+/// <summary>
+/// A horizontal container arranges its children horizontally, with a given horizontal spacing between child elements.
+/// </summary>
 public class HorizontalContainer : Container
 {
+    /// <summary>
+    /// Horizontal spacing between child elements.
+    /// </summary>
     public float Spacing { get; set; } = 16.0f;
 
     public HorizontalContainer(Rect minimumSize, List<IElement> children, float spacing = 16.0f) : base(minimumSize, children)
diff --git a/Voile/Source/UI/Containers/VerticalContainer.cs b/Voile/Source/UI/Containers/VerticalContainer.cs
index ebf6f3a..9adbcc7 100644
--- a/Voile/Source/UI/Containers/VerticalContainer.cs
+++ b/Voile/Source/UI/Containers/VerticalContainer.cs
@@ -3,8 +3,14 @@ using Voile.Rendering;
 
 namespace Voile.UI.Containers;
 
+/// <summary>
+/// A vertical container arranges its children vertically, with a given vertical spacing between child elements.
+/// </summary>
 public class VerticalContainer : Container
 {
+    /// <summary>
+    /// Vertical spacing between child elements.
+    /// </summary>
     public float Spacing { get; set; } = 16.0f;
 
     public VerticalContainer(Rect minimumSize, List<IElement> children, float spacing = 16.0f) : base(minimumSize, children)