From 1b2e6870349372d228f61f72e12327a2284ea980 Mon Sep 17 00:00:00 2001
From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com>
Date: Sun, 3 Aug 2025 22:15:07 -0500
Subject: [PATCH] docs: add missing xml comments

---
 .../Analysis/FailedTranscriptAnalysisException.cs | 15 +++++++++++++++
 .../FailedAudioTranscriptionException.cs          | 15 +++++++++++++++
 2 files changed, 30 insertions(+)

diff --git a/src/StreamShorts.Library/Analysis/FailedTranscriptAnalysisException.cs b/src/StreamShorts.Library/Analysis/FailedTranscriptAnalysisException.cs
index 092216a..c918499 100644
--- a/src/StreamShorts.Library/Analysis/FailedTranscriptAnalysisException.cs
+++ b/src/StreamShorts.Library/Analysis/FailedTranscriptAnalysisException.cs
@@ -1,15 +1,30 @@
 namespace StreamShorts.Library.Analysis;
 
+/// <summary>
+/// Represents an error that occurs during transcript analysis.
+/// </summary>
 public sealed class FailedTranscriptAnalysisException : Exception
 {
+  /// <summary>
+  /// Initializes a new instance of the <see cref="FailedTranscriptAnalysisException"/> class.
+  /// </summary>
   public FailedTranscriptAnalysisException()
   {
   }
 
+  /// <summary>
+  /// Initializes a new instance of the <see cref="FailedTranscriptAnalysisException"/> class with a specified error message.
+  /// /// </summary>
+  /// <param name="message">The error message that explains the reason for the exception.</param>
   public FailedTranscriptAnalysisException(string message) : base(message)
   {
   }
 
+  /// <summary>
+  /// Initializes a new instance of the <see cref="FailedTranscriptAnalysisException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
+  /// </summary>
+  /// <param name="message">The error message that explains the reason for the exception.</param>
+  /// <param name="innerException">The exception that is the cause of the current exception.</param>
   public FailedTranscriptAnalysisException(string message, Exception innerException) : base(message, innerException)
   {
   }
diff --git a/src/StreamShorts.Library/Transcription/FailedAudioTranscriptionException.cs b/src/StreamShorts.Library/Transcription/FailedAudioTranscriptionException.cs
index f64fa3a..8d7a3d1 100644
--- a/src/StreamShorts.Library/Transcription/FailedAudioTranscriptionException.cs
+++ b/src/StreamShorts.Library/Transcription/FailedAudioTranscriptionException.cs
@@ -1,15 +1,30 @@
 namespace StreamShorts.Library.Transcription;
 
+/// <summary>
+/// Represents an error that occurs when audio transcription fails.
+/// </summary>
 public sealed class FailedAudioTranscriptionException : Exception
 {
+  /// <summary>
+  /// Initializes a new instance of the <see cref="FailedAudioTranscriptionException"/> class with no parameters.
+  /// </summary>
   public FailedAudioTranscriptionException()
   {
   }
 
+  /// <summary>
+  /// Initializes a new instance of the <see cref="FailedAudioTranscriptionException"/> class with a specified error message.
+  /// </summary>
+  /// <param name="message">The error message that explains the reason for the exception.</param>
   public FailedAudioTranscriptionException(string message) : base(message)
   {
   }
 
+  /// <summary>
+  /// Initializes a new instance of the <see cref="FailedAudioTranscriptionException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
+  /// </summary>
+  /// <param name="message">The error message that explains the reason for the exception.</param>
+  /// <param name="innerException">The exception that is the cause of the current exception.</param>
   public FailedAudioTranscriptionException(string message, Exception innerException) : base(message, innerException)
   {
   }