Merge pull request #6899 from bdukes/add-missing-documentation

Add missing documentation

Author: valadas

DNN Platform/DotNetNuke.Web.Client/Cdf/BasicFile.cs

@@ -6,8 +6,11 @@ namespace DotNetNuke.Web.Client.Cdf
 {
     using System.Collections.Generic;
 
+    /// <summary>A file.</summary>
     internal class BasicFile
     {
+        /// <summary>Initializes a new instance of the <see cref="BasicFile"/> class.</summary>
+        /// <param name="type">The dependency type.</param>
         public BasicFile(ClientDependencyType type)
         {
             this.DependencyType = type;
@@ -19,24 +22,34 @@ public BasicFile(ClientDependencyType type)
             this.ForceVersion = false;
         }
 
+        /// <summary>Gets or sets the file path.</summary>
         public string FilePath { get; set; }
 
+        /// <summary>Gets the dependency type.</summary>
         public ClientDependencyType DependencyType { get; private set; }
 
+        /// <summary>Gets or sets the priority.</summary>
         public int Priority { get; set; }
 
+        /// <summary>Gets or sets the group.</summary>
         public int Group { get; set; }
 
+        /// <summary>Gets or sets the path name alias.</summary>
         public string PathNameAlias { get; set; }
 
+        /// <summary>Gets or sets the provider.</summary>
         public string ForceProvider { get; set; }
 
+        /// <summary>Gets the HTML attributes.</summary>
         public IDictionary<string, string> HtmlAttributes { get; private set; }
 
+        /// <summary>Gets or sets the name.</summary>
         public string Name { get; set; }
 
+        /// <summary>Gets or sets the version.</summary>
         public string Version { get; set; }
 
+        /// <summary>Gets or sets a value indicating whether to force the use of this version.</summary>
         public bool ForceVersion { get; set; }
     }
 }

DNN Platform/DotNetNuke.Web.Client/ClientResourceManager.cs

@@ -131,6 +131,7 @@ public static void AddConfiguration()
             xmlDoc.Save(configPath);
         }
 
+        /// <summary>Remove the client dependency configuration from the <c>web.config</c>.</summary>
         public static void RemoveConfiguration()
         {
             Logger.Info("Removing ClientDependency from web.config");

DNN Platform/DotNetNuke.Web.Client/ClientResourceSettings.cs

@@ -21,14 +21,28 @@ namespace DotNetNuke.Web.Client
     public partial class ClientResourceSettings
     {
         // public keys used to identify the dictionaries stored in the application context
+
+        /// <summary>The host settings dictionary key.</summary>
         public static readonly string HostSettingsDictionaryKey = "HostSettingsDictionary";
+
+        /// <summary>The portal settings dictionary key.</summary>
         public static readonly string PortalSettingsDictionaryKey = "PortalSettingsDictionary";
 
         // public keys used to identify the various host and portal level settings
+
+        /// <summary>The composite files key.</summary>
         public static readonly string EnableCompositeFilesKey = "CrmEnableCompositeFiles";
+
+        /// <summary>The minify CSS key.</summary>
         public static readonly string MinifyCssKey = "CrmMinifyCss";
+
+        /// <summary>The minify JS key.</summary>
         public static readonly string MinifyJsKey = "CrmMinifyJs";
+
+        /// <summary>The override default settings key.</summary>
         public static readonly string OverrideDefaultSettingsKey = "CrmUseApplicationSettings";
+
+        /// <summary>The version key.</summary>
         public static readonly string VersionKey = "CrmVersion";
 
         private static readonly Type PortalControllerType;
@@ -70,6 +84,9 @@ public partial bool IsOverridingDefaultSettingsEnabled()
             return this.IsOverridingDefaultSettingsEnabled(portalId);
         }
 
+        /// <summary>Gets a value indicating whether overriding the default settings is enabled.</summary>
+        /// <param name="portalId">The portal ID.</param>
+        /// <returns><see langword="true"/> if it's enabled, otherwise <see langword="false"/>.</returns>
         [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Justification = "Breaking change")]
         public bool IsOverridingDefaultSettingsEnabled(int? portalId)
         {
@@ -89,6 +106,9 @@ public bool IsOverridingDefaultSettingsEnabled(int? portalId)
             return this.GetVersion(portalId);
         }
 
