[add] missing XML comments

Author: i4004

src/Simplify.Web/Modules/Data/DataCollector.cs

@@ -4,14 +4,43 @@
 
 namespace Simplify.Web.Modules.Data;
 
+/// <summary>
+/// Provides the data collector.
+/// </summary>
+/// <seealso cref="IDataCollector" />
 public class DataCollector(string mainContentVariableName, string titleVariableName, IStringTable stringTable) : IDataCollector
 {
+	/// <summary>
+	/// Gets the name of the title variable.
+	/// </summary>
+	/// <value>
+	/// The name of the title variable.
+	/// </value>
 	public string TitleVariableName { get; } = titleVariableName;
 
+	/// <summary>
+	/// Gets a data collector items which will be inserted into master template file.
+	/// </summary>
+	/// <value>
+	/// The items.
+	/// </value>
 	public IDictionary<string, string> Items { get; } = new Dictionary<string, string>();
 
+	/// <summary>
+	/// Gets the <see cref="string"/> with the specified key.
+	/// </summary>
+	/// <value>
+	/// The <see cref="string"/>.
+	/// </value>
+	/// <param name="key">The key.</param>
 	public string this[string key] => Items[key];
 
+	/// <summary>
+	/// Set the template variable value (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="variableName">Variable name in master template file.</param>
+	/// <param name="value">Value to set.</param>
+	/// <exception cref="ArgumentException">Value cannot be null or empty. - variableName</exception>
 	public void Add(string? variableName, string? value)
 	{
 		if (string.IsNullOrEmpty(variableName))
@@ -28,6 +57,11 @@ public void Add(string? variableName, string? value)
 		Items[variableName!] += value;
 	}
 
+	/// <summary>
+	/// Set the template variable value with a data from template (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="variableName">Variable name in master template file.</param>
+	/// <param name="template">The template.</param>
 	public void Add(string variableName, ITemplate? template)
 	{
 		if (template == null)
@@ -36,17 +70,49 @@ public void Add(string variableName, ITemplate? template)
 		Add(variableName, template.Get());
 	}
 
+	/// <summary>
+	/// Set the template main content variable value (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="value">Value to set.</param>
 	public void Add(string? value) => Add(mainContentVariableName, value);
 
+	/// <summary>
+	/// Set the template main content variable value with a data from template (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="template">The template.</param>
 	public void Add(ITemplate template) => Add(mainContentVariableName, template);
 
+	/// <summary>
+	/// Set the template title variable value (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="value">Value to set.</param>
 	public void AddTitle(string? value) => Add(TitleVariableName, value);
 
+	/// <summary>
+	/// Set the template variable value from StringTable (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="variableName">Variable name in master template file.</param>
+	/// <param name="stringTableKey">StringTable key.</param>
 	public void AddSt(string variableName, string stringTableKey) => Add(variableName, stringTable.GetItem(stringTableKey));
 
+	/// <summary>
+	/// Set the template main content variable value from StringTable (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="stringTableKey">StringTable key.</param>
 	public void AddSt(string stringTableKey) => Add(stringTable.GetItem(stringTableKey));
 
+	/// <summary>
+	/// Set the template title variable value from StringTable (all occurrences will be replaced).
+	/// </summary>
+	/// <param name="stringTableKey">StringTable key.</param>
 	public void AddTitleSt(string stringTableKey) => AddTitle(stringTable.GetItem(stringTableKey));
 
+	/// <summary>
+	/// Checking if some variable data is already exist in a data collector.
+	/// </summary>
+	/// <param name="variableName">Variable name.</param>
+	/// <returns>
+	///   <c>true</c> if the variable name exists; otherwise, <c>false</c>.
+	/// </returns>
 	public bool IsDataExist(string variableName) => Items.ContainsKey(variableName);
 }

src/Simplify.Web/Modules/Data/FileReader.cs

@@ -10,6 +10,7 @@ namespace Simplify.Web.Modules.Data;
 /// <summary>
 /// Provides the localizable files reader, reads the files from data folder.
 /// </summary>
+/// <seealso cref="IFileReader" />
 /// <remarks>
 /// Initializes a new instance of the <see cref="FileReader" /> class.
 /// </remarks>
@@ -49,8 +50,22 @@ public static void ClearCache()
 
 	#region Paths
 
+	/// <summary>
+	/// Gets the file path.
+	/// </summary>
+	/// <param name="fileName">Name of the file.</param>
 	public string GetFilePath(string fileName) => GetFilePath(fileName, _languageManager.Language);
 
