From 82a2a8f097a55234d3c0574cc6165f4db78e87f9 Mon Sep 17 00:00:00 2001
From: Rutherther <fandabohacek@gmail.com>
Date: Sun, 12 Feb 2023 09:40:36 +0100
Subject: [PATCH] docs: add missing documentation

---
 src/PacketLogger/App.axaml.cs                              | 3 +++
 src/PacketLogger/Models/Packets/ClientPacketProvider.cs    | 4 ----
 src/PacketLogger/Models/Packets/CommsPacketProvider.cs     | 1 -
 src/PacketLogger/Models/Packets/PacketInfo.cs              | 7 +++++++
 src/PacketLogger/Views/DocumentView.axaml.cs               | 3 +++
 src/PacketLogger/Views/Filters/FilterChooseView.axaml.cs   | 3 +++
 src/PacketLogger/Views/Filters/FilterConfigView.axaml.cs   | 3 +++
 src/PacketLogger/Views/Filters/FilterEntryView.axaml.cs    | 3 +++
 src/PacketLogger/Views/HostWindow.axaml.cs                 | 3 +++
 src/PacketLogger/Views/Log/PacketLogView.axaml.cs          | 3 +++
 src/PacketLogger/Views/MainWindow.axaml.cs                 | 3 +++
 src/PacketLogger/Views/Sender/PacketSendSubView.axaml.cs   | 3 +++
 src/PacketLogger/Views/Sender/PacketSenderView.axaml.cs    | 3 +++
 .../Views/Settings/FilterSettingsView.axaml.cs             | 3 +++
 src/PacketLogger/Views/Settings/SettingsView.axaml.cs      | 3 +++
 15 files changed, 43 insertions(+), 5 deletions(-)

diff --git a/src/PacketLogger/App.axaml.cs b/src/PacketLogger/App.axaml.cs
index f9833fdaf728fec88bfa478833f7c0dd5730d89f..a08f7b4ace8695a221f09e71f1c001cb01cf93e5 100644
--- a/src/PacketLogger/App.axaml.cs
+++ b/src/PacketLogger/App.axaml.cs
@@ -13,6 +13,9 @@ using PropertyChanged;
 
 namespace PacketLogger;
 
+/// <summary>
+/// The application.
+/// </summary>
 [DoNotNotify]
 public partial class App : Application
 {
diff --git a/src/PacketLogger/Models/Packets/ClientPacketProvider.cs b/src/PacketLogger/Models/Packets/ClientPacketProvider.cs
index c1bd4a029891ac6acb86c129e04507252a0c6572..e182aadc30240e5f778a5d178bd6243c78830d0f 100644
--- a/src/PacketLogger/Models/Packets/ClientPacketProvider.cs
+++ b/src/PacketLogger/Models/Packets/ClientPacketProvider.cs
@@ -49,9 +49,6 @@ public abstract class ClientPacketProvider : ReactiveObject, IPacketProvider
             );
     }
 
