From 9e52e84ef91db25980066f3130184bcaeb1cfd3d Mon Sep 17 00:00:00 2001
From: Brian Ball <cbrianball@gmail.com>
Date: Tue, 29 Jan 2019 14:51:03 -0500
Subject: [PATCH] Added more XML document comments.

---
 ...nventionBasedModelDefinitionInitializer.cs | 11 +++++++++
 Args/FluentModelBindingConfiguration.cs       |  3 +++
 Args/Help/HelpProvider.cs                     |  6 +++++
 Args/Help/IHelpProvider.cs                    | 12 ++++++++++
 Args/Help/MemberHelp.cs                       | 23 +++++++++++++++----
 Args/Help/ModelHelp.cs                        | 17 ++++++++++----
 6 files changed, 64 insertions(+), 8 deletions(-)

diff --git a/Args/ConventionBasedModelDefinitionInitializer.cs b/Args/ConventionBasedModelDefinitionInitializer.cs
index dce050e..3fb8456 100644
--- a/Args/ConventionBasedModelDefinitionInitializer.cs
+++ b/Args/ConventionBasedModelDefinitionInitializer.cs
@@ -69,12 +69,23 @@ public void Initialize<TModel>(IModelBindingDefinition<TModel> init)
             init.SetOrdinalArguments(ordinalArguments.Select(a => a.Value));
         }
 
+        /// <summary>
+        /// Returns the members for the movided model type
+        /// </summary>
+        /// <param name="modelType"></param>
+        /// <returns></returns>
         protected virtual IEnumerable<MemberInfo> GetMembers(Type modelType)
         {
             return modelType.GetFields(BindingFlags.Instance | BindingFlags.Public)
                 .Concat(modelType.GetProperties(BindingFlags.Instance | BindingFlags.Public).Where(p => p.CanWrite).Cast<MemberInfo>());
         }
 
+        /// <summary>
+        /// Detrmines the short version of a switch argument
+        /// </summary>
+        /// <param name="members"></param>
+        /// <param name="currentMember"></param>
+        /// <returns></returns>
         protected virtual string DeriveShortName(IEnumerable<MemberInfo> members, MemberInfo currentMember)
         {
             return DeriveShortNameRecursive(members, currentMember, 1);
diff --git a/Args/FluentModelBindingConfiguration.cs b/Args/FluentModelBindingConfiguration.cs
index 9066dfc..f7a7b2a 100644
--- a/Args/FluentModelBindingConfiguration.cs
+++ b/Args/FluentModelBindingConfiguration.cs
@@ -116,6 +116,9 @@ public FluentMemberBindingConfiguration<TModel> ForMember<TResult>(Expression<Fu
         }
     }
 
+    /// <summary>
+    /// Helper methods for fluent configuration
+    /// </summary>
     public static class FluentModelBindingConfigurationExtensions
     {
         /// <summary>
diff --git a/Args/Help/HelpProvider.cs b/Args/Help/HelpProvider.cs
index 8fb22f9..a8e0b31 100644
--- a/Args/Help/HelpProvider.cs
+++ b/Args/Help/HelpProvider.cs
@@ -38,6 +38,12 @@ public ModelHelp GenerateModelHelp<TModel>(IModelBindingDefinition<TModel> defin
             return modelHelp;
         }
 
+        /// <summary>
+        /// Generates help for members
+        /// </summary>
+        /// <typeparam name="TModel"></typeparam>
+        /// <param name="definition"></param>
+        /// <returns></returns>
         public MemberHelp GenerateMemberHelp<TModel>(IMemberBindingDefinition<TModel> definition)
         {
             var memberHelp = new MemberHelp
diff --git a/Args/Help/IHelpProvider.cs b/Args/Help/IHelpProvider.cs
index 156bafd..93e2bb1 100644
--- a/Args/Help/IHelpProvider.cs
+++ b/Args/Help/IHelpProvider.cs
@@ -10,7 +10,19 @@ namespace Args.Help
     /// </summary>
     public interface IHelpProvider
     {
+        /// <summary>
+        /// Generates help for the provided model definition
+        /// </summary>
+        /// <typeparam name="TModel"></typeparam>
+        /// <param name="definition"></param>
+        /// <returns></returns>
         ModelHelp GenerateModelHelp<TModel>(IModelBindingDefinition<TModel> definition);
+        /// <summary>
+        /// Generates help for the provided member definition
+        /// </summary>
+        /// <typeparam name="TModel"></typeparam>
+        /// <param name="definition"></param>
+        /// <returns></returns>
         MemberHelp GenerateMemberHelp<TModel>(IMemberBindingDefinition<TModel> definition);
     }
 }
\ No newline at end of file
diff --git a/Args/Help/MemberHelp.cs b/Args/Help/MemberHelp.cs
index 5c3b0af..f4415d5 100644
--- a/Args/Help/MemberHelp.cs
+++ b/Args/Help/MemberHelp.cs
@@ -1,16 +1,31 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
+using System.Collections.Generic;
 
 namespace Args.Help
 {
+    /// <summary>
+    /// Holds help information for model members
+    /// </summary>
     public class MemberHelp
     {
+        /// <summary>
+        /// Name of the member
+        /// </summary>
         public string Name { get; set; }
+        /// <summary>
+        /// List of switches configured for the member
+        /// </summary>
         public IEnumerable<string> Switches { get; set; }
+        /// <summary>
+        /// The default value if no value is provided
+        /// </summary>
         public string DefaultValue { get; set; }
+        /// <summary>
+        /// Help text for the member
+        /// </summary>
         public string HelpText { get; set; }
+        /// <summary>
+        /// Ordinal position for the member
+        /// </summary>
         public int? OrdinalIndex { get; set; }
     }
 }
diff --git a/Args/Help/ModelHelp.cs b/Args/Help/ModelHelp.cs
index f85fe00..359c447 100644
--- a/Args/Help/ModelHelp.cs
+++ b/Args/Help/ModelHelp.cs
@@ -1,14 +1,23 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
+using System.Collections.Generic;
 
 namespace Args.Help
 {
+    /// <summary>
+    /// Holds help information for the model
+    /// </summary>
     public class ModelHelp
     {
+        /// <summary>
+        /// The delimited for the switches
+        /// </summary>
         public string SwitchDelimiter { get; set; }
+        /// <summary>
+        /// List of members that are configured
+        /// </summary>
         public IEnumerable<MemberHelp> Members { get; set; }
+        /// <summary>
+        /// Help text for the entire model
+        /// </summary>
         public string HelpText { get; set; }
     }
 }