Inline more XML docs

src/AssemblyAI/Files/ExtendedFilesClient.cs

@@ -8,6 +8,8 @@ public partial class FilesClient
  /// <summary>
  /// Upload a media file to AssemblyAI's servers.
  /// </summary>
+ /// <param name="audioFile">The local file to upload</param>
+ /// <param name="options">The HTTP request options</param>
  public async Task<UploadedFile> UploadAsync(FileInfo audioFile, RequestOptions? options = null)
  {
  using var audioFileStream = audioFile.OpenRead();
@@ -17,6 +19,9 @@ public async Task<UploadedFile> UploadAsync(FileInfo audioFile, RequestOptions?
  /// <summary>
  /// Upload a media file to AssemblyAI's servers.
  /// </summary>
+ /// <param name="stream">The file stream to upload</param>
+ /// <param name="disposeStream">Dispose the stream ASAP</param>
+ /// <param name="options">The HTTP request options</param>
  public async Task<UploadedFile> UploadAsync(Stream stream, bool disposeStream, RequestOptions? options = null)
  {
  if (!disposeStream) return await UploadAsync(stream, options).ConfigureAwait(false);

src/AssemblyAI/Transcripts/ExtendedTranscriptsClient.cs

@@ -29,9 +29,13 @@ internal ExtendedTranscriptsClient(RawClient client, AssemblyAIClient assemblyAI
  /// <param name="audioFile">The audio file to transcribe</param>
  /// <returns>Returns a task that resolves to a queued transcript</returns>
  public Task<Transcript> SubmitAsync(FileInfo audioFile) => SubmitAsync(audioFile, new TranscriptOptionalParams());
-
- /// <inheritdoc cref="SubmitAsync(FileInfo)"/>
+
+ /// <summary>
+ /// Create a transcript from a local file.
+ /// </summary>
+ /// <param name="audioFile">The audio file to transcribe</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>Returns a task that resolves to a queued transcript</returns>
  public async Task<Transcript> SubmitAsync(FileInfo audioFile, TranscriptOptionalParams transcriptParams)
  {
  var uploadedFile = await _assemblyAIClient.Files.UploadAsync(audioFile).ConfigureAwait(false);
@@ -46,18 +50,31 @@ public async Task<Transcript> SubmitAsync(FileInfo audioFile, TranscriptOptional
  public Task<Transcript> SubmitAsync(Stream audioFileStream) =>
  SubmitAsync(audioFileStream, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="SubmitAsync(Stream)"/>
+ /// <summary>
+ /// Create a transcript from a file stream.
+ /// </summary>
+ /// <param name="audioFileStream">The audio file stream to transcribe</param>
  /// <param name="disposeStream">Dispose the stream as soon as possible</param>
+ /// <returns>Returns a task that resolves to a queued transcript</returns>
  public Task<Transcript> SubmitAsync(Stream audioFileStream, bool disposeStream) =>
  SubmitAsync(audioFileStream, disposeStream, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="SubmitAsync(Stream)"/>
+ /// <summary>
+ /// Create a transcript from a file stream.
+ /// </summary>
+ /// <param name="audioFileStream">The audio file stream to transcribe</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>Returns a task that resolves to a queued transcript</returns>
  public Task<Transcript> SubmitAsync(Stream audioFileStream, TranscriptOptionalParams transcriptParams)
  => SubmitAsync(audioFileStream, false, transcriptParams);
 
- /// <inheritdoc cref="SubmitAsync(Stream,bool)"/>
- /// <inheritdoc cref="SubmitAsync(Stream,TranscriptOptionalParams)"/>
+ /// <summary>
+ /// Create a transcript from a file stream.
+ /// </summary>
+ /// <param name="audioFileStream">The audio file stream to transcribe</param>
+ /// <param name="disposeStream">Dispose the stream as soon as possible</param>
+ /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>Returns a task that resolves to a queued transcript</returns>
  public async Task<Transcript> SubmitAsync(
  Stream audioFileStream,
  bool disposeStream,
@@ -76,8 +93,12 @@ TranscriptOptionalParams transcriptParams
  /// <returns>Returns a task that resolves to a queued transcript</returns>
  public Task<Transcript> SubmitAsync(Uri audioFileUrl) => SubmitAsync(audioFileUrl, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="SubmitAsync(Uri)"/>
+ /// <summary>
+ /// Create a transcript from an audio file URI.
+ /// </summary>
+ /// <param name="audioFileUrl">The URI to the audio file to transcribe</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>Returns a task that resolves to a queued transcript</returns>
  public async Task<Transcript> SubmitAsync(Uri audioFileUrl, TranscriptOptionalParams transcriptParams)
  {
  return await SubmitAsync(CreateParams(audioFileUrl, transcriptParams)).ConfigureAwait(false);
@@ -90,8 +111,12 @@ public async Task<Transcript> SubmitAsync(Uri audioFileUrl, TranscriptOptionalPa
  /// <returns>Returns a task that resolves to a queued transcript</returns>
  public Task<Transcript> SubmitAsync(UploadedFile file) => SubmitAsync(file, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="SubmitAsync(UploadedFile)"/>
+ /// <summary>
+ /// Create a transcript from a file uploaded to AssemblyAI.
+ /// </summary>
+ /// <param name="file">The file uploaded to AssemblyAI</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>Returns a task that resolves to a queued transcript</returns>
  public async Task<Transcript> SubmitAsync(UploadedFile file, TranscriptOptionalParams transcriptParams)
  {
  return await SubmitAsync(CreateParams(file.UploadUrl, transcriptParams)).ConfigureAwait(false);
@@ -105,8 +130,12 @@ public async Task<Transcript> SubmitAsync(UploadedFile file, TranscriptOptionalP
  public Task<Transcript> TranscribeAsync(FileInfo audioFile) =>
  TranscribeAsync(audioFile, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="TranscribeAsync(FileInfo)"/>
+ /// <summary>
+ /// Transcribe a local file
+ /// </summary>
+ /// <param name="audioFile">The local file to transcribe</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>A task that resolves to a transcript with status "completed" or "error".</returns>
  public async Task<Transcript> TranscribeAsync(FileInfo audioFile, TranscriptOptionalParams transcriptParams)
  {
  using var audioFileStream = audioFile.OpenRead();
@@ -121,21 +150,34 @@ public async Task<Transcript> TranscribeAsync(FileInfo audioFile, TranscriptOpti
  public Task<Transcript> TranscribeAsync(Stream audioFileStream) =>
  TranscribeAsync(audioFileStream, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="TranscribeAsync(Stream)"/>
+ /// <summary>
+ /// Transcribe a file stream.
+ /// </summary>
+ /// <param name="audioFileStream">The audio file stream to transcribe</param>
  /// <param name="disposeStream">Dispose the stream as soon as possible</param>
+ /// <returns>A task that resolves to a transcript with status "completed" or "error".</returns>
  public Task<Transcript> TranscribeAsync(Stream audioFileStream, bool disposeStream) =>
  TranscribeAsync(audioFileStream, disposeStream, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="TranscribeAsync(Stream)"/>
+ /// <summary>
+ /// Transcribe a file stream.
+ /// </summary>
+ /// <param name="audioFileStream">The audio file stream to transcribe</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>A task that resolves to a transcript with status "completed" or "error".</returns>
  public async Task<Transcript> TranscribeAsync(Stream audioFileStream, TranscriptOptionalParams transcriptParams)
  {
  var fileUpload = await _assemblyAIClient.Files.UploadAsync(audioFileStream).ConfigureAwait(false);
  return await TranscribeAsync(new Uri(fileUpload.UploadUrl), transcriptParams).ConfigureAwait(false);
  }
 
- /// <inheritdoc cref="TranscribeAsync(Stream, bool)"/>
- /// <inheritdoc cref="TranscribeAsync(Stream, TranscriptOptionalParams)"/>
+ /// <summary>
+ /// Transcribe a file stream.
+ /// </summary>
+ /// <param name="audioFileStream">The audio file stream to transcribe</param>
+ /// <param name="transcriptParams">The transcript parameters</param>
+ /// <param name="disposeStream">Dispose the stream as soon as possible</param>
+ /// <returns>A task that resolves to a transcript with status "completed" or "error".</returns>
  public async Task<Transcript> TranscribeAsync(Stream audioFileStream, bool disposeStream,
  TranscriptOptionalParams transcriptParams)
  {
@@ -152,20 +194,30 @@ public async Task<Transcript> TranscribeAsync(Stream audioFileStream, bool dispo
  public Task<Transcript> TranscribeAsync(Uri audioFileUrl) =>
  TranscribeAsync(audioFileUrl, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="TranscribeAsync(Uri)"/>
+ /// <summary>
+ /// Transcribe an audio file via its public URI.
+ /// </summary>
+ /// <param name="audioFileUrl">The URI to the audio file to transcribe</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>A task that resolves to a transcript with status "completed" or "error".</returns>
  public Task<Transcript> TranscribeAsync(Uri audioFileUrl, TranscriptOptionalParams transcriptParams)
  => TranscribeAsync(CreateParams(audioFileUrl, transcriptParams));
 
  /// <summary>
  /// Transcribe a file uploaded to AssemblyAI.
  /// </summary>
+ /// <param name="file">The file uploaded to AssemblyAI to transcribe</param>
  /// <returns>A task that resolves to a transcript with status "completed" or "error".</returns>
  public Task<Transcript> TranscribeAsync(UploadedFile file) =>
  TranscribeAsync(file, new TranscriptOptionalParams());
 
- /// <inheritdoc cref="TranscribeAsync(UploadedFile)"/>
+
+ /// <summary>
+ /// Transcribe a file uploaded to AssemblyAI.
+ /// </summary>
+ /// <param name="file">The file uploaded to AssemblyAI to transcribe</param>
  /// <param name="transcriptParams">The transcript parameters</param>
+ /// <returns>A task that resolves to a transcript with status "completed" or "error".</returns>
  public Task<Transcript> TranscribeAsync(UploadedFile file, TranscriptOptionalParams transcriptParams)
  => TranscribeAsync(CreateParams(file.UploadUrl, transcriptParams));