Merge pull request #5 from OpenAC-Net/doc

Adicionado documentação as classes.

Author: rftd

.github/workflows/publish.yml

@@ -34,7 +34,9 @@ jobs:
     - name: Setup .NET
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: '9.x'
+        dotnet-version: |
+          8.x
+          9.x
     - run: dotnet msbuild OpenAC.Net.Devices.sln -property:Configuration=Release -property:platform="Any CPU"
       working-directory: src
     - run: dotnet pack --configuration Release --output ${{ env.NuGetDirectory }}

src/.idea/.idea.OpenAC.Net.Devices/.idea/workspace.xml

@@ -34,14 +34,26 @@
 
 namespace OpenAC.Net.Devices.Blazor.Extensions;
 
+/// <summary>
+/// Métodos de extensão para <see cref="MemoryStream"/> relacionados ao Blazor.
+/// </summary>
 internal static class MemoryStreamExtensions
 {
+    /// <summary>
+    /// Converte o conteúdo do <see cref="MemoryStream"/> em um <see cref="ArrayBuffer"/>.
+    /// </summary>
+    /// <param name="ms">O <see cref="MemoryStream"/> de origem.</param>
+    /// <returns>Um <see cref="ArrayBuffer"/> contendo os dados do stream.</returns>
     public static ArrayBuffer ToArrayBuffer(this MemoryStream ms)
     {
         using var uint8Array = new Uint8Array(ms.ToArray());
         return uint8Array.Buffer;
     }
 
+    /// <summary>
+    /// Limpa o conteúdo do <see cref="MemoryStream"/>, zerando o buffer e redefinindo o tamanho e a posição.
+    /// </summary>
+    /// <param name="ms">O <see cref="MemoryStream"/> a ser limpo.</param>
     public static void Clear(this MemoryStream ms)
     {
         var buffer = ms.GetBuffer();

src/OpenAC.Net.Devices.Blazor/Extensions/MemoryStreamExtensions.cs

@@ -3,10 +3,20 @@
 
 namespace OpenAC.Net.Devices.Blazor.WebSerial;
 
+/// <summary>
+/// Implementa um stream de comunicação serial via WebSerial para uso em aplicações Blazor.
+/// </summary>
 public class OpenWebSerialStream(WebSerialConfig config) : OpenDeviceStream<WebSerialConfig>(config)
 {
+    /// <summary>
+    /// Obtém a quantidade de bytes disponíveis para leitura no buffer.
+    /// </summary>
     protected override int Available => (int)((Reader?.BaseStream.Length ?? 0) - (Reader?.BaseStream.Position ?? 0));
 
+    /// <summary>
+    /// Limpa o buffer de leitura da porta serial.
+    /// </summary>
+    /// <exception cref="InvalidOperationException">Lançada se a porta serial não estiver configurada.</exception>
     public override void Limpar()
     {
         if(Config.Port == null)
@@ -17,6 +27,11 @@ public override void Limpar()
         Reader?.BaseStream.Flush();
     }
 
+    /// <summary>
+    /// Abre a porta serial com as configurações especificadas.
+    /// </summary>
+    /// <returns>Verdadeiro se a porta foi aberta com sucesso, falso caso contrário.</returns>
+    /// <exception cref="InvalidOperationException">Lançada se a porta serial não estiver configurada.</exception>
     protected override bool OpenInternal()
     {
         if(Config.Port == null)
@@ -47,6 +62,11 @@ protected override bool OpenInternal()
         }
     }
 
+    /// <summary>
+    /// Fecha a porta serial e libera os recursos associados.
+    /// </summary>
+    /// <returns>Verdadeiro se a porta foi fechada com sucesso.</returns>
+    /// <exception cref="InvalidOperationException">Lançada se a porta serial não estiver configurada.</exception>
     protected override bool CloseInternal()
     {
         if(Config.Port == null)

src/OpenAC.Net.Devices.Blazor/WebSerial/OpenWebSerialStream.cs

@@ -2,19 +2,43 @@
 
 namespace OpenAC.Net.Devices.Blazor.WebSerial;
 
+/// <summary>
+/// Representa a configuração para comunicação via WebSerial.
+/// </summary>
 public class WebSerialConfig() : BaseConfig("WebSerial")
 {
+    /// <summary>
+    /// Porta serial selecionada.
+    /// </summary>
     public SerialPort? Port { get; set; }
 
+    /// <summary>
+    /// Taxa de transmissão em bauds. Padrão: 9600.
+    /// </summary>
     public int BaudRate { get; set; } = 9600;
 
+    /// <summary>
+    /// Tamanho do buffer de leitura/escrita.
+    /// </summary>
     public int? BufferSize { get; set; }
 
+    /// <summary>
+    /// Número de bits de dados.
+    /// </summary>
     public int? DataBits { get; set; }
 
+    /// <summary>
+    /// Tipo de controle de fluxo.
+    /// </summary>
     public FlowControlType? FlowControl { get; set; }
 
+    /// <summary>
+    /// Tipo de paridade.
+    /// </summary>
     public ParityType? Parity { get; set; }
 
+    /// <summary>
+    /// Número de bits de parada.
+    /// </summary>
     public int? StopBits { get; set; }
 }

src/OpenAC.Net.Devices.Blazor/WebSerial/WebSerialConfig.cs

@@ -3,18 +3,36 @@
 
 namespace OpenAC.Net.Devices.Blazor.WebSerial;
 
+/// <summary>
+/// Implementa um <see cref="Stream"/> de leitura baseado em <see cref="ReadableStream"/> para WebSerial.
+/// </summary>
 public sealed class WebSerialReadStream : Stream
 {
     #region Fields
 
+    /// <summary>
+    /// Stream interno para armazenamento dos dados lidos.
+    /// </summary>
     private readonly MemoryStream readStream = new();
+
+    /// <summary>
+    /// Stream legível de onde os dados são recebidos.
+    /// </summary>
     private readonly ReadableStream readableStream;
+
+    /// <summary>
+    /// Token de cancelamento para controle da leitura assíncrona.
+    /// </summary>
     private readonly CancellationTokenSource cts = new();
 
     #endregion Fields
 
     #region Constructors
 
+    /// <summary>
+    /// Inicializa uma nova instância de <see cref="WebSerialReadStream"/>.
+    /// </summary>
+    /// <param name="readable">O <see cref="ReadableStream"/> de origem.</param>
     public WebSerialReadStream(ReadableStream readable)
     {
         readableStream = readable;
@@ -24,15 +42,20 @@ public WebSerialReadStream(ReadableStream readable)
     #endregion Constructors
 
     #region Properties
-    
+
+    /// <inheritdoc/>
     public override bool CanRead => true;
 
+    /// <inheritdoc/>
     public override bool CanSeek => true;
 
+    /// <inheritdoc/>
     public override bool CanWrite => false;
 
+    /// <inheritdoc/>
     public override long Length => readStream.Length;
 
+    /// <inheritdoc/>
     public override long Position
     {
         get => readStream.Position;
@@ -43,16 +66,24 @@ public override long Position
 
     #region Methods
 
+    /// <inheritdoc/>
     public override long Seek(long offset, SeekOrigin origin) => readStream.Seek(offset, origin);
 
+    /// <inheritdoc/>
     public override void SetLength(long value) => readStream.SetLength(value);
 
+    /// <inheritdoc/>
     public override int Read(byte[] buffer, int offset, int count) => readStream.Read(buffer, offset, count);
 
+    /// <inheritdoc/>
     public override void Write(byte[] buffer, int offset, int count) => throw new NotSupportedException();
 
+    /// <inheritdoc/>
     public override void Flush() => readStream.Clear();
-    
+
+    /// <summary>
+    /// Inicia a leitura assíncrona do <see cref="ReadableStream"/> e armazena os dados no <see cref="readStream"/>.
+    /// </summary>
     private void ReadStream()
     {
         Task.Run(async () =>
@@ -76,7 +107,8 @@ private void ReadStream()
 
         }, cts.Token);
     }
-    
+
+    /// <inheritdoc/>
     protected override void Dispose(bool disposing)
     {
         if (!disposing) return;