From 236e5f9ed358c2d4b95770946d10f2c06a0a6f34 Mon Sep 17 00:00:00 2001
From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com>
Date: Fri, 1 Dec 2023 21:41:35 -0600
Subject: [PATCH] docs: add xml comments

---
 01/Trebuchet/Program.cs | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/01/Trebuchet/Program.cs b/01/Trebuchet/Program.cs
index bd3bc06..d90bb99 100644
--- a/01/Trebuchet/Program.cs
+++ b/01/Trebuchet/Program.cs
@@ -31,12 +31,30 @@ public class Program
   }
 }
 
+/// <summary>
+/// Interface for puzzle solvers.
+/// </summary>
 public interface IPuzzleSolver
 {
+  /// <summary>
+  /// Sums all calibration values.
+  /// </summary>
+  /// <param name="lines">The lines of the input file.</param>
+  /// <returns>The sum of all calibration values.</returns>
   public int SumCalibrationValues(string[] lines);
+
+  /// <summary>
+  /// Gets the calibration value for a given line.
+  /// </summary>
+  /// <param name="line">The line to get the calibration value for.</param>
+  /// <returns>The calibration value for the given line.</returns>
   public int GetCalibrationValue(string line);
 }
 
+/// <summary>
+/// Puzzle solver for part one.
+/// </summary>
+/// <inheritdoc cref="IPuzzleSolver"/>
 public class PartOnePuzzleSolver : IPuzzleSolver
 {
   public int SumCalibrationValues(string[] lines) => lines.Sum(GetCalibrationValue);
@@ -60,6 +78,10 @@ public class PartOnePuzzleSolver : IPuzzleSolver
   }
 }
 
+/// <summary>
+/// Puzzle solver for part two.
+/// </summary>
+/// <inheritdoc cref="IPuzzleSolver"/>
 public class PartTwoPuzzleSolver : IPuzzleSolver
 {
   private readonly Dictionary<string, string> _validDigitsAsWords = new() {