Add some comments

Nexus-Mods · Oct 9, 2024 · 3acb22d · 3acb22d
1 parent 4b78e0c
commit 3acb22d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/src/Games/NexusMods.Games.Larian/BaldursGate3/Utils/PakParsing/LspkPackageFormat.cs b/src/Games/NexusMods.Games.Larian/BaldursGate3/Utils/PakParsing/LspkPackageFormat.cs
@@ -2,6 +2,9 @@
 
 namespace NexusMods.Games.Larian.BaldursGate3.Utils.PakParsing;
 
+/// <summary>
+/// Static class containing definitions for the Larian Package (LSPK, `.pak`) format.
+/// </summary>
 public static class LspkPackageFormat
 {
 #region Enums

diff --git a/src/Games/NexusMods.Games.Larian/BaldursGate3/Utils/PakParsing/LsxXmlFormat.cs b/src/Games/NexusMods.Games.Larian/BaldursGate3/Utils/PakParsing/LsxXmlFormat.cs
@@ -3,6 +3,9 @@
 
 namespace NexusMods.Games.Larian.BaldursGate3.Utils.PakParsing;
 
+/// <summary>
+/// Class containing definitions for the Larian Xml (LSX) format.
+/// </summary>
 public static class LsxXmlFormat
 {
 

diff --git a/src/Games/NexusMods.Games.Larian/BaldursGate3/Utils/PakParsing/ModsettingsFileFormat.cs b/src/Games/NexusMods.Games.Larian/BaldursGate3/Utils/PakParsing/ModsettingsFileFormat.cs
@@ -3,6 +3,9 @@
 
 namespace NexusMods.Games.Larian.BaldursGate3.Utils.PakParsing;
 
+/// <summary>
+/// Class to parse and write the `modsettings.lsx` xml file format used for the BG3 Load Order.
+/// </summary>
 public static class ModsettingsFileFormat
 {
     public static string SerializeModsettingsLoadOrder(LsxXmlFormat.ModuleShortDesc[] moduleShortDescs)