Adds Documentation (#10)

* Add nuget package instead of project reference

* Update readme with some configuration documentation.

* Add warnings

* Add documentation to public API

* Update nuspec to v1.0.2

* Update spec

Author: Matthiee

CommandLineParser.Tests/Command/CommandTests.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using MatthiWare.CommandLine;
+using Xunit;
+
+namespace MatthiWare.CommandLineParser.Tests.Command
+{
+    public class CommandTests
+    {
+
+        [Fact]
+        public void ConfiguringCommandsIncreasesTotalCommandInParser()
+        {
+            var parser = new CommandLineParser<object>();
+
+            parser.AddCommand<object>().Name("x");
+            parser.AddCommand<object>().Name("y");
+
+            Assert.Equal(2, parser.Commands.Count);
+
+            Assert.NotNull(parser.Commands.First(cmd => cmd.ShortName.Equals("x")));
+            Assert.NotNull(parser.Commands.First(cmd => cmd.ShortName.Equals("y")));
+        }
+
+    }
+}

CommandLineParser.Tests/CommandLineArgumentOptionTest.cs

@@ -22,8 +22,4 @@
     <ProjectReference Include="..\CommandLineParser\CommandLineParser.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="Command\" />
-  </ItemGroup>
-
 </Project>

CommandLineParser.Tests/CommandLineParser.Tests.csproj

@@ -3,18 +3,53 @@
 
 namespace MatthiWare.CommandLine.Abstractions.Command
 {
+    /// <summary>
+    /// Configures commands using a fluent interface
+    /// </summary>
+    /// <typeparam name="Tsource">Command options class</typeparam>
     public interface ICommandBuilder<Tsource> where Tsource : class, new()
     {
+        /// <summary>
+        /// Configures if the command is required
+        /// </summary>
+        /// <param name="required">True or false</param>
+        /// <returns><see cref="ICommandBuilder{Tsource}"/></returns>
         ICommandBuilder<Tsource> Required(bool required = true);
 
+        /// <summary>
+        /// Configures the help text for the command
+        /// </summary>
+        /// <param name="required">True or false</param>
+        /// <returns><see cref="ICommandBuilder{Tsource}"/></returns>
         ICommandBuilder<Tsource> HelpText(string help);
 
+        /// <summary>
+        /// Configures the command name
+        /// </summary>
+        /// <param name="shortName">Short name</param>
+        /// <returns><see cref="ICommandBuilder{Tsource}"/></returns>
         ICommandBuilder<Tsource> Name(string shortName);
 
+        /// <summary>
+        /// Configures the command name
+        /// </summary>
+        /// <param name="shortName">Short name</param>
+        /// <param name="longName">Long name</param>
+        /// <returns><see cref="ICommandBuilder{Tsource}"/></returns>
         ICommandBuilder<Tsource> Name(string shortName, string longName);
 
+        /// <summary>
+        /// Configures the execution of the command
+        /// </summary>
+        /// <param name="required">True or false</param>
+        /// <returns><see cref="ICommandBuilder{Tsource}"/></returns>
         ICommandBuilder<Tsource> OnExecuting(Action<Tsource> action);
 
+        /// <summary>
+        /// Configures if the command options
+        /// </summary>
+        /// <param name="selector">Property to configure</param>
+        /// <returns><see cref="IOptionBuilder"/></returns>
         IOptionBuilder Configure<TProperty>(Expression<Func<Tsource, TProperty>> selector);
     }
 }

CommandLineParser/Abstractions/Command/ICommandBuilder'.cs

@@ -1,5 +1,8 @@
 namespace MatthiWare.CommandLine.Abstractions.Command
 {
+    /// <summary>
+    /// Command configuration options
+    /// </summary>
     public interface ICommandLineCommand
     {
         string ShortName { get; }

CommandLineParser/Abstractions/Command/ICommandLineCommand.cs

@@ -4,9 +4,21 @@
 
 namespace MatthiWare.CommandLine.Abstractions.Command
 {
+    /// <summary>
+    /// Parser for a command line command
+    /// </summary>
     public interface ICommandLineCommandParser
     {
+        /// <summary>
+        /// Read-only collection of the options for the command
+        /// </summary>
         IReadOnlyList<ICommandLineOption> Options { get; }
+
+        /// <summary>
+        /// Parses the arguments
+        /// </summary>
+        /// <param name="argumentManager">Arguments to parse</param>
+        /// <returns><see cref="ICommandParserResult"/></returns>
         ICommandParserResult Parse(IArgumentManager argumentManager);
     }
 }

CommandLineParser/Abstractions/Command/ICommandLineCommandParser.cs

@@ -2,8 +2,11 @@
 
 namespace MatthiWare.CommandLine.Abstractions
 {
+    /// <summary>
+    /// Option configuration options
+    /// </summary>
     public interface ICommandLineOption : ICommandLineCommand
     {
-        
+
     }
 }

CommandLineParser/Abstractions/ICommandLineOption.cs

@@ -10,22 +10,52 @@ public interface ICommandLineParser<TSource>
     {
         #region Properties
 
+        /// <summary>
+        /// Read-only list of available sub-commands
+        /// <see cref="ICommandLineParser{TSource}.AddCommand{TCommandOption}"/> to configure or add an command
+        /// </summary>
         IReadOnlyList<ICommandLineCommand> Commands { get; }
+
+        /// <summary>
+        /// Read-only list of available options for this command
+        /// <see cref="ICommandLineParser{TSource}.Configure{TProperty}(Expression{Func{TSource, TProperty}})"/> to configure or add an option
+        /// </summary>
         IReadOnlyList<ICommandLineOption> Options { get; }
+
+        /// <summary>
+        /// Factory to resolve the argument type
+        /// <see cref="ICommandLineArgumentResolver"/> for more info.
+        /// </summary>
         IResolverFactory ResolverFactory { get; }
 
         #endregion
 
         #region Parsing
 
+        /// <summary>
+        /// Parses the current command and returns the result
+        /// </summary>
+        /// <param name="args">command arguments</param>
+        /// <returns>The <see cref="IParserResult{TResult}"/> result</returns>
         IParserResult<TSource> Parse(string[] args);
 
         #endregion
 
         #region Configuration
 
+        /// <summary>
+        /// Configures a new or existing option
+        /// </summary>
+        /// <typeparam name="TProperty">The property type</typeparam>
+        /// <param name="selector">Property selector</param>
+        /// <returns><see cref="IOptionBuilder"/></returns>
         IOptionBuilder Configure<TProperty>(Expression<Func<TSource, TProperty>> selector);
 
+        /// <summary>
+        /// Adds a new command  and allowes to configure it. 
+        /// </summary>
+        /// <typeparam name="TCommandOption">Command options model</typeparam>
+        /// <returns>A command builder, see <see cref="ICommandBuilder{Tsource}"/> for more info.</returns>
         ICommandBuilder<TCommandOption> AddCommand<TCommandOption>() where TCommandOption : class, new();
 
         #endregion

CommandLineParser/Abstractions/ICommandLineParser'.cs

@@ -1,15 +1,44 @@
 namespace MatthiWare.CommandLine.Abstractions
 {
+    /// <summary>
+    /// API for configuring options
+    /// </summary>
     public interface IOptionBuilder
     {
+        /// <summary>
+        /// Sets if the option is required
+        /// </summary>
+        /// <param name="required">Required or not</param>
+        /// <returns><see cref="IOptionBuilder"/></returns>
         IOptionBuilder Required(bool required = true);
 
+        /// <summary>
+        /// Help text to be displayed for this option
+        /// </summary>
+        /// <param name="help"></param>
+        /// <returns></returns>
         IOptionBuilder HelpText(string help);
 
+        /// <summary>
+        /// Specify the default value for this option
+        /// </summary>
+        /// <param name="defaultValue"></param>
+        /// <returns></returns>
         IOptionBuilder Default(object defaultValue);
 
+        /// <summary>
+        /// Configures the name for the option
+        /// </summary>
+        /// <param name="shortName">short name</param>
+        /// <returns></returns>
         IOptionBuilder Name(string shortName);
 
+        /// <summary>
+        /// Configures the name for the option
+        /// </summary>
+        /// <param name="shortName">Short name</param>
+        /// <param name="longName">Long name</param>
+        /// <returns></returns>
         IOptionBuilder Name(string shortName, string longName);
     }
 }

CommandLineParser/Abstractions/IOptionBuilder'.cs

@@ -1,23 +1,35 @@
 namespace MatthiWare.CommandLine.Abstractions.Models
 {
+    /// <summary>
+    /// Model for command line arguments
+    /// </summary>
     public struct ArgumentModel
     {
+        /// <summary>
+        /// Argument identifier
+        /// </summary>
         public string Key { get; set; }
 
+        /// <summary>
+        /// Value of the argument
+        /// Can be null
+        /// </summary>
         public string Value { get; set; }
 
+        /// <summary>
+        /// Checks if an value has been provided in the model
+        /// </summary>
         public bool HasValue => Value != null;
 
+        /// <summary>
+        /// Creates a new instance of the argument model
+        /// </summary>
+        /// <param name="key">model identifier</param>
+        /// <param name="value">model value</param>
         public ArgumentModel(string key, string value)
         {
             this.Key = key;
             this.Value = value;
         }
-
-        public ArgumentModel(string key)
-        {
-            this.Key = key;
-            this.Value = null;
-        }
     }
 }