From 1bccf449fcaf6b88e84677642ffd012f20b54069 Mon Sep 17 00:00:00 2001
From: ijungleboy <daniel.mettler@2sic.com>
Date: Fri, 21 May 2021 18:29:25 +0200
Subject: [PATCH] Add docs to 2 core interfaces IAliasService and IFileService

---
 .../Oqtane.Client.csproj.DotSettings          |  2 ++
 .../Services/Interfaces/IAliasService.cs      | 35 ++++++++++++++++++-
 .../Services/Interfaces/IFileService.cs       |  2 +-
 3 files changed, 37 insertions(+), 2 deletions(-)
 create mode 100644 Oqtane.Client/Oqtane.Client.csproj.DotSettings

diff --git a/Oqtane.Client/Oqtane.Client.csproj.DotSettings b/Oqtane.Client/Oqtane.Client.csproj.DotSettings
new file mode 100644
index 00000000..a2222887
--- /dev/null
+++ b/Oqtane.Client/Oqtane.Client.csproj.DotSettings
@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=services_005Cinterfaces/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
\ No newline at end of file
diff --git a/Oqtane.Client/Services/Interfaces/IAliasService.cs b/Oqtane.Client/Services/Interfaces/IAliasService.cs
index f15356f1..89c25605 100644
--- a/Oqtane.Client/Services/Interfaces/IAliasService.cs
+++ b/Oqtane.Client/Services/Interfaces/IAliasService.cs
@@ -1,22 +1,55 @@
-using Oqtane.Models;
+using Oqtane.Models;
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace Oqtane.Services
 {
+    /// <summary>
+    /// Retrieve and store <see cref="Oqtane.Models.Alias"/> information.
+    /// </summary>
     public interface IAliasService
     {
+        /// <summary>
+        /// Get all aliases in the system
+        /// </summary>
+        /// <returns></returns>
         Task<List<Alias>> GetAliasesAsync();
 
+        /// <summary>
+        /// Get a single alias
+        /// </summary>
+        /// <param name="aliasId">The <see cref="Oqtane.Models.Alias"/> ID, not to be confused with a <see cref="Oqtane.Models.Site"/> ID</param>
+        /// <returns></returns>
         Task<Alias> GetAliasAsync(int aliasId);
 
+        /// <summary>
+        /// Retrieve the Alias object of a URL.
+        /// </summary>
+        /// <param name="url">The URL - todoc - is this only the root, or can it be a longer path?</param>
+        /// <param name="lastSyncDate">todoc - unclear what this is for</param>
+        /// <returns></returns>
         Task<Alias> GetAliasAsync(string url, DateTime lastSyncDate);
 
+        /// <summary>
+        /// Save another <see cref="Oqtane.Models.Alias"/> in the DB. It must already contain all the information incl. <see cref="Oqtane.Models.Tenant"/> it belongs to. 
+        /// </summary>
+        /// <param name="alias">An <see cref="Oqtane.Models.Alias"/> to add.</param>
+        /// <returns></returns>
         Task<Alias> AddAliasAsync(Alias alias);
 
+        /// <summary>
+        /// Update an <see cref="Oqtane.Models.Alias"/> in the DB. Make sure the object is correctly filled, as it must update an existing record. 
+        /// </summary>
+        /// <param name="alias">The <see cref="Oqtane.Models.Alias"/> to update.</param>
+        /// <returns></returns>
         Task<Alias> UpdateAliasAsync(Alias alias);
 
+        /// <summary>
+        /// Remove an <see cref="Oqtane.Models.Alias"/> from the DB. 
+        /// </summary>
+        /// <param name="aliasId">The Alias ID, not to be confused with a Site ID.</param>
+        /// <returns></returns>
         Task DeleteAliasAsync(int aliasId);
     }
 }
diff --git a/Oqtane.Client/Services/Interfaces/IFileService.cs b/Oqtane.Client/Services/Interfaces/IFileService.cs
index 7e10f4fd..ba6a88e1 100644
--- a/Oqtane.Client/Services/Interfaces/IFileService.cs
+++ b/Oqtane.Client/Services/Interfaces/IFileService.cs
@@ -1,4 +1,4 @@
-using Oqtane.Models;
+using Oqtane.Models;
 using System.Collections.Generic;
 using System.Threading.Tasks;