[add] missing XML comments

Author: i4004

src/Simplify.Web/Modules/ApplicationEnvironment/DynamicEnvironment.cs

@@ -3,17 +3,40 @@
 namespace Simplify.Web.Modules.ApplicationEnvironment;
 
 /// <summary>
-/// Initializes a new instance of the <see cref="Environment"/> class.
+/// Provides the dynamic environment.
 /// </summary>
-/// <param name="appPhysicalPath">The application physical path.</param>
-/// <param name="settings">The settings.</param>
+/// <seealso cref="IDynamicEnvironment" />
 public sealed class DynamicEnvironment(IEnvironment environment, ISimplifyWebSettings settings) : IDynamicEnvironment
 {
+	/// <summary>
+	/// Gets the site current templates directory relative path.
+	/// </summary>
+	/// <value>
+	/// The templates path.
+	/// </value>
 	public string TemplatesPath { get; set; } = settings.DefaultTemplatesPath;
 
+	/// <summary>
+	/// Gets the site current templates directory physical path.
+	/// </summary>
+	/// <value>
+	/// The templates physical path.
+	/// </value>
 	public string TemplatesPhysicalPath => environment.AppPhysicalPath + TemplatesPath + "/";
 
+	/// <summary>
+	/// Gets the site current style.
+	/// </summary>
+	/// <value>
+	/// The site style.
+	/// </value>
 	public string SiteStyle { get; set; } = settings.DefaultStyle;
 
+	/// <summary>
+	/// Gets or sets the current master page template file name.
+	/// </summary>
+	/// <value>
+	/// The name of the master template file.
+	/// </value>
 	public string MasterTemplateFileName { get; set; } = settings.DefaultMasterTemplateFileName;
 }

src/Simplify.Web/Modules/ApplicationEnvironment/Environment.cs

@@ -2,10 +2,14 @@
 
 namespace Simplify.Web.Modules.ApplicationEnvironment;
 
+/// <summary>
+/// Provides the environment.
+/// </summary>
+/// <seealso cref="IEnvironment" />
 public sealed class Environment : IEnvironment
 {
 	/// <summary>
-	/// Initializes a new instance of the <see cref="Environment"/> class.
+	/// Initializes a new instance of the <see cref="Environment" /> class.
 	/// </summary>
 	/// <param name="appPhysicalPath">The application physical path.</param>
 	/// <param name="settings">The settings.</param>
@@ -20,9 +24,27 @@ public Environment(string appPhysicalPath, ISimplifyWebSettings settings)
 		DataPath = settings.DataPath;
 	}
 
+	/// <summary>
+	/// Gets the application physical path.
+	/// </summary>
+	/// <value>
+	/// The application physical path.
+	/// </value>
 	public string AppPhysicalPath { get; }
 
+	/// <summary>
+	/// Gets the data path.
+	/// </summary>
+	/// <value>
+	/// The data path.
+	/// </value>
 	public string DataPath { get; }
 
+	/// <summary>
+	/// Gets the data physical path.
+	/// </summary>
+	/// <value>
+	/// The data physical path.
+	/// </value>
 	public string DataPhysicalPath => AppPhysicalPath + DataPath + "/";
 }

src/Simplify.Web/Modules/ApplicationEnvironment/IDynamicEnvironment.cs

@@ -8,20 +8,32 @@ public interface IDynamicEnvironment
 	/// <summary>
 	/// Gets the site current templates directory relative path.
 	/// </summary>
+	/// <value>
+	/// The templates path.
+	/// </value>
 	string TemplatesPath { get; set; }
 
 	/// <summary>
 	/// Gets the site current templates directory physical path.
 	/// </summary>
+	/// <value>
+	/// The templates physical path.
+	/// </value>
 	string TemplatesPhysicalPath { get; }
 
 	/// <summary>
 	/// Gets the site current style.
 	/// </summary>