-    /// <inheritdoc />
-    public event PropertyChangedEventHandler? PropertyChanged;
-
     /// <inheritdoc />
     public string Name => (_process.BrowserManager.IsInGame
         ? _process.BrowserManager.PlayerManager.Player.Name
@@ -106,7 +103,6 @@ public abstract class ClientPacketProvider : ReactiveObject, IPacketProvider
     /// Add the given packets from an event.
     /// </summary>
     /// <param name="packetArgs">The packet event args.</param>
-    /// <typeparam name="TPacket">The type of the deserialized packet.</typeparam>
     internal void AddPacket(PacketEventArgs packetArgs)
     {
         var index = Interlocked.Increment(ref _currentIndex);
diff --git a/src/PacketLogger/Models/Packets/CommsPacketProvider.cs b/src/PacketLogger/Models/Packets/CommsPacketProvider.cs
index 75380eabdcb4d4475ee3afc91501e802c702f295..4e15d00ce0738caaebc0a3e1e0e323374af3846f 100644
--- a/src/PacketLogger/Models/Packets/CommsPacketProvider.cs
+++ b/src/PacketLogger/Models/Packets/CommsPacketProvider.cs
@@ -25,7 +25,6 @@ namespace PacketLogger.Models.Packets;
 public class CommsPacketProvider : ClientPacketProvider
 {
     private readonly Comms _comms;
-    private long _currentIndex;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="CommsPacketProvider"/> class.
diff --git a/src/PacketLogger/Models/Packets/PacketInfo.cs b/src/PacketLogger/Models/Packets/PacketInfo.cs
index 9833d0c4724de486c0ea643ff402a2114862e20a..cf3d0a41709608909fb6981eedabee5f9d96b526 100644
--- a/src/PacketLogger/Models/Packets/PacketInfo.cs
+++ b/src/PacketLogger/Models/Packets/PacketInfo.cs
@@ -10,5 +10,12 @@ using NosSmooth.PacketSerializer.Abstractions.Attributes;
 
 namespace PacketLogger.Models.Packets;
 
+/// <summary>
+/// Information about a received or sent packet.
+/// </summary>
+/// <param name="PacketIndex">The index of the packet used for sorting.</param>
+/// <param name="Date">The time the packet was received at.</param>
+/// <param name="Source">The source of the packet.</param>
+/// <param name="PacketString">The packet.</param>
 [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1313:Parameter names should begin with lower-case letter", Justification = "Fix this.")]
 public record struct PacketInfo(long PacketIndex, DateTime Date, PacketSource Source, string PacketString);
\ No newline at end of file
diff --git a/src/PacketLogger/Views/DocumentView.axaml.cs b/src/PacketLogger/Views/DocumentView.axaml.cs
index 2c7fbfc47024e3648c479543e746f3bf52fcc270..d771fd15b36a43781025a1767ca91bd0a7c224d2 100644
--- a/src/PacketLogger/Views/DocumentView.axaml.cs
+++ b/src/PacketLogger/Views/DocumentView.axaml.cs
@@ -11,6 +11,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views;
 
+/// <summary>
+/// A view of document tab.
+/// </summary>
 [DoNotNotify]
 public partial class DocumentView : UserControl
 {
diff --git a/src/PacketLogger/Views/Filters/FilterChooseView.axaml.cs b/src/PacketLogger/Views/Filters/FilterChooseView.axaml.cs
index 10c6416ad0f9dcd707d8a2856928b3297dea743c..ac2e2f2a684cd7413ef5dc6c45777757c4439f44 100644
--- a/src/PacketLogger/Views/Filters/FilterChooseView.axaml.cs
+++ b/src/PacketLogger/Views/Filters/FilterChooseView.axaml.cs
@@ -10,6 +10,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Filters;
 
+/// <summary>
+/// A view supporting choosing a filter.
+/// </summary>
 [DoNotNotify]
 public partial class FilterChooseView : UserControl
 {
diff --git a/src/PacketLogger/Views/Filters/FilterConfigView.axaml.cs b/src/PacketLogger/Views/Filters/FilterConfigView.axaml.cs
index def4d15884b3e24ae78575473ce506d0acc095f8..916aa4a8eafb277ec26b7567b6aa81ebb734f6a9 100644
--- a/src/PacketLogger/Views/Filters/FilterConfigView.axaml.cs
+++ b/src/PacketLogger/Views/Filters/FilterConfigView.axaml.cs
@@ -10,6 +10,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Filters;
 
+/// <summary>
+/// A view for configuring a filter profile.
+/// </summary>
 [DoNotNotify]
 public partial class FilterConfigView : UserControl
 {
diff --git a/src/PacketLogger/Views/Filters/FilterEntryView.axaml.cs b/src/PacketLogger/Views/Filters/FilterEntryView.axaml.cs
index d3167602277aed94299a3fa83cf55d975d7ad3a5..65cd8b4109d4ef4b759edefb67ad0f7ba8017d9f 100644
--- a/src/PacketLogger/Views/Filters/FilterEntryView.axaml.cs
+++ b/src/PacketLogger/Views/Filters/FilterEntryView.axaml.cs
@@ -13,6 +13,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Filters;
 
+/// <summary>
+/// A view for modifying filter entry.
+/// </summary>
 [DoNotNotify]
 public partial class FilterEntryView : UserControl
 {
diff --git a/src/PacketLogger/Views/HostWindow.axaml.cs b/src/PacketLogger/Views/HostWindow.axaml.cs
index dda718f3e9726e6dbf4fc4978e9c00b4352f234a..8a8b975366eaec4764fbf16131bdf4cc833b3b81 100644
--- a/src/PacketLogger/Views/HostWindow.axaml.cs
+++ b/src/PacketLogger/Views/HostWindow.axaml.cs
@@ -11,6 +11,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views;
 
+/// <summary>
+/// A floating window styled same as main window.
+/// </summary>
 [DoNotNotify]
 public partial class HostWindow : Dock.Avalonia.Controls.HostWindow
 {
diff --git a/src/PacketLogger/Views/Log/PacketLogView.axaml.cs b/src/PacketLogger/Views/Log/PacketLogView.axaml.cs
index 14d2c0704914d34181693e1a55dc0afc634db9d6..6dec45d3e0764d0546a75901a75e01293ed7ddef 100644
--- a/src/PacketLogger/Views/Log/PacketLogView.axaml.cs
+++ b/src/PacketLogger/Views/Log/PacketLogView.axaml.cs
@@ -11,6 +11,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Log;
 
+/// <summary>
+/// A view of a packet log.
+/// </summary>
 [DoNotNotify]
 public partial class PacketLogView : UserControl
 {
diff --git a/src/PacketLogger/Views/MainWindow.axaml.cs b/src/PacketLogger/Views/MainWindow.axaml.cs
index ca9414578ed6c27cb64d5dc68b0e5702511ba1a9..4418f9dc9166c78e8a92c1241f5a6245b81aa535 100644
--- a/src/PacketLogger/Views/MainWindow.axaml.cs
+++ b/src/PacketLogger/Views/MainWindow.axaml.cs
@@ -9,6 +9,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views;
 
+/// <summary>
+/// The main window.
+/// </summary>
 [DoNotNotify]
 public partial class MainWindow : Window
 {
diff --git a/src/PacketLogger/Views/Sender/PacketSendSubView.axaml.cs b/src/PacketLogger/Views/Sender/PacketSendSubView.axaml.cs
index c6f21dc6539f0f0c8d2491247a2e60c0ab12ab9a..62d4e8e969f54ad040f642f4b5e11936e519c76a 100644
--- a/src/PacketLogger/Views/Sender/PacketSendSubView.axaml.cs
+++ b/src/PacketLogger/Views/Sender/PacketSendSubView.axaml.cs
@@ -10,6 +10,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Sender;
 
+/// <summary>
+/// A view for sending packets inside of <see cref="PacketSenderView"/>.
+/// </summary>
 [DoNotNotify]
 public partial class PacketSendSubView : UserControl
 {
diff --git a/src/PacketLogger/Views/Sender/PacketSenderView.axaml.cs b/src/PacketLogger/Views/Sender/PacketSenderView.axaml.cs
index a784ee9844b04f364913ee3fffa47d93f6168bec..7576b33b3262c7cc8587a99461d65f1b901d0a4a 100644
--- a/src/PacketLogger/Views/Sender/PacketSenderView.axaml.cs
+++ b/src/PacketLogger/Views/Sender/PacketSenderView.axaml.cs
@@ -10,6 +10,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Sender;
 
+/// <summary>
+/// A view used for sending and receiving packets.
+/// </summary>
 [DoNotNotify]
 public partial class PacketSenderView : UserControl
 {
diff --git a/src/PacketLogger/Views/Settings/FilterSettingsView.axaml.cs b/src/PacketLogger/Views/Settings/FilterSettingsView.axaml.cs
index 83d1c50260e0c0d298899b485b5fbaac7b957291..fdba45fad9ff31b128fe4831347ac124d955c69d 100644
--- a/src/PacketLogger/Views/Settings/FilterSettingsView.axaml.cs
+++ b/src/PacketLogger/Views/Settings/FilterSettingsView.axaml.cs
@@ -11,6 +11,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Settings;
 
+/// <summary>
+/// A view for configuring filter profiles.
+/// </summary>
 [DoNotNotify]
 public partial class FilterSettingsView : UserControl
 {
diff --git a/src/PacketLogger/Views/Settings/SettingsView.axaml.cs b/src/PacketLogger/Views/Settings/SettingsView.axaml.cs
index 9ceca1cb429dce9015681054da6f58d86181efe7..cd2f4766c0d5d0e14a719faca35ef61c9f459271 100644
--- a/src/PacketLogger/Views/Settings/SettingsView.axaml.cs
+++ b/src/PacketLogger/Views/Settings/SettingsView.axaml.cs
@@ -10,6 +10,9 @@ using PropertyChanged;
 
 namespace PacketLogger.Views.Settings;
 
+/// <summary>
+/// A view for configuration.
+/// </summary>
 [DoNotNotify]
 public partial class SettingsView : UserControl
 {