+        /// <summary>Gets the version.</summary>
+        /// <param name="portalId">The portal ID.</param>
+        /// <returns>The version or <see langword="null"/>.</returns>
         [SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic", Justification = "Breaking change")]
         public int? GetVersion(int? portalId)
         {
@@ -113,18 +133,24 @@ public bool IsOverridingDefaultSettingsEnabled(int? portalId)
             return null;
         }
 
+        /// <summary>Gets a value indicating whether composite files are enabled.</summary>
+        /// <returns>Whether it's enabled.</returns>
         public bool? AreCompositeFilesEnabled()
         {
             int? portalId = GetPortalIdThroughReflection();
             return this.IsBooleanSettingEnabled(portalId, EnableCompositeFilesKey);
         }
 
+        /// <summary>Gets a value indicating whether CSS minification is enabled.</summary>
+        /// <returns>Whether it's enabled.</returns>
         public bool? EnableCssMinification()
         {
             int? portalId = GetPortalIdThroughReflection();
             return this.IsBooleanSettingEnabled(portalId, MinifyCssKey);
         }
 
+        /// <summary>Gets a value indicating whether JS minification is enabled.</summary>
+        /// <returns>Whether it's enabled.</returns>
         public bool? EnableJsMinification()
         {
             int? portalId = GetPortalIdThroughReflection();

DNN Platform/DotNetNuke.Web.Client/Controls/ClientResourceExclude.cs

@@ -36,6 +36,7 @@ protected ClientResourceExclude(IClientResourceController clientResourceControll
         /// <summary>Gets the dependency type of the client resource to exclude.</summary>
         public ClientDependencyType DependencyType { get; internal set; }
 
+        /// <inheritdoc />
         protected override void OnLoad(EventArgs e)
         {
             switch (this.DependencyType)

DNN Platform/DotNetNuke.Web.Client/Controls/ClientResourceLoader.cs

@@ -32,12 +32,14 @@ public ClientResourceLoader(IClientResourceController clientResourceController)
             this.Paths = [];
         }
 
+        /// <summary>Gets the paths collection.</summary>
         [PersistenceMode(PersistenceMode.InnerProperty)]
         public ClientResourcePathCollection Paths { get; private set; }
 
         private static bool AsyncPostBackHandlerEnabled =>
             HttpContext.Current != null && HttpContext.Current.Items.Contains("AsyncPostBackHandlerEnabled");
 
+        /// <inheritdoc />
         protected override void OnInit(System.EventArgs e)
         {
             if (AsyncPostBackHandlerEnabled && ScriptManager.GetCurrent(this.Page) == null)
@@ -48,6 +50,7 @@ protected override void OnInit(System.EventArgs e)
             base.OnInit(e);
         }
 
+        /// <inheritdoc />
         protected override void OnLoad(System.EventArgs e)
         {
             foreach (var path in this.Paths)

DNN Platform/DotNetNuke.Web.Client/Controls/ClientResourcePath.cs

@@ -10,21 +10,29 @@ namespace DotNetNuke.Web.Client.ClientResourceManagement
     /// <summary>Defines the path to a client resource.</summary>
     public class ClientResourcePath
     {
+        /// <summary>An event which is triggered during data binding.</summary>
         public event EventHandler DataBinding;
 
+        /// <summary>Gets or sets the name.</summary>
         public string Name { get; set; }
 
+        /// <summary>Gets or sets the path.</summary>
         public string Path { get; set; }
 
+        /// <summary>Gets the parent.</summary>
         public ClientResourceLoader Parent { get; internal set; }
 
+        /// <summary>Gets the binding container.</summary>
         public Control BindingContainer => this.Parent;
 
+        /// <summary>Triggers the <see cref="DataBinding"/> event.</summary>
         public void DataBind()
         {
             this.OnDataBinding(EventArgs.Empty);
         }
 
+        /// <summary>Triggers the <see cref="DataBinding"/> event.</summary>
+        /// <param name="e">The event args.</param>
         protected void OnDataBinding(EventArgs e)
         {
             this.DataBinding?.Invoke(this, e);

DNN Platform/DotNetNuke.Web.Client/Controls/DnnHtmlInclude.cs

@@ -18,7 +18,10 @@ namespace DotNetNuke.Web.Client.ClientResourceManagement
     /// <summary>Allows for registration of CSS and JavaScript resources.</summary>
     public class DnnHtmlInclude : Literal
     {
+        /// <summary>The pattern that matches a tag.</summary>
         public const string TagPattern = @"<{0}((\s+\w+(\s*=\s*(?:"".*?""|'.*?'|[^'"">\s]+))?)+\s*|\s*)/?>";
+
+        /// <summary>The pattern that matches an attribute.</summary>
         public const string AttributePattern = @"{0}(\s*=\s*(?:""(?<val>.*?)""|'(?<val>.*?)'|(?<val>[^'"">\s]+)))";
 
         private const string MatchAllAttributes = @"(\S+)=[""']?((?:.(?![""']?\s+(?:\S+)=|[>""']))+.)[""']?";
@@ -28,6 +31,8 @@ public class DnnHtmlInclude : Literal
 
         private readonly IClientResourceController clientResourceController;
 
+        /// <summary>Initializes a new instance of the <see cref="DnnHtmlInclude"/> class.</summary>
+        /// <param name="clientResourceController">The client resource controller.</param>
         public DnnHtmlInclude(IClientResourceController clientResourceController)
         {
             this.clientResourceController = clientResourceController;
@@ -42,6 +47,7 @@ public DnnHtmlInclude(IClientResourceController clientResourceController)
         /// <summary>Gets or sets the group for this resource include.</summary>
         public int Group { get; set; } = 100;
 
+        /// <inheritdoc />
         protected override void OnLoad(EventArgs e)
         {
             base.OnLoad(e);

DNN Platform/DotNetNuke.Web.Client/Controls/DnnJsIncludeFallback.cs

@@ -20,8 +20,10 @@ public DnnJsIncludeFallback(string objectName, string fileName)
             this.FileName = fileName;
         }
 
+        /// <summary>Gets or sets the object name.</summary>
         public string ObjectName { get; set; }
 
+        /// <summary>Gets or sets the file name.</summary>
         public string FileName { get; set; }
 
         /// <inheritdoc/>

DNN Platform/DotNetNuke.Web.Client/Controls/DnnResources.cs

@@ -9,19 +9,25 @@ namespace DotNetNuke.Web.Client.ClientResourceManagement
 
     using DotNetNuke.Abstractions.ClientResources;
 
+    /// <summary>Renders client resources.</summary>
     public class DnnResources : Literal
     {
         private readonly IClientResourceController clientResourceController;
 
+        /// <summary>Initializes a new instance of the <see cref="DnnResources"/> class.</summary>
+        /// <param name="clientResourceController">The client resource controller.</param>
         public DnnResources(IClientResourceController clientResourceController)
         {
             this.clientResourceController = clientResourceController;
         }
 
+        /// <summary>Gets or sets the application path.</summary>
         public string ApplicationPath { get; set; }
 
+        /// <summary>Gets or sets the provider.</summary>
         public string Provider { get; set; }
 
+        /// <inheritdoc />
         protected override void Render(HtmlTextWriter writer)
         {
             base.Render(writer);

DNN Platform/DotNetNuke.Web.Client/DependencyInjection.cs

@@ -11,6 +11,8 @@ namespace DotNetNuke.Web.Client;
 
 using Microsoft.Extensions.DependencyInjection;
 
+/// <summary>A helper for dependency injection.</summary>
+/// <remarks>This class uses reflection to access the DI container since it can't directly reference the main DotNetNuke.Library project.</remarks>
 internal static class DependencyInjection
 {
     private static readonly Type CommonGlobalsType;
@@ -28,13 +30,19 @@ static DependencyInjection()
         }
     }
 
+    /// <summary>Gets the current service scope, or creates a service scope if there isn't one already created. The scope must be disposed by the caller.</summary>
+    /// <returns>A service scope.</returns>
+    /// <exception cref="InvalidOperationException">The expected method in <c>DotNetNuke.Common.Globals</c> does not exist.</exception>
     public static IServiceScope GetOrCreateServiceScope()
     {
         var getOrCreateServiceScopeMethod = CommonGlobalsType.GetMethod("GetOrCreateServiceScope", BindingFlags.NonPublic | BindingFlags.Static) ?? throw new InvalidOperationException("Unable to retrieve Globals.GetOrCreateServiceScope method via reflection");
         var serviceScope = getOrCreateServiceScopeMethod.Invoke(null, []);
         return (IServiceScope)serviceScope;
     }
 
+    /// <summary>Gets the current service provider.</summary>
+    /// <returns>A service provider.</returns>
+    /// <exception cref="InvalidOperationException">The expected method in <c>DotNetNuke.Common.Globals</c> does not exist.</exception>
     public static IServiceProvider GetCurrentServiceProvider()
     {
         var getCurrentServiceProviderMethod = CommonGlobalsType.GetMethod("GetCurrentServiceProvider", BindingFlags.NonPublic | BindingFlags.Static) ?? throw new InvalidOperationException("Unable to retrieve Globals.GetCurrentServiceProvider method via reflection");