Optimized documentation

This commit is contained in:
Thorsten Sommer 2025-01-29 07:29:25 +01:00
parent da76be282b
commit 5c4103f859
Signed by: tsommer
GPG Key ID: 371BBA77A02C0108
2 changed files with 18 additions and 12 deletions

View File

@ -25,23 +25,15 @@ public readonly record struct DataSourceERI_V1 : IERIDataSource
/// <inheritdoc /> /// <inheritdoc />
public DataSourceType Type { get; init; } = DataSourceType.NONE; public DataSourceType Type { get; init; } = DataSourceType.NONE;
/// <summary> /// <inheritdoc />
/// The hostname of the ERI server.
/// </summary>
public string Hostname { get; init; } = string.Empty; public string Hostname { get; init; } = string.Empty;
/// <summary> /// <inheritdoc />
/// The port of the ERI server.
/// </summary>
public int Port { get; init; } public int Port { get; init; }
/// <summary> /// <inheritdoc />
/// The authentication method to use.
/// </summary>
public AuthMethod AuthMethod { get; init; } = AuthMethod.NONE; public AuthMethod AuthMethod { get; init; } = AuthMethod.NONE;
/// <summary> /// <inheritdoc />
/// The username to use for authentication, when the auth. method is USERNAME_PASSWORD.
/// </summary>
public string Username { get; init; } = string.Empty; public string Username { get; init; } = string.Empty;
} }

View File

@ -4,9 +4,23 @@ namespace AIStudio.Settings;
public interface IERIDataSource : IExternalDataSource public interface IERIDataSource : IExternalDataSource
{ {
/// <summary>
/// The hostname of the ERI server.
/// </summary>
public string Hostname { get; init; } public string Hostname { get; init; }
/// <summary>
/// The port of the ERI server.
/// </summary>
public int Port { get; init; } public int Port { get; init; }
/// <summary>
/// The authentication method to use.
/// </summary>
public AuthMethod AuthMethod { get; init; } 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; }
} }