Merge pull request #2394 from mark-monteiro/xml-documentation

Add Some XML Documentation

3 files changed, 36 insertions, 8 deletions

diff --git a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
index 9b4ed772d..07ca2b58b 100644
--- a/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
+++ b/MediaBrowser.Common/Configuration/IConfigurationFactory.cs
@@ -1,25 +1,47 @@
-#pragma warning disable CS1591
-#pragma warning disable SA1600
-
 using System;
 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);
     }
 }
diff --git a/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs b/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs
index e57929989..1e8654c4d 100644
--- a/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs
+++ b/MediaBrowser.Controller/Plugins/IServerEntryPoint.cs
@@ -4,16 +4,22 @@ using System.Threading.Tasks;
 namespace MediaBrowser.Controller.Plugins
 {
     /// <summary>
-    /// Interface IServerEntryPoint
+    /// Represents an entry point for a module in the application. This interface is scanned for automatically and
+    /// provides a hook to initialize the module at application start.
+    /// The entry point can additionally be flagged as a pre-startup task by implementing the
+    /// <see cref="IRunBeforeStartup"/> interface.
     /// </summary>
     public interface IServerEntryPoint : IDisposable
     {
         /// <summary>
-        /// Runs this instance.
+        /// Run the initialization for this module. This method is invoked at application start.
         /// </summary>
         Task RunAsync();
     }
 
+    /// <summary>
+    /// Indicates that a <see cref="IServerEntryPoint"/> should be invoked as a pre-startup task.
+    /// </summary>
     public interface IRunBeforeStartup
     {
 
diff --git a/MediaBrowser.Model/Services/ApiMemberAttribute.cs b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
index 7267fce24..8e50836f4 100644
--- a/MediaBrowser.Model/Services/ApiMemberAttribute.cs
+++ b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
@@ -1,10 +1,10 @@
-#pragma warning disable CS1591
-#pragma warning disable SA1600
-
 using System;
 
 namespace MediaBrowser.Model.Services
 {
+    /// <summary>
+    /// Identifies a single API endpoint.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Property, AllowMultiple = true, Inherited = true)]
     public class ApiMemberAttribute : Attribute
     {