+	/// <value>
+	/// The site style.
+	/// </value>
 	string SiteStyle { get; set; }
 
 	/// <summary>
 	/// Gets or sets the current master page template file name.
 	/// </summary>
+	/// <value>
+	/// The name of the master template file.
+	/// </value>
 	string MasterTemplateFileName { get; set; }
 }

src/Simplify.Web/Modules/ApplicationEnvironment/IEnvironment.cs

@@ -16,10 +16,16 @@ public interface IEnvironment
 	/// <summary>
 	/// Gets the data path.
 	/// </summary>
+	/// <value>
+	/// The data path.
+	/// </value>
 	string DataPath { get; }
 
 	/// <summary>
 	/// Gets the data physical path.
 	/// </summary>
+	/// <value>
+	/// The data physical path.
+	/// </value>
 	string DataPhysicalPath { get; }
 }

src/Simplify.Web/Modules/Context/IWebContext.cs

@@ -11,41 +11,65 @@ public interface IWebContext
 	/// <summary>
 	/// Gets the current web-site route, for example: "/" or "/user/delete/15"/
 	/// </summary>
+	/// <value>
+	/// The route.
+	/// </value>
 	string Route { get; }
 
 	/// <summary>
 	/// Gets the site root url, for example: http://mysite.com or http://localhost/mysite//
 	/// </summary>
+	/// <value>
+	/// The site URL.
+	/// </value>
 	string SiteUrl { get; }
 
 	/// <summary>
 	/// Gets the virtual path.
 	/// </summary>
+	/// <value>
+	/// The virtual path.
+	/// </value>
 	string VirtualPath { get; }
 
 	/// <summary>
 	/// Gets the context for the current HTTP request.
 	/// </summary>
+	/// <value>
+	/// The context.
+	/// </value>
 	HttpContext Context { get; }
 
 	/// <summary>
 	/// Gets the request for the current HTTP request.
 	/// </summary>
+	/// <value>
+	/// The request.
+	/// </value>
 	HttpRequest Request { get; }
 
 	/// <summary>
 	/// Gets the response for the current HTTP request.
 	/// </summary>
+	/// <value>
+	/// The response.
+	/// </value>
 	HttpResponse Response { get; }
 
 	/// <summary>
 	/// Gets the query string for current HTTP request.
 	/// </summary>
+	/// <value>
+	/// The query.
+	/// </value>
 	IQueryCollection Query { get; }
 
 	/// <summary>
 	/// Gets the form data of post HTTP request.
 	/// </summary>
+	/// <value>
+	/// The form.
+	/// </value>
 	IFormCollection Form { get; }
 
 	/// <summary>
@@ -59,6 +83,9 @@ public interface IWebContext
 	/// <summary>
 	/// Gets a value indicating whether current request context user is not null and is authenticated.
 	/// </summary>
+	/// <value>
+	///   <c>true</c> if this instance is authenticated; otherwise, <c>false</c>.
+	/// </value>
 	bool IsAuthenticated { get; }
 
 	/// <summary>

src/Simplify.Web/Modules/Context/WebContext.cs

@@ -9,6 +9,7 @@ namespace Simplify.Web.Modules.Context;
 /// <summary>
 /// Provides the web context.
 /// </summary>
+/// <seealso cref="IWebContext" />
 public sealed class WebContext : IWebContext
 {
 	private readonly SemaphoreSlim _formReadSemaphore = new(1, 1);
@@ -18,7 +19,7 @@ public sealed class WebContext : IWebContext
 	private string? _requestBody;
 
 	/// <summary>
-	/// Initializes a new instance of the <see cref="WebContext"/> class.
+	/// Initializes a new instance of the <see cref="WebContext" /> class.
 	/// </summary>
 	/// <param name="context">The HTTP context.</param>
 	public WebContext(HttpContext context)
@@ -37,20 +38,69 @@ public WebContext(HttpContext context)
 		Route = Request.Path.Value ?? "/";
 	}
 
