From 302128623bf84abd788dcebdf74135261115a220 Mon Sep 17 00:00:00 2001
From: Rutherther <fandabohacek@gmail.com>
Date: Sat, 11 Feb 2023 18:13:39 +0100
Subject: [PATCH] docs(pcap): add documentation to pcap records

---
 Pcap/NosSmooth.Pcap/ConnectionData.cs | 9 +++++++++
 Pcap/NosSmooth.Pcap/TcpConnection.cs  | 7 +++++++
 2 files changed, 16 insertions(+)

diff --git a/Pcap/NosSmooth.Pcap/ConnectionData.cs b/Pcap/NosSmooth.Pcap/ConnectionData.cs
index 1a81c76..b5de4d4 100644
--- a/Pcap/NosSmooth.Pcap/ConnectionData.cs
+++ b/Pcap/NosSmooth.Pcap/ConnectionData.cs
@@ -8,6 +8,15 @@ using System.Net;
 
 namespace NosSmooth.Pcap;
 
+/// <summary>
+/// Data from a tcp connection containing first few sniffed packets.
+/// </summary>
+/// <param name="SourceAddress">The packets source address.</param>
+/// <param name="SourcePort">The packets source port.</param>
+/// <param name="DestinationAddress">The packets destination address.</param>
+/// <param name="DestinationPort">The packets destination port.</param>
+/// <param name="SniffedData">The sniffed data.</param>
+/// <param name="FirstObservedAt">The time first data were observed at.</param>
 public record ConnectionData
 (
     IPAddress SourceAddress,
diff --git a/Pcap/NosSmooth.Pcap/TcpConnection.cs b/Pcap/NosSmooth.Pcap/TcpConnection.cs
index 1f3414b..048dbf1 100644
--- a/Pcap/NosSmooth.Pcap/TcpConnection.cs
+++ b/Pcap/NosSmooth.Pcap/TcpConnection.cs
@@ -9,6 +9,13 @@ using System.Diagnostics.CodeAnalysis;
 
 namespace NosSmooth.Pcap;
 
+/// <summary>
+/// A tcp connection.
+/// </summary>
+/// <param name="LocalAddr">The local address.</param>
+/// <param name="LocalPort">The local port.</param>
+/// <param name="RemoteAddr">The remote address.</param>
+/// <param name="RemotePort">The remote port.</param>
 [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1313:Parameter names should begin with lower-case letter", Justification = "Fix this.")]
 public record struct TcpConnection
 (
-- 
2.49.0