From d356e43edb0710d1baa7c942fd874ab9e0d7b950 Mon Sep 17 00:00:00 2001
From: Xjph <archseraphim@gmail.com>
Date: Tue, 23 Nov 2021 19:13:35 -0330
Subject: [PATCH] More xml docs.

---
 ObservatoryFramework/Files/BackPackFile.cs   | 15 +++++++++++++++
 ObservatoryFramework/Files/CargoFile.cs      | 12 ++++++++++++
 ObservatoryFramework/Files/MarketFile.cs     | 18 ++++++++++++++++++
 ObservatoryFramework/Files/ModulesInfo.cs    |  6 ++++++
 ObservatoryFramework/Files/NavRouteFile.cs   |  6 ++++++
 ObservatoryFramework/Files/OutfittingFile.cs | 18 ++++++++++++++++++
 ObservatoryFramework/Files/ShipyardFile.cs   |  4 ++--
 7 files changed, 77 insertions(+), 2 deletions(-)

diff --git a/ObservatoryFramework/Files/BackPackFile.cs b/ObservatoryFramework/Files/BackPackFile.cs
index 6ab7b74..79f2385 100644
--- a/ObservatoryFramework/Files/BackPackFile.cs
+++ b/ObservatoryFramework/Files/BackPackFile.cs
@@ -3,11 +3,26 @@ using System.Collections.Immutable;
 
 namespace Observatory.Framework.Files.Journal
 {
+    /// <summary>
+    /// Elite Dangerous backpack.json file. Describes all the items currently carried by the player.
+    /// </summary>
     public class BackpackFile : JournalBase
     {
+        /// <summary>
+        /// List of all items carried.
+        /// </summary>
         public ImmutableList<BackpackItem> Items { get; init; }
+        /// <summary>
+        /// List of all components carried.
+        /// </summary>
         public ImmutableList<BackpackItem> Components { get; init; }
+        /// <summary>
+        /// List of player consumable items carried.
+        /// </summary>
         public ImmutableList<BackpackItem> Consumables { get; init; }
+        /// <summary>
+        /// List of all data currently stored by the player.
+        /// </summary>
         public ImmutableList<BackpackItem> Data { get; init; }
     }
 }
diff --git a/ObservatoryFramework/Files/CargoFile.cs b/ObservatoryFramework/Files/CargoFile.cs
index 5a73886..361bd45 100644
--- a/ObservatoryFramework/Files/CargoFile.cs
+++ b/ObservatoryFramework/Files/CargoFile.cs
@@ -3,10 +3,22 @@ using System.Collections.Immutable;
 
 namespace Observatory.Framework.Files
 {
+    /// <summary>
+    /// Elite Dangerous cargo.json file. Describes the current cargo carried above the player's ship.
+    /// </summary>
     public class CargoFile : Journal.JournalBase
     {
+        /// <summary>
+        /// Type of vehicle currently being reported. "Ship" or "SRV".
+        /// </summary>
         public string Vessel { get; init; }
+        /// <summary>
+        /// Number of different types of cargo carried(?)
+        /// </summary>
         public int Count { get; init; }
+        /// <summary>
+        /// List of full cargo details.
+        /// </summary>
         public ImmutableList<CargoType> Inventory { get; init; }
     }
 }
diff --git a/ObservatoryFramework/Files/MarketFile.cs b/ObservatoryFramework/Files/MarketFile.cs
index 699a0d3..fb22d0b 100644
--- a/ObservatoryFramework/Files/MarketFile.cs
+++ b/ObservatoryFramework/Files/MarketFile.cs
@@ -3,12 +3,30 @@ using System.Collections.Immutable;
 
 namespace Observatory.Framework.Files
 {
+    /// <summary>
+    /// Elite Dangerous market.json file. Contains details about all available commodities available at the current station.
+    /// </summary>
     public class MarketFile : Journal.JournalBase
     {
+        /// <summary>
+        /// Unique ID of current market.
+        /// </summary>
         public long MarketID { get; init; }
+        /// <summary>
+        /// Name of the station where the market is located.
+        /// </summary>
         public string StationName { get; init; }
+        /// <summary>
+        /// Type of station where the market is located.
+        /// </summary>
         public string StationType { get; init; }
+        /// <summary>
+        /// Name of star system where the market is located.
+        /// </summary>
         public string StarSystem { get; init; }
+        /// <summary>
+        /// List of all commodities available in the market.
+        /// </summary>
         public ImmutableList<MarketItem> Items { get; init; }
     }
 }