+	/// <summary>
+	/// Gets the current web-site route, for example: "/" or "/user/delete/15"/
+	/// </summary>
+	/// <value>
+	/// The route.
+	/// </value>
 	public string Route { get; }
 
+	/// <summary>
+	/// Gets the site root url, for example: http://mysite.com or http://localhost/mysite//
+	/// </summary>
+	/// <value>
+	/// The site URL.
+	/// </value>
 	public string SiteUrl { get; }
 
+	/// <summary>
+	/// Gets the virtual path.
+	/// </summary>
+	/// <value>
+	/// The virtual path.
+	/// </value>
 	public string VirtualPath { get; }
 
+	/// <summary>
+	/// Gets the context for the current HTTP request.
+	/// </summary>
+	/// <value>
+	/// The context.
+	/// </value>
 	public HttpContext Context { get; }
 
+	/// <summary>
+	/// Gets the request for the current HTTP request.
+	/// </summary>
+	/// <value>
+	/// The request.
+	/// </value>
 	public HttpRequest Request { get; }
 
+	/// <summary>
+	/// Gets the response for the current HTTP request.
+	/// </summary>
+	/// <value>
+	/// The response.
+	/// </value>
 	public HttpResponse Response { get; }
 
+	/// <summary>
+	/// Gets the query string for current HTTP request.
+	/// </summary>
+	/// <value>
+	/// The query.
+	/// </value>
 	public IQueryCollection Query { get; }
 
+	/// <summary>
+	/// Gets the form data of post HTTP request.
+	/// </summary>
+	/// <value>
+	/// The form.
+	/// </value>
+	/// <exception cref="InvalidOperationException">Form is null</exception>
 	public IFormCollection Form
 	{
 		get
@@ -67,10 +117,28 @@ public IFormCollection Form
 		}
 	}
 
+	/// <summary>
+	/// Gets a value indicating whether this request is ajax request.
+	/// </summary>
+	/// <value>
+	///   <c>true</c> if current request is ajax request; otherwise, <c>false</c>.
+	/// </value>
 	public bool IsAjax { get; }
 
+	/// <summary>
+	/// Gets a value indicating whether current request context user is not null and is authenticated.
+	/// </summary>
+	/// <value>
+	///   <c>true</c> if this instance is authenticated; otherwise, <c>false</c>.
+	/// </value>
 	public bool IsAuthenticated => Context.User is { Identity.IsAuthenticated: true };
 
+	/// <summary>
+	/// Gets the request body.
+	/// </summary>
+	/// <value>
+	/// The request body.
+	/// </value>
 	public string RequestBody
 	{
 		get
@@ -84,6 +152,9 @@ public string RequestBody
 		}
 	}
 
+	/// <summary>
+	/// Reads the form asynchronously.
+	/// </summary>
 	public async Task ReadFormAsync()
 	{
 		if (_form != null)
@@ -101,6 +172,9 @@ public async Task ReadFormAsync()
 		}
 	}
 
+	/// <summary>
+	/// Reads the request body asynchronously.
+	/// </summary>
 	public async Task ReadRequestBodyAsync()
 	{
 		if (_requestBody != null)

src/Simplify.Web/Modules/Context/WebContextProvider.cs

@@ -5,6 +5,7 @@ namespace Simplify.Web.Modules.Context;
 /// <summary>
 /// Provides the web context provider.
 /// </summary>
+/// <seealso cref="IWebContextProvider" />
 public sealed class WebContextProvider : IWebContextProvider
 {
 	private IWebContext? _webContext;

src/Simplify.Web/Modules/Data/Html/IListsGenerator.cs

@@ -116,5 +116,6 @@ string GenerateListFromEnum<T>(bool displayNotSelectedMessage = true, bool selec
 	/// <summary>
 	/// Generates an HTML list default item.
 	/// </summary>
+	/// <param name="isSelected">if set to <c>true</c> then the item will be generated as selected.</param>
 	string GenerateDefaultListItem(bool isSelected = true);
 }