From a381eb884c61ce6661f6490f88e4af7430754dca Mon Sep 17 00:00:00 2001
From: Mark Monteiro <marknr.monteiro@protonmail.com>
Date: Mon, 10 Feb 2020 10:26:28 +0100
Subject: add-some-xml-documentation

---
 .../Configuration/IConfigurationFactory.cs         | 25 ++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'MediaBrowser.Common/Configuration')

diff --git a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
index 9b4ed772db..2b4b9b082c 100644
--- a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
+++ b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
@@ -6,20 +6,45 @@ using System.Collections.Generic;
 
 namespace MediaBrowser.Common.Configuration
 {
+    /// <summary>
+    /// Provides an interface to retrieve a configuration store. Classes with this interface are scanned for at
+    /// application start to dynamically register configuration for various modules/plugins.
+    /// </summary>
     public interface IConfigurationFactory
     {
+        /// <summary>
+        /// Get the configuration store for this module.
+        /// </summary>
+        /// <returns>The configuration store.</returns>
         IEnumerable<ConfigurationStore> GetConfigurations();
     }
 
+    /// <summary>
+    /// Describes a single entry in the application configuration.
+    /// </summary>
     public class ConfigurationStore
     {
+        /// <summary>
+        /// Gets or sets the unique identifier for the configuration.
+        /// </summary>
         public string Key { get; set; }
 
+        /// <summary>
+        /// Gets or sets the type used to store the data for this configuration entry.
+        /// </summary>
         public Type ConfigurationType { get; set; }
     }
 
+    /// <summary>
+    /// A configuration store that can be validated.
+    /// </summary>
     public interface IValidatingConfiguration
     {
+        /// <summary>
+        /// Validation method to be invoked before saving the configuration.
+        /// </summary>
+        /// <param name="oldConfig">The old configuration.</param>
+        /// <param name="newConfig">The new configuration.</param>
         void Validate(object oldConfig, object newConfig);
     }
 }
-- 
cgit v1.2.3


From 8ffb073ccb7f6661c04e64836d90d86228937962 Mon Sep 17 00:00:00 2001
From: Mark Monteiro <marknr.monteiro@protonmail.com>
Date: Wed, 12 Feb 2020 20:05:26 +0100
Subject: Enable documentation warnings for fully documented files

---
 MediaBrowser.Common/Configuration/IConfigurationFactory.cs | 3 ---
 MediaBrowser.Model/Services/ApiMemberAttribute.cs          | 3 ---
 2 files changed, 6 deletions(-)

(limited to 'MediaBrowser.Common/Configuration')

diff --git a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
index 2b4b9b082c..07ca2b58ba 100644
--- a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
+++ b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
@@ -1,6 +1,3 @@
-#pragma warning disable CS1591
-#pragma warning disable SA1600
-
 using System;
 using System.Collections.Generic;
 
diff --git a/MediaBrowser.Model/Services/ApiMemberAttribute.cs b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
index 06a6713ee3..8e50836f4d 100644
--- a/MediaBrowser.Model/Services/ApiMemberAttribute.cs
+++ b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
@@ -1,6 +1,3 @@
-#pragma warning disable CS1591
-#pragma warning disable SA1600
-
 using System;
 
 namespace MediaBrowser.Model.Services
-- 
cgit v1.2.3