From 9fd64de7a48f45a9c6adac0812da9ce17118927f Mon Sep 17 00:00:00 2001
From: ereali-aneo <ereali@aneo.fr>
Date: Fri, 12 Jul 2024 11:12:06 +0200
Subject: [PATCH] docs: add doc in AgentStorage.cs

---
 src/TaskReRunner/Storage/AgentStorage.cs | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/src/TaskReRunner/Storage/AgentStorage.cs b/src/TaskReRunner/Storage/AgentStorage.cs
index 3afa732..98eb2bf 100644
--- a/src/TaskReRunner/Storage/AgentStorage.cs
+++ b/src/TaskReRunner/Storage/AgentStorage.cs
@@ -24,7 +24,20 @@ namespace ArmoniK.TaskReRunner;
 /// </summary>
 internal class AgentStorage
 {
-  public readonly HashSet<string>                        NotifiedResults = new();
-  public          ConcurrentDictionary<string, Result>   Results         = new();
-  public          ConcurrentDictionary<string, TaskData> Tasks           = new();
+  /// <summary>
+  ///   The data obtained through the notified result call. This set contains the IDs of the results that have been notified.
+  /// </summary>
+  public readonly HashSet<string> NotifiedResults = new();
+
+
+  /// <summary>
+  ///   The data obtained through the CreateResult or CreateMetaDataResult call. This dictionary stores results keyed by
+  ///   their unique IDs.
+  /// </summary>
+  public ConcurrentDictionary<string, Result> Results = new();
+
+  /// <summary>
+  ///   The data obtained through the SubmitTask call. This dictionary stores task data keyed by their unique task IDs.
+  /// </summary>
+  public ConcurrentDictionary<string, TaskData> Tasks = new();
 }