M src/PacketLogger/App.axaml.cs => src/PacketLogger/App.axaml.cs +3 -0
@@ 13,6 13,9 @@ using PropertyChanged;
namespace PacketLogger;
+/// <summary>
+/// The application.
+/// </summary>
[DoNotNotify]
public partial class App : Application
{
M src/PacketLogger/Models/Packets/ClientPacketProvider.cs => src/PacketLogger/Models/Packets/ClientPacketProvider.cs +0 -4
@@ 50,9 50,6 @@ public abstract class ClientPacketProvider : ReactiveObject, IPacketProvider
}
/// <inheritdoc />
- public event PropertyChangedEventHandler? PropertyChanged;
-
- /// <inheritdoc />
public string Name => (_process.BrowserManager.IsInGame
? _process.BrowserManager.PlayerManager.Player.Name
: null) ?? $"Not in game ({_process.Process.Id})";
@@ 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);
M src/PacketLogger/Models/Packets/CommsPacketProvider.cs => src/PacketLogger/Models/Packets/CommsPacketProvider.cs +0 -1
@@ 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.
M src/PacketLogger/Models/Packets/PacketInfo.cs => src/PacketLogger/Models/Packets/PacketInfo.cs +7 -0
@@ 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
M src/PacketLogger/Views/DocumentView.axaml.cs => src/PacketLogger/Views/DocumentView.axaml.cs +3 -0
@@ 11,6 11,9 @@ using PropertyChanged;
namespace PacketLogger.Views;
+/// <summary>
+/// A view of document tab.
+/// </summary>
[DoNotNotify]
public partial class DocumentView : UserControl
{
M src/PacketLogger/Views/Filters/FilterChooseView.axaml.cs => src/PacketLogger/Views/Filters/FilterChooseView.axaml.cs +3 -0
@@ 10,6 10,9 @@ using PropertyChanged;
namespace PacketLogger.Views.Filters;
+/// <summary>
+/// A view supporting choosing a filter.
+/// </summary>
[DoNotNotify]
public partial class FilterChooseView : UserControl
{
M src/PacketLogger/Views/Filters/FilterConfigView.axaml.cs => src/PacketLogger/Views/Filters/FilterConfigView.axaml.cs +3 -0
@@ 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
{
M src/PacketLogger/Views/Filters/FilterEntryView.axaml.cs => src/PacketLogger/Views/Filters/FilterEntryView.axaml.cs +3 -0
@@ 13,6 13,9 @@ using PropertyChanged;
namespace PacketLogger.Views.Filters;
+/// <summary>
+/// A view for modifying filter entry.
+/// </summary>
[DoNotNotify]
public partial class FilterEntryView : UserControl
{
M src/PacketLogger/Views/HostWindow.axaml.cs => src/PacketLogger/Views/HostWindow.axaml.cs +3 -0
@@ 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
{
M src/PacketLogger/Views/Log/PacketLogView.axaml.cs => src/PacketLogger/Views/Log/PacketLogView.axaml.cs +3 -0
@@ 11,6 11,9 @@ using PropertyChanged;
namespace PacketLogger.Views.Log;
+/// <summary>
+/// A view of a packet log.
+/// </summary>
[DoNotNotify]
public partial class PacketLogView : UserControl
{
M src/PacketLogger/Views/MainWindow.axaml.cs => src/PacketLogger/Views/MainWindow.axaml.cs +3 -0
@@ 9,6 9,9 @@ using PropertyChanged;
namespace PacketLogger.Views;
+/// <summary>
+/// The main window.
+/// </summary>
[DoNotNotify]
public partial class MainWindow : Window
{
M src/PacketLogger/Views/Sender/PacketSendSubView.axaml.cs => src/PacketLogger/Views/Sender/PacketSendSubView.axaml.cs +3 -0
@@ 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
{
M src/PacketLogger/Views/Sender/PacketSenderView.axaml.cs => src/PacketLogger/Views/Sender/PacketSenderView.axaml.cs +3 -0
@@ 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
{
M src/PacketLogger/Views/Settings/FilterSettingsView.axaml.cs => src/PacketLogger/Views/Settings/FilterSettingsView.axaml.cs +3 -0
@@ 11,6 11,9 @@ using PropertyChanged;
namespace PacketLogger.Views.Settings;
+/// <summary>
+/// A view for configuring filter profiles.
+/// </summary>
[DoNotNotify]
public partial class FilterSettingsView : UserControl
{
M src/PacketLogger/Views/Settings/SettingsView.axaml.cs => src/PacketLogger/Views/Settings/SettingsView.axaml.cs +3 -0
@@ 10,6 10,9 @@ using PropertyChanged;
namespace PacketLogger.Views.Settings;
+/// <summary>
+/// A view for configuration.
+/// </summary>
[DoNotNotify]
public partial class SettingsView : UserControl
{