Added method comments

Author: KristofferStrube

src/KristofferStrube.Blazor.FileAPI/Blob.InProcess.cs

@@ -67,6 +67,13 @@ internal BlobInProcess(IJSRuntime jSRuntime, IJSInProcessObjectReference inProce
     /// <returns>The MIME type of this blob.</returns>
     public string Type => inProcessHelper.Invoke<string>("getAttribute", JSReference, "type");
 
+    /// <summary>
+    /// Gets some range of the content of a <see cref="Blob"/> as a new <see cref="Blob"/>.
+    /// </summary>
+    /// <param name="start">The start index of the range. If <see langword="null"/> or negative then <c>0</c> is assumed.</param>
+    /// <param name="end">The start index of the range. If <see langword="null"/> or larger than the size of the original <see cref="Blob"/> then the size of the original <see cref="Blob"/> is assumed.</param>
+    /// <param name="contentType">An optional MIME type of the new <see cref="Blob"/>. If <see langword="null"/> then the MIME type of the original <see cref="Blob"/> is used.</param>
+    /// <returns>A new <see cref="Blob"/>.</returns>
     public Blob Slice(long? start = null, long? end = null, string? contentType = null)
     {
         start ??= 0;

src/KristofferStrube.Blazor.FileAPI/Blob.cs

@@ -67,6 +67,13 @@ public async Task<string> GetTypeAsync()
         return await helper.InvokeAsync<string>("getAttribute", JSReference, "type");
     }
 
+    /// <summary>
+    /// Gets some range of the content of a <see cref="Blob"/> as a new <see cref="Blob"/>.
+    /// </summary>
+    /// <param name="start">The start index of the range. If <see langword="null"/> or negative then <c>0</c> is assumed.</param>
+    /// <param name="end">The start index of the range. If <see langword="null"/> or larger than the size of the original <see cref="Blob"/> then the size of the original <see cref="Blob"/> is assumed.</param>
+    /// <param name="contentType">An optional MIME type of the new <see cref="Blob"/>. If <see langword="null"/> then the MIME type of the original <see cref="Blob"/> is used.</param>
+    /// <returns>A new <see cref="Blob"/>.</returns>
     public async Task<Blob> SliceAsync(long? start = null, long? end = null, string? contentType = null)
     {
         start ??= 0;
@@ -75,12 +82,20 @@ public async Task<Blob> SliceAsync(long? start = null, long? end = null, string?
         return new Blob(jSRuntime, jSInstance);
     }
 
+    /// <summary>
+    /// Creates a new <see cref="ReadableStream"/> from the <see cref="Blob"/>.
+    /// </summary>
+    /// <returns>A new wrapper for a <see cref="ReadableStream"/></returns>
     public async Task<ReadableStream> StreamAsync()
     {
         IJSObjectReference jSInstance = await JSReference.InvokeAsync<IJSObjectReference>("stream");
         return ReadableStream.Create(jSRuntime, jSInstance);
     }
 
+    /// <summary>
+    /// Creates a new <see cref="ReadableStreamInProcess"/> from the <see cref="Blob"/>.
+    /// </summary>
+    /// <returns>A new wrapper for a <see cref="ReadableStreamInProcess"/> which can access members and call non-promise methods synchronously.</returns>
     public async Task<ReadableStreamInProcess> StreamInProcessAsync()
     {
         IJSInProcessObjectReference jSInstance = await JSReference.InvokeAsync<IJSInProcessObjectReference>("stream");

src/KristofferStrube.Blazor.FileAPI/FileReader.cs

@@ -23,7 +23,7 @@ public static FileReader Create(IJSRuntime jSRuntime, IJSObjectReference jSRefer
     /// Constructs a wrapper instance using the standard constructor.
     /// </summary>
     /// <param name="jSRuntime">An <see cref="IJSRuntime"/> instance.</param>
-    /// <returns></returns>
+    /// <returns>A wrapper instance for a <see cref="FileReader"/>.</returns>
     public static async Task<FileReader> CreateAsync(IJSRuntime jSRuntime)
     {
         IJSObjectReference helper = await jSRuntime.GetHelperAsync();
@@ -44,26 +44,52 @@ internal FileReader(IJSRuntime jSRuntime, IJSObjectReference jSReference) : base
 
     public DotNetObjectReference<FileReader> ObjRef { get; init; }
 
+    /// <summary>
+    /// Starts a new read for some <see cref="Blob"/> as an <see langword="byte"/>[] which can be read from <see cref="GetResultAsByteArrayAsync"/> once the load has ended which can be checked by setting the action <see cref="OnLoadEnd"/>.
+    /// </summary>
+    /// <param name="blob">The <see cref="Blob"/> that should be read asynchronously.</param>
+    /// <returns></returns>
     public async Task ReadAsArrayBufferAsync(Blob blob)
     {
         await JSReference.InvokeVoidAsync("readAsArrayBuffer", blob.JSReference);
     }
 
+    /// <summary>
+    /// Starts a new read for some <see cref="Blob"/> as a binarily encoded <see langword="string"/> which can be read from <see cref="GetResultAsStringAsync"/> once the load has ended which can be checked by setting the action <see cref="OnLoadEnd"/>.
+    /// </summary>
+    /// <param name="blob">The <see cref="Blob"/> that should be read asynchronously.</param>
+    /// <returns></returns>
     public async Task ReadAsBinaryStringAsync(Blob blob)
     {
         await JSReference.InvokeVoidAsync("readAsBinaryString", blob.JSReference);
     }
 
+    /// <summary>
+    /// Starts a new read for some <see cref="Blob"/> as a <see langword="string"/> which can be read from <see cref="GetResultAsStringAsync"/> once the load has ended which can be checked by setting the action <see cref="OnLoadEnd"/>.
+    /// </summary>
+    /// <param name="blob">The <see cref="Blob"/> that should be read asynchronously.</param>
+    /// <param name="encoding">An optional encoding for the text. The default is UTF-8.</param>
+    /// <returns></returns>
     public async Task ReadAsTextAsync(Blob blob, string? encoding = null)
     {
         await JSReference.InvokeVoidAsync("readAsText", blob.JSReference, encoding);
     }
 
+    /// <summary>
+    /// Starts a new read for some <see cref="Blob"/> as a base64 encoded Data URL which can be read from <see cref="GetResultAsStringAsync"/> once the load has ended which can be checked by setting the action <see cref="OnLoadEnd"/>.
+    /// </summary>
+    /// <param name="blob">The <see cref="Blob"/> that should be read asynchronously.</param>
+    /// <returns></returns>
     public async Task ReadAsDataURLAsync(Blob blob)
     {
         await JSReference.InvokeVoidAsync("readAsDataURL", blob.JSReference);
     }
 
+    /// <summary>
+    /// Terminates the load if the <see cref="GetReadyStateAsync"/> is <see cref="LOADING"/> else it sets the result to <see langword="null"/>.
+    /// </summary>
+    /// <param name="blob">The <see cref="Blob"/> read that should be terminated.</param>
+    /// <returns></returns>
     public async Task AbortAsync(Blob blob)
     {
         await JSReference.InvokeVoidAsync("abort", blob.JSReference);
@@ -73,14 +99,18 @@ public async Task AbortAsync(Blob blob)
     public const ushort LOADING = 1;
     public const ushort DONE = 2;
 
+    /// <summary>
+    /// Gets the state of the <see cref="FileReader"/>.
+    /// </summary>
+    /// <returns>As a standard either <see cref="EMPTY"/>, <see cref="LOADING"/> or <see cref="DONE"/></returns>
     public async Task<ushort> GetReadyStateAsync()
     {
         IJSObjectReference helper = await helperTask.Value;
         return await helper.InvokeAsync<ushort>("getAttribute", JSReference, "readyState");
     }
 
     /// <summary>
-    /// Checks whether the result is a either a string or a byte array.
+    /// Checks whether the result is a either a <see langword="string"/> or a byte array.
     /// </summary>
     /// <returns>Either the type of <see langword="string"/> or type of <see cref="byte"/>[].</returns>
     public async Task<Type?> GetResultTypeAsync()
@@ -90,12 +120,20 @@ public async Task<ushort> GetReadyStateAsync()
         return isArrayBuffer ? typeof(byte[]) : typeof(string);
     }
 
+    /// <summary>
+    /// Gets the result of the read a <see langword="string"/>.
+    /// </summary>
+    /// <returns>A <see langword="string"/> representing the read. If there was no result from the read or if the read has not ended yet then it will be <see langword="null"/>.</returns>
     public async Task<string?> GetResultAsStringAsync()
     {
         IJSObjectReference helper = await helperTask.Value;
         return await helper.InvokeAsync<string>("getAttribute", JSReference, "result");
     }
 
+    /// <summary>
+    /// Gets the result of the read a <see langword="byte"/>[].
+    /// </summary>
+    /// <returns>A <see langword="byte"/>[] representing the read. If there was no result from the read or if the read has not ended yet then it will be <see langword="null"/>.</returns>
     public async Task<byte[]?> GetResultAsByteArrayAsync()
     {
         IJSObjectReference helper = await helperTask.Value;
@@ -104,7 +142,7 @@ public async Task<ushort> GetReadyStateAsync()
     }
 
     /// <summary>
-    /// Gets the error object reference which will be null if no error occured.
+    /// Gets the error object reference which will be <see langword="null"/> if no error occured.
     /// </summary>
     /// <returns>A nullable IJSObjectReference because it was out of scope to wrap the Exception API.</returns>
     public async Task<IJSObjectReference?> GetErrorAsync()
@@ -113,21 +151,39 @@ public async Task<ushort> GetReadyStateAsync()
         return await helper.InvokeAsync<IJSObjectReference?>("getAttribute", JSReference, "error");
     }
 
+    /// <summary>
+    /// Invoked when a load starts.
+    /// </summary>
     [JsonIgnore]
     public Func<ProgressEvent, Task>? OnLoadStart { get; set; }
 
+    /// <summary>
+    /// Invoked when the progress of a load changes which includes when it ends.
+    /// </summary>
     [JsonIgnore]
     public Func<ProgressEvent, Task>? OnProgress { get; set; }
 
+    /// <summary>
+    /// Invoked when a load ends successfully.
+    /// </summary>
     [JsonIgnore]
     public Func<ProgressEvent, Task>? OnLoad { get; set; }
 
+    /// <summary>
+    /// Invoked when a load is aborted.
+    /// </summary>
     [JsonIgnore]
     public Func<ProgressEvent, Task>? OnAbort { get; set; }
 
+    /// <summary>
+    /// Invoked when a load fails due to an error.
+    /// </summary>
     [JsonIgnore]
     public Func<ProgressEvent, Task>? OnError { get; set; }
 
+    /// <summary>
+    /// invoked when a load finishes successfully or not.
+    /// </summary>
     [JsonIgnore]
     public Func<ProgressEvent, Task>? OnLoadEnd { get; set; }
 
@@ -172,6 +228,4 @@ public async Task InvokeOnLoadEnd(IJSObjectReference jsProgressEvent)
         if (OnLoadEnd is null) return;
         await OnLoadEnd.Invoke(new ProgressEvent(jSRuntime, jsProgressEvent));
     }
-
-
 }