+	/// <summary>
+	/// Gets the file path.
+	/// </summary>
+	/// <param name="fileName">Name of the file.</param>
+	/// <param name="language">The language.</param>
+	/// <exception cref="ArgumentNullException">
+	/// fileName
+	/// or
+	/// language
+	/// </exception>
 	public string GetFilePath(string? fileName, string? language)
 	{
 		if (string.IsNullOrEmpty(fileName)) throw new ArgumentNullException(nameof(fileName));
@@ -71,8 +86,20 @@ public string GetFilePath(string? fileName, string? language)
 
 	#region Text
 
+	/// <summary>
+	/// Loads a text from a file located in data folder.
+	/// </summary>
+	/// <param name="fileName">File name.</param>
+	/// <param name="memoryCache">Load file from memory cache if possible.</param>
 	public string? LoadTextDocument(string fileName, bool memoryCache = false) => LoadTextDocument(fileName, _languageManager.Language, memoryCache);
 
+	/// <summary>
+	/// Load a text from a file with specific language located in data folder.
+	/// </summary>
+	/// <param name="fileName">File name.</param>
+	/// <param name="language">File language.</param>
+	/// <param name="memoryCache">Load file from memory cache if possible.</param>
+	/// <exception cref="ArgumentNullException">fileName</exception>
 	public string? LoadTextDocument(string fileName, string language, bool memoryCache = false)
 	{
 		if (string.IsNullOrEmpty(fileName))
@@ -102,8 +129,20 @@ public string GetFilePath(string? fileName, string? language)
 
 	#region XML
 
+	/// <summary>
+	/// Loads a xml document from a file located in data folder.
+	/// </summary>
+	/// <param name="fileName">File name.</param>
+	/// <param name="memoryCache">Load file from memory cache if possible.</param>
 	public XDocument? LoadXDocument(string fileName, bool memoryCache = false) => LoadXDocument(fileName, _languageManager.Language, memoryCache);
 
+	/// <summary>
+	/// Loads a xml document from a file with specific language located in data folder.
+	/// </summary>
+	/// <param name="fileName">File name.</param>
+	/// <param name="language">File language.</param>
+	/// <param name="memoryCache">Load file from memory cache if possible.</param>
+	/// <exception cref="ArgumentNullException">fileName</exception>
 	public XDocument? LoadXDocument(string fileName, string language, bool memoryCache = false)
 	{
 		if (string.IsNullOrEmpty(fileName))

src/Simplify.Web/Modules/Data/IDataCollector.cs

@@ -11,21 +11,30 @@ public interface IDataCollector
 	/// <summary>
 	/// Gets the name of the title variable.
 	/// </summary>
+	/// <value>
+	/// The name of the title variable.
+	/// </value>
 	string TitleVariableName { get; }
 
 	/// <summary>
 	/// Gets a data collector items which will be inserted into master template file.
 	/// </summary>
+	/// <value>
+	/// The items.
+	/// </value>
 	IDictionary<string, string> Items { get; }
 
 	/// <summary>
 	/// List of a data collector items.
 	/// </summary>
+	/// <value>
+	/// The <see cref="string"/>.
+	/// </value>
 	/// <param name="key">Item name.</param>
 	string this[string key] { get; }
 
 	/// <summary>
-	///  Set the template variable value (all occurrences will be replaced).
+	/// Set the template variable value (all occurrences will be replaced).
 	/// </summary>
 	/// <param name="variableName">Variable name in master template file.</param>
 	/// <param name="value">Value to set.</param>
@@ -59,8 +68,8 @@ public interface IDataCollector
 	/// <summary>
 	/// Set the template variable value from StringTable (all occurrences will be replaced).
 	/// </summary>
-	/// <param name="stringTableKey">StringTable key.</param>
 	/// <param name="variableName">Variable name in master template file.</param>
+	/// <param name="stringTableKey">StringTable key.</param>
 	void AddSt(string variableName, string stringTableKey);
 
 	/// <summary>
@@ -79,5 +88,8 @@ public interface IDataCollector
 	/// Checking if some variable data is already exist in a data collector.
 	/// </summary>
 	/// <param name="variableName">Variable name.</param>
+	/// <returns>
+	///   <c>true</c> if the variable name exists; otherwise, <c>false</c>.
+	/// </returns>
 	bool IsDataExist(string variableName);
 }

src/Simplify.Web/Modules/Data/IStringTable.cs

@@ -10,6 +10,9 @@ public interface IStringTable
 	/// <summary>
 	/// Gets StringTable items.
 	/// </summary>
+	/// <value>
+	/// The items.
+	/// </value>
 	IDictionary<string, object?> Items { get; }
 
 	/// <summary>
@@ -22,7 +25,9 @@ public interface IStringTable
 	/// </summary>
 	/// <typeparam name="T">Enum.</typeparam>
 	/// <param name="enumValue">Enum value.</param>
-	/// <returns>Associated value.</returns>
+	/// <returns>
+	/// Associated value.
+	/// </returns>
 	string? GetAssociatedValue<T>(T enumValue) where T : struct;
 
 	/// <summary>

src/Simplify.Web/Modules/Data/StringTable.cs

@@ -11,6 +11,7 @@ namespace Simplify.Web.Modules.Data;
 /// <summary>
 /// Provides the localizable text items string table.
 /// </summary>
+/// <seealso cref="IStringTable" />
 /// <param name="stringTableFiles">The string table files.</param>
 /// <param name="defaultLanguage">The default language.</param>
 /// <param name="languageManagerProvider">The language manager provider.</param>
@@ -27,15 +28,32 @@ public sealed class StringTable(IReadOnlyList<string> stringTableFiles,
 
 	private ILanguageManager _languageManager = null!;
 
+	/// <summary>
+	/// Gets StringTable items.
+	/// </summary>
+	/// <value>
+	/// The items.
+	/// </value>
 	public IDictionary<string, object?> Items { get; private set; } = null!;
 
+	/// <summary>
+	/// Setups this string table.
+	/// </summary>
 	public void Setup()
 	{
 		_languageManager = languageManagerProvider.Get();
 
 		TryLoad();
 	}
 
+	/// <summary>
+	/// Gets an enum associated value from string table by enum type + enum element name.
+	/// </summary>
+	/// <typeparam name="T">Enum.</typeparam>
+	/// <param name="enumValue">Enum value.</param>
+	/// <returns>
+	/// Associated value.
+	/// </returns>
 	public string? GetAssociatedValue<T>(T enumValue) where T : struct
 	{
 		var currentItems = (IDictionary<string, object>)Items;
@@ -46,6 +64,10 @@ public void Setup()
 			: null;
 	}
 
+	/// <summary>
+	/// Gets an item from string table.
+	/// </summary>
+	/// <param name="itemName">Name of the item.</param>
 	public string? GetItem(string itemName)
 	{
 		var currentItems = (IDictionary<string, object>)Items;