Merge pull request #64 from TruePadawan/dev

Refactor export feature and enhance documentation across classes

Author: TruePadawan

Scribble.Shared/Lib/StrokePaint.cs

@@ -6,9 +6,9 @@ namespace Scribble.Shared.Lib;
 
 public class StrokePaint
 {
-    public bool IsAntialias { get; init; }
-    public bool IsStroke { get; init; }
-    public SKStrokeCap StrokeCap { get; init; }
+    public bool IsAntialias { get; set; } = true;
+    public bool IsStroke { get; set; } = true;
+    public SKStrokeCap StrokeCap { get; set; } = SKStrokeCap.Round;
     public SKStrokeJoin StrokeJoin { get; set; }
     public float StrokeWidth { get; set; } = 1;
     public float TextSize { get; set; }

Scribble/Behaviours/ToggleButtonGroup.cs

@@ -5,6 +5,10 @@
 
 namespace Scribble.Behaviours;
 
+/// <summary>
+/// Provides the ability to group ToggleButtons and have them act like Radio buttons
+/// via the GroupName attached property
+/// </summary>
 public class ToggleButtonGroup
 {
     public static readonly AttachedProperty<string?> GroupNameProperty =

Scribble/Controls/ScribbleColorPicker/ScribbleColorPicker.axaml.cs

@@ -6,6 +6,10 @@
 
 namespace Scribble.Controls.ScribbleColorPicker;
 
+/// <summary>
+/// Custom control for picking a color
+/// It provides a button that opens a flyout with a programmable set of colors that can be selected
+/// </summary>
 public partial class ScribbleColorPicker : UserControl
 {
     private static readonly IReadOnlyList<Color> DefaultPalette = GenerateMaterialPalette();
@@ -27,12 +31,14 @@ private static List<Color> GenerateMaterialPalette()
         return colors;
     }
 
-    // Properties
     public static readonly StyledProperty<IEnumerable<Color>> PaletteColorsProperty =
         AvaloniaProperty.Register<ScribbleColorPicker, IEnumerable<Color>>(
             nameof(PaletteColors),
             defaultValue: DefaultPalette);
 
+    /// <summary>
+    /// Property representing the colors that can be selected
+    /// </summary>
     public IEnumerable<Color> PaletteColors
     {
         get => GetValue(PaletteColorsProperty);
@@ -45,6 +51,9 @@ public IEnumerable<Color> PaletteColors
             Colors.White,
             defaultBindingMode: BindingMode.TwoWay);
 
+    /// <summary>
+    /// Property representing the currently selected color
+    /// </summary>
     public Color SelectedColor
     {
         get => GetValue(SelectedColorProperty);
@@ -59,6 +68,7 @@ public ScribbleColorPicker()
         InitializeComponent();
     }
 
+    // Update the textbox to show the hex code of the currently selected color
     protected override void OnPropertyChanged(AvaloniaPropertyChangedEventArgs change)
     {
         base.OnPropertyChanged(change);
@@ -77,6 +87,7 @@ private void UpdateHexTextBox(Color color)
         _isUpdatingHex = false;
     }
 
+    // Update the selected color when the inputted text is a valid hex code
     private void HexTextBox_OnTextChanged(object? sender, TextChangedEventArgs e)
     {
         if (_isUpdatingHex) return;
@@ -94,6 +105,7 @@ private void HexTextBox_OnTextChanged(object? sender, TextChangedEventArgs e)
         }
     }
 
+    // Close the flyout when a color is selected
     private void ColorListBox_OnSelectionChanged(object? sender, SelectionChangedEventArgs e)
     {
         if (e.AddedItems.Count > 0)

Scribble/Controls/SkiaCanvas.cs

@@ -13,6 +13,9 @@
 
 namespace Scribble.Controls;
 
+/// <summary>
+/// The SkiaCanvas control represents the canvas/whiteboard of the application
+/// </summary>
 public class SkiaCanvas : Control
 {
     public static readonly StyledProperty<List<Stroke>> StrokesProperty =
@@ -43,10 +46,10 @@ public override void Render(DrawingContext context)
         var strokesToDraw = Strokes;
         var bgColor = CanvasBackground;
         context.Custom(
-            new SkiaDrawOperation(bounds, canvas => { DrawContent(canvas, strokesToDraw, bgColor); }));
+            new SkiaDrawOperation(bounds, canvas => { DrawStrokesOnCanvas(canvas, strokesToDraw, bgColor); }));
     }
 
-    private void DrawContent(SKCanvas canvas, IEnumerable<Stroke> strokesToDraw, Color bgColor)
+    private void DrawStrokesOnCanvas(SKCanvas canvas, IEnumerable<Stroke> strokesToDraw, Color bgColor)
     {
         canvas.Clear(Utilities.ToSkColor(bgColor));
 

Scribble/Converters/EnumToBoolConverter.cs

@@ -5,6 +5,9 @@
 
 namespace Scribble.Converters;
 
+/// <summary>
+/// This converter allows the ToggleButton control's IsChecked status to be converted between a boolean and an enum
+/// </summary>
 public class EnumToBoolConverter : IValueConverter
 {
     public object Convert(object? value, Type targetType, object? parameter, CultureInfo culture)
@@ -16,4 +19,4 @@ public object ConvertBack(object? value, Type targetType, object? parameter, Cul
     {
         return value is true && parameter != null ? parameter : BindingOperations.DoNothing;
     }
-}
+}

Scribble/Extensions/ServiceCollectionExtensions.cs

@@ -8,6 +8,9 @@
 
 namespace Scribble.Extensions;
 
+/// <summary>
+/// Extension methods for registering services in the application
+/// </summary>
 public static class ServiceCollectionExtensions
 {
     public static void AddCommonServices(this IServiceCollection collection)

Scribble/Lib/CanvasExporter.cs

@@ -3,6 +3,12 @@
 
 namespace Scribble.Lib.CollaborativeDrawing;
 
+/// <summary>
+/// Represents a multi-user drawing room
+/// </summary>
+/// <param name="roomId">The unique ID of the room</param>
+/// <param name="connectionId">The client's connection ID from SignalR</param>
+/// <param name="displayName">The client's display name</param>
 public class CollaborativeDrawingRoom(string roomId, string connectionId, string displayName)
 {
     public string RoomId { get; } = roomId;

Scribble/Lib/CollaborativeDrawing/CollaborativeDrawingRoom.cs

@@ -22,6 +22,7 @@ public class CollaborativeDrawingService(string serverUrl)
     public event Action<CollaborativeDrawingUser, List<CollaborativeDrawingUser>>? ClientJoinedRoom;
     public event Action<CollaborativeDrawingUser, List<CollaborativeDrawingUser>>? ClientLeftRoom;
 
+    // Set up the event handlers and starts a connection to the SignalR server
     public async Task StartAsync()
     {
         // Listen for draw events from others in the room
@@ -50,6 +51,7 @@ public async Task StartAsync()
         ConnectionStarted?.Invoke();
     }
 
+    // Kill the SignalR connection
     public async Task StopAsync()
     {
         await _connection.StopAsync();

Scribble/Lib/CollaborativeDrawing/CollaborativeDrawingService.cs

@@ -4,6 +4,10 @@
 
 namespace Scribble.Lib;
 
+/// <summary>
+/// Represents the current selection in the application
+/// It encapsulates the data that represents an active selection
+/// </summary>
 public class Selection
 {
     public Point SelectionMoveCoord = new Point(-1, -1);