docs: add missing xml comments

This commit is contained in:
Stevan Freeborn
2025-08-03 22:15:07 -05:00
parent ff423db5fe
commit 1b2e687034
2 changed files with 30 additions and 0 deletions
@@ -1,15 +1,30 @@
namespace StreamShorts.Library.Analysis; namespace StreamShorts.Library.Analysis;
/// <summary>
/// Represents an error that occurs during transcript analysis.
/// </summary>
public sealed class FailedTranscriptAnalysisException : Exception public sealed class FailedTranscriptAnalysisException : Exception
{ {
/// <summary>
/// Initializes a new instance of the <see cref="FailedTranscriptAnalysisException"/> class.
/// </summary>
public FailedTranscriptAnalysisException() 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) 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) public FailedTranscriptAnalysisException(string message, Exception innerException) : base(message, innerException)
{ {
} }
@@ -1,15 +1,30 @@
namespace StreamShorts.Library.Transcription; namespace StreamShorts.Library.Transcription;
/// <summary>
/// Represents an error that occurs when audio transcription fails.
/// </summary>
public sealed class FailedAudioTranscriptionException : Exception public sealed class FailedAudioTranscriptionException : Exception
{ {
/// <summary>
/// Initializes a new instance of the <see cref="FailedAudioTranscriptionException"/> class with no parameters.
/// </summary>
public FailedAudioTranscriptionException() 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) 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) public FailedAudioTranscriptionException(string message, Exception innerException) : base(message, innerException)
{ {
} }