From 5c4103f859ee720dbf25b9bdea6f5fab43dbb3c7 Mon Sep 17 00:00:00 2001
From: Thorsten Sommer <mail@tsommer.org>
Date: Wed, 29 Jan 2025 07:29:25 +0100
Subject: [PATCH] Optimized documentation

---
 .../Settings/DataModel/DataSourceERI_V1.cs       | 16 ++++------------
 .../Settings/IERIDataSource.cs                   | 14 ++++++++++++++
 2 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/app/MindWork AI Studio/Settings/DataModel/DataSourceERI_V1.cs b/app/MindWork AI Studio/Settings/DataModel/DataSourceERI_V1.cs
index acf49ec..addec25 100644
--- a/app/MindWork AI Studio/Settings/DataModel/DataSourceERI_V1.cs	
+++ b/app/MindWork AI Studio/Settings/DataModel/DataSourceERI_V1.cs	
@@ -25,23 +25,15 @@ public readonly record struct DataSourceERI_V1 : IERIDataSource
     /// <inheritdoc />
     public DataSourceType Type { get; init; } = DataSourceType.NONE;
     
-    /// <summary>
-    /// The hostname of the ERI server.
-    /// </summary>
+    /// <inheritdoc />
     public string Hostname { get; init; } = string.Empty;
     
-    /// <summary>
-    /// The port of the ERI server.
-    /// </summary>
+    /// <inheritdoc />
     public int Port { get; init; }
 
-    /// <summary>
-    /// The authentication method to use.
-    /// </summary>
+    /// <inheritdoc />
     public AuthMethod AuthMethod { get; init; } = AuthMethod.NONE;
 
-    /// <summary>
-    /// The username to use for authentication, when the auth. method is USERNAME_PASSWORD.
-    /// </summary>
+    /// <inheritdoc />
     public string Username { get; init; } = string.Empty;
 }
\ No newline at end of file
diff --git a/app/MindWork AI Studio/Settings/IERIDataSource.cs b/app/MindWork AI Studio/Settings/IERIDataSource.cs
index 42cd3f7..0d917d1 100644
--- a/app/MindWork AI Studio/Settings/IERIDataSource.cs	
+++ b/app/MindWork AI Studio/Settings/IERIDataSource.cs	
@@ -4,9 +4,23 @@ namespace AIStudio.Settings;
 
 public interface IERIDataSource : IExternalDataSource
 {
+    /// <summary>
+    /// The hostname of the ERI server.
+    /// </summary>
     public string Hostname { get; init; }
     
+    /// <summary>
+    /// The port of the ERI server.
+    /// </summary>
     public int Port { get; init; }
     
+    /// <summary>
+    /// The authentication method to use.
+    /// </summary>
     public AuthMethod AuthMethod { get; init; }
+    
+    /// <summary>
+    /// The username to use for authentication, when the auth. method is USERNAME_PASSWORD.
+    /// </summary>
+    public string Username { get; init; }
 }
\ No newline at end of file