From 6158b488a98210d8b420148c7306df90041f715e Mon Sep 17 00:00:00 2001
From: pohky <otoriosu@gmail.com>
Date: Thu, 9 Dec 2021 16:30:43 +0100
Subject: [PATCH] Update AetheryteEntry.cs

---
 .../ClientState/Aetherytes/AetheryteEntry.cs  | 41 ++++++++++++++++++-
 1 file changed, 39 insertions(+), 2 deletions(-)

diff --git a/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs b/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs
index 59e78831f..3020c6ba0 100644
--- a/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs
+++ b/Dalamud/Game/ClientState/Aetherytes/AetheryteEntry.cs
@@ -3,33 +3,70 @@ using FFXIVClientStructs.FFXIV.Client.Game.UI;
 
 namespace Dalamud.Game.ClientState.Aetherytes
 {
-    public class AetheryteEntry
+    /// <summary>
+    /// This class represents an entry in the Aetheryte list.
+    /// </summary>
+    public sealed class AetheryteEntry
     {
         private readonly TeleportInfo data;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AetheryteEntry"/> class.
+        /// </summary>
+        /// <param name="data">Data read from the Aetheryte List.</param>
         internal AetheryteEntry(TeleportInfo data)
         {
             this.data = data;
         }
 
+        /// <summary>
+        ///Gets the Aetheryte ID.
+        /// </summary>
         public uint AetheryteId => this.data.AetheryteId;
 
+        /// <summary>
+        ///Gets the Territory ID.
+        /// </summary>
         public uint TerritoryId => this.data.TerritoryId;
 
+        /// <summary>
+        ///Gets the SubIndex used when there can be multiple Aetherytes with the same ID (Private/Shared Estates etc.).
+        /// </summary>
         public byte SubIndex => this.data.SubIndex;
 
+        /// <summary>
+        ///Gets the Ward. Zero if not a Shared Estate.
+        /// </summary>
         public byte Ward => this.data.Ward;
 
+        /// <summary>
+        ///Gets the Plot. Zero if not a Shared Estate.
+        /// </summary>
         public byte Plot => this.data.Plot;
 
+        /// <summary>
+        ///Gets the Cost in Gil to Teleport to this location.
+        /// </summary>
         public uint GilCost => this.data.GilCost;
 
+        /// <summary>
+        ///Gets if the LocalPlayer has set this Aetheryte as Favorite.
+        /// </summary>
         public bool IsFavourite => this.data.IsFavourite != 0;
-        
+
+        /// <summary>
+        ///Gets if this Aetheryte is a Shared Estate.
+        /// </summary>
         public bool IsSharedHouse => this.data.IsSharedHouse;
 
+        /// <summary>
+        ///Gets if this Aetheryte is an Appartment.
+        /// </summary>
         public bool IsAppartment => this.data.IsAppartment;
 
+        /// <summary>
+        /// Gets the Aetheryte data related to this aetheryte.
+        /// </summary>
         public ExcelResolver<Lumina.Excel.GeneratedSheets.Aetheryte> AetheryteData => new(this.AetheryteId);
     }
 }