diff --git a/ObservatoryFramework/Files/ModulesInfo.cs b/ObservatoryFramework/Files/ModulesInfo.cs
index 074202a..16dc11c 100644
--- a/ObservatoryFramework/Files/ModulesInfo.cs
+++ b/ObservatoryFramework/Files/ModulesInfo.cs
@@ -3,8 +3,14 @@ using System.Collections.Immutable;
 
 namespace Observatory.Framework.Files
 {
+    /// <summary>
+    /// Information about current player ship equipped modules.
+    /// </summary>
     public class ModulesInfo : Journal.JournalBase
     {
+        /// <summary>
+        /// List of all equipped modules.
+        /// </summary>
         public ImmutableList<Module> Modules { get; init; }
     }
 }
diff --git a/ObservatoryFramework/Files/NavRouteFile.cs b/ObservatoryFramework/Files/NavRouteFile.cs
index d32ee1d..7918788 100644
--- a/ObservatoryFramework/Files/NavRouteFile.cs
+++ b/ObservatoryFramework/Files/NavRouteFile.cs
@@ -3,8 +3,14 @@ using System.Collections.Immutable;
 
 namespace Observatory.Framework.Files
 {
+    /// <summary>
+    /// Elite Dangerous navroute.json file. Contains data about currently plotted FSD jump route.
+    /// </summary>
     public class NavRouteFile : Journal.JournalBase
     {
+        /// <summary>
+        /// List of star systems and their locations in the current route.
+        /// </summary>
         public ImmutableList<Route> Route { get; init; }
     }
 }
diff --git a/ObservatoryFramework/Files/OutfittingFile.cs b/ObservatoryFramework/Files/OutfittingFile.cs
index ba355ff..40600c2 100644
--- a/ObservatoryFramework/Files/OutfittingFile.cs
+++ b/ObservatoryFramework/Files/OutfittingFile.cs
@@ -3,12 +3,30 @@ using System.Collections.Immutable;
 
 namespace Observatory.Framework.Files
 {
+    /// <summary>
+    /// Elite Dangerous outfitting.json file. Contains data about ship modules available for purchase at the current station.
+    /// </summary>
     public class OutfittingFile : Journal.JournalBase
     {
+        /// <summary>
+        /// Unique ID of current market.
+        /// </summary>
         public long MarketID { get; init; }
+        /// <summary>
+        /// Name of the station where the market is located.
+        /// </summary>
         public string StationName { get; init; }
+        /// <summary>
+        /// Name of the star system where the market is located.
+        /// </summary>
         public string StarSystem { get; init; }
+        /// <summary>
+        /// Indicator if the player has access to Horizons content.
+        /// </summary>
         public bool Horizons { get; init; }
+        /// <summary>
+        /// List of all available parts in shipyard.
+        /// </summary>
         public ImmutableList<OutfittingModule> Items { get; init; }
     }
 }
diff --git a/ObservatoryFramework/Files/ShipyardFile.cs b/ObservatoryFramework/Files/ShipyardFile.cs
index bd3ab51..547fe2c 100644
--- a/ObservatoryFramework/Files/ShipyardFile.cs
+++ b/ObservatoryFramework/Files/ShipyardFile.cs
@@ -4,12 +4,12 @@ using System.Collections.Immutable;
 namespace Observatory.Framework.Files
 {
     /// <summary>
-    /// Elite Dangerous shipyard.json file.
+    /// Elite Dangerous shipyard.json file. Contains data about ships available for purchase at the current station.
     /// </summary>
     public class ShipyardFile : Journal.JournalBase
     {
         /// <summary>
-        /// Unique ID of market.
+        /// Unique ID of current market.
         /// </summary>
         public ulong MarketID { get; init; }
         /// <summary>