From f7628210876d259335902cc947ec54bec150513a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?=
 <fandabohacek@gmail.com>
Date: Sat, 1 Jan 2022 23:06:59 +0100
Subject: [PATCH] chore: add documentation for packets say, in player, cinfo

---
 .../Packets/Client/Chat/SayPacket.cs          |  4 ++
 .../Server/Entities/InPlayerSubPacket.cs      | 37 +++++++++++++++++++
 .../Packets/Server/Players/CInfoPacket.cs     |  3 ++
 3 files changed, 44 insertions(+)

diff --git a/Core/NosSmooth.Packets/Packets/Client/Chat/SayPacket.cs b/Core/NosSmooth.Packets/Packets/Client/Chat/SayPacket.cs
index b41106695becb137507e2a6c39c69bb3461470b2..8ff35e1c39ed81f27b37b46b90e60fb2d64dd58f 100644
--- a/Core/NosSmooth.Packets/Packets/Client/Chat/SayPacket.cs
+++ b/Core/NosSmooth.Packets/Packets/Client/Chat/SayPacket.cs
@@ -8,6 +8,10 @@ using NosSmooth.Packets.Attributes;
 
 namespace NosSmooth.Packets.Packets.Client.Chat;
 
+/// <summary>
+/// Sends a message to the map chat.
+/// </summary>
+/// <param name="Message">The message to send.</param>
 [PacketHeader("say", PacketSource.Client)]
 [GenerateSerializer(true)]
 public record SayPacket
diff --git a/Core/NosSmooth.Packets/Packets/Server/Entities/InPlayerSubPacket.cs b/Core/NosSmooth.Packets/Packets/Server/Entities/InPlayerSubPacket.cs
index f98d7644ae3856cd17bc595064d7385a8dbfc9bd..d46d60428ec2a3a0c68aa0cdf929b29f15748fed 100644
--- a/Core/NosSmooth.Packets/Packets/Server/Entities/InPlayerSubPacket.cs
+++ b/Core/NosSmooth.Packets/Packets/Server/Entities/InPlayerSubPacket.cs
@@ -13,6 +13,43 @@ using NosSmooth.Packets.Packets.Server.Weapons;
 
 namespace NosSmooth.Packets.Packets.Server.Entities;
 
+/// <summary>
+/// Sub packet for <see cref="InPacket"/>
+/// sent for players.
+/// </summary>
+/// <param name="Authority">The authority of the player.</param>
+/// <param name="Sex">The sex of the player.</param>
+/// <param name="HairStyle">The hair style of the player.</param>
+/// <param name="HairColor">The hair color of the player.</param>
+/// <param name="Class">The class of the player.</param>
+/// <param name="Equipment">The equipment sub packet of the player containing vnums of his equipment data.</param>
+/// <param name="HpPercentage">The percentage of hp.</param>
+/// <param name="MpPercentage">The percentage of mp.</param>
+/// <param name="IsSitting">Whether the player is sitting.</param>
+/// <param name="GroupId">What group does the player belong to.</param>
+/// <param name="Fairy">The vnum of the fairy the player has.</param>
+/// <param name="FairyElement">The element of the fairy.</param>
+/// <param name="Unknown">Unknown TODO.</param>
+/// <param name="MorphVNum">The vnum of the morph (used for special cards and such).</param>
+/// <param name="Unknown2">Unknown TODO</param>
+/// <param name="Unknown3">Unknown TODO</param>
+/// <param name="WeaponUpgradeRareSubPacket">Weapon upgrade and rare sub packet.</param>
+/// <param name="ArmorUpgradeRareSubPacket">Armor upgrade and rare sub packet.</param>
+/// <param name="FamilySubPacket">Family information sub packet.</param>
+/// <param name="FamilyName">The name of the family.</param>
+/// <param name="ReputationIcon">The reputation icon number.</param>
+/// <param name="IsInvisible">Whether the player is invisible.</param>
+/// <param name="MorphUpgrade">The upgrade of the morph. (wings)</param>
+/// <param name="Faction">The faction the player belongs to.</param>
+/// <param name="MorphUpgrade2">Unknown TODO.</param>
+/// <param name="Level">The level of the player.</param>
+/// <param name="FamilyLevel">The level of the family the player belongs to.</param>
+/// <param name="FamilyIcons">The family icons list.</param>
+/// <param name="ArenaWinner">Whether the player is an arena winner.</param>
+/// <param name="Compliment">Unknown TODO</param>
+/// <param name="Size">The size of the player.</param>
+/// <param name="HeroLevel">The hero level of the player.</param>
+/// <param name="Title">The title of the player.</param>
 [PacketHeader(null, PacketSource.Server)]
 [GenerateSerializer(true)]
 public record InPlayerSubPacket
diff --git a/Core/NosSmooth.Packets/Packets/Server/Players/CInfoPacket.cs b/Core/NosSmooth.Packets/Packets/Server/Players/CInfoPacket.cs
index b4357291ea5271f11943c610804580254e9a20ae..2d7d209a14b9962980f6489875c2d914cfa6ac7f 100644
--- a/Core/NosSmooth.Packets/Packets/Server/Players/CInfoPacket.cs
+++ b/Core/NosSmooth.Packets/Packets/Server/Players/CInfoPacket.cs
@@ -8,6 +8,9 @@ using NosSmooth.Packets.Attributes;
 
 namespace NosSmooth.Packets.Packets.Server.Players;
 
+/// <summary>
+/// Character information.
+/// </summary>
 // [PacketHeader()]
 // [GenerateSerializer(true)]
 public record CInfoPacket();
\ No newline at end of file