Documentation modifications

2026-06-27 15:23:26 -07:00
parent a633fe6c06
commit a19fb90902
218 changed files with 2882 additions and 0 deletions
@@ -21,6 +21,12 @@ public class FileService : IFileService
    private readonly ILogger<FileService> _logger;
    private readonly string? _updateDirectory;

+    /// <summary>
+    /// Initializes a new instance of the <see cref="FileService"/> class, configuring the file system paths used to read update files and display assets and storing the logger used for diagnostic output. <see cref="FileService"/> provides file-related operations backed by the supplied configuration.
+    /// </summary>
+    /// <param name="apiSettings">The bound application settings exposed via <see cref="IOptions{ApiSettings}"/>; supplies the <see cref="ApiSettings.PathUpdateFiles"/> and <see cref="ApiSettings.PathToDisplayAssets"/> paths used to build the working directories.</param>
+    /// <param name="logger">The <see cref="ILogger{FileService}"/> retained for recording diagnostic and operational events.</param>
+    /// <!-- aidoc:v1 sig=715c341 body=f27c630 -->
    public FileService(
        IOptions<ApiSettings> apiSettings,
        ILogger<FileService> logger