From c62bcb11f41bc840b7dd290446c010ada11a9c64 Mon Sep 17 00:00:00 2001
From: Thorsten Sommer <mail@tsommer.org>
Date: Sun, 5 Jan 2025 16:14:41 +0100
Subject: [PATCH] Added documentation to data source types

---
 .../Settings/DataModel/DataSourceType.cs         | 16 ++++++++++++++++
 .../DataModel/DataSourceTypeExtension.cs         |  8 ++++++++
 2 files changed, 24 insertions(+)

diff --git a/app/MindWork AI Studio/Settings/DataModel/DataSourceType.cs b/app/MindWork AI Studio/Settings/DataModel/DataSourceType.cs
index beecc5d1..76556a82 100644
--- a/app/MindWork AI Studio/Settings/DataModel/DataSourceType.cs	
+++ b/app/MindWork AI Studio/Settings/DataModel/DataSourceType.cs	
@@ -1,11 +1,27 @@
 namespace AIStudio.Settings.DataModel;
 
+/// <summary>
+/// AI Studio data source types.
+/// </summary>
 public enum DataSourceType
 {
+    /// <summary>
+    /// No data source.
+    /// </summary>
     NONE = 0,
     
+    /// <summary>
+    /// One file on the local machine (or a network share).
+    /// </summary>
     LOCAL_FILE,
+    
+    /// <summary>
+    /// A directory on the local machine (or a network share).
+    /// </summary>
     LOCAL_DIRECTORY,
     
+    /// <summary>
+    /// External data source accessed via an ERI server, cf. https://github.com/MindWorkAI/ERI.   
+    /// </summary>
     ERI,
 }
\ No newline at end of file
diff --git a/app/MindWork AI Studio/Settings/DataModel/DataSourceTypeExtension.cs b/app/MindWork AI Studio/Settings/DataModel/DataSourceTypeExtension.cs
index e10d060c..ce25424b 100644
--- a/app/MindWork AI Studio/Settings/DataModel/DataSourceTypeExtension.cs	
+++ b/app/MindWork AI Studio/Settings/DataModel/DataSourceTypeExtension.cs	
@@ -1,7 +1,15 @@
 namespace AIStudio.Settings.DataModel;
 
+/// <summary>
+/// Extension methods for data source types.
+/// </summary>
 public static class DataSourceTypeExtension
 {
+    /// <summary>
+    /// Get the display name of the data source type.
+    /// </summary>
+    /// <param name="type">The data source type.</param>
+    /// <returns>The display name of the data source type.</returns>
     public static string GetDisplayName(this DataSourceType type)
     {
         return type switch