Use <inheritDoc /> for documentation (fixes #60)

Author: akamsteeg

src/AtleX.CommandLineArguments/Help/ConsoleHelpWriter.cs

@@ -8,15 +8,7 @@ namespace AtleX.CommandLineArguments.Help
   public abstract class ConsoleHelpWriter
     : HelpWriter
   {
-    /// <summary>
-    /// Write the help for the specified <see cref="Arguments"/> object
-    /// </summary>
-    /// <typeparam name="T">
-    /// The type of the <see cref="Arguments"/> to write the help for
-    /// </typeparam>
-    /// <param name="argumentsToWriteHelpFor">
-    /// The <see cref="Arguments"/> object to write the help for
-    /// </param>
+    /// <inheritdoc />
     public override void Write<T>(T argumentsToWriteHelpFor)
     {
       _ = argumentsToWriteHelpFor ?? throw new ArgumentNullException(nameof(argumentsToWriteHelpFor));

src/AtleX.CommandLineArguments/Help/HelpWriter.cs

@@ -18,15 +18,7 @@ public HelpWriter()
     {
     }
 
-    /// <summary>
-    /// Write the help for the specified <see cref="Arguments"/> object
-    /// </summary>
-    /// <typeparam name="T">
-    /// The type of the <see cref="Arguments"/> to write the help for
-    /// </typeparam>
-    /// <param name="argumentsToWriteHelpFor">
-    /// The <see cref="Arguments"/> object to write the help for
-    /// </param>
+    /// <inheritdoc />
     public abstract void Write<T>(T argumentsToWriteHelpFor)
       where T : Arguments, new();
 

src/AtleX.CommandLineArguments/Help/KeyValueStyleHelpWriter.cs

@@ -8,15 +8,7 @@ namespace AtleX.CommandLineArguments.Help
   public class KeyValueStyleHelpWriter
     : ConsoleHelpWriter
   {
-    /// <summary>
-    /// Write the help for the specified <see cref="Arguments"/> object
-    /// </summary>
-    /// <typeparam name="T">
-    /// The type of the <see cref="Arguments"/> to write the help for
-    /// </typeparam>
-    /// <param name="argumentsToWriteHelpFor">
-    /// The <see cref="Arguments"/> object to write the help for
-    /// </param>
+    /// <inheritdoc />
     public override void Write<T>(T argumentsToWriteHelpFor)
     {
       _= argumentsToWriteHelpFor ?? throw new ArgumentNullException(nameof(argumentsToWriteHelpFor));
@@ -38,17 +30,7 @@ public override void Write<T>(T argumentsToWriteHelpFor)
       Console.WriteLine("*: Required arguments");
     }
 
-    /// <summary>
-    /// Gets the exact name of an argument how it should be used on the command
-    /// line, including prefixes
-    /// </summary>
-    /// <param name="argumentName">
-    /// The name of the argument to get the exact commandline usage for
-    /// </param>
-    /// <returns>
-    /// The exact name of an argument how it should be used on the command line,
-    /// including prefixes
-    /// </returns>
+    /// <inheritdoc />
     protected override string GetExactCommandlineNameOfArgument(string argumentName)
     {
       return argumentName;

src/AtleX.CommandLineArguments/Help/PrefixedKeyConsoleHelpWriter.cs

@@ -28,17 +28,7 @@ public PrefixedKeyConsoleHelpWriter(string keyPrefix)
       this._keyPrefix = keyPrefix;
     }
 
-    /// <summary>
-    /// Gets the exact name of an argument how it should be used on the command
-    /// line, including prefixes
-    /// </summary>
-    /// <param name="argumentName">
-    /// The name of the argument to get the exact commandline usage for
-    /// </param>
-    /// <returns>
-    /// The exact name of an argument how it should be used on the command line,
-    /// including prefixes
-    /// </returns>
+    /// <inheritdoc />
     protected override string GetExactCommandlineNameOfArgument(string argumentName)
     {
       var result = this._keyPrefix + argumentName;

src/AtleX.CommandLineArguments/Parsers/CommandLineArgumentsParser.cs

@@ -21,24 +21,7 @@ public CommandLineArgumentsParser()
 
     }
 
-    /// <summary>
-    /// Parse the specified arguments to the specified type
-    /// </summary>
-    /// <typeparam name="T">
-    /// The <see cref="Arguments"/> to parse to
-    /// </typeparam>
-    /// <param name="arguments">
-    /// The arguments to parse
-    /// </param>
-    /// <param name="validators">
-    /// The <see cref="IEnumerable{T}"/> of <see cref="IArgumentValidator"/> to validate the arguments with
-    /// </param>
-    /// <param name="typeParsers">
-    /// The <see cref="IEnumerable{T}"/> of <see cref="ITypeParser"/> to parse the argument values with
-    /// </param>
-    /// <returns>
-    /// The <see cref="ParseResult{T}"/>
-    /// </returns>
+    /// <inheritdoc />
     public virtual ParseResult<T> Parse<T>(string[] arguments, IEnumerable<IArgumentValidator> validators, IEnumerable<ITypeParser> typeParsers)
       where T : Arguments, new()
     {

src/AtleX.CommandLineArguments/Parsers/KeyValueStyleParser.cs

@@ -8,22 +8,7 @@ namespace AtleX.CommandLineArguments.Parsers
   public sealed class KeyValueStyleParser
     : CommandLineArgumentsParser
   {
-    /// <summary>
-    /// Try to find an argument with the specified name in the specified
-    /// collection of all command line arguments
-    /// </summary>
-    /// <param name="allCommandLineArguments">
-    /// The collection of all command line arguments
-    /// </param>
-    /// <param name="argumentToFind">
-    /// The name of the argument to find
-    /// </param>
-    /// <param name="value">
-    /// The value of the argument, if found
-    /// </param>
-    /// <returns>
-    /// True when the argument with the specified name to find is found, false otherwise
-    /// </returns>
+    /// <inheritdoc />
     protected override bool TryFindRawArgumentValue(string[] allCommandLineArguments, string argumentToFind, out string value)
     {
       var result = false;
@@ -45,15 +30,7 @@ protected override bool TryFindRawArgumentValue(string[] allCommandLineArguments
       return result;
     }
 
-    /// <summary>
-    /// Gets whether the specified command line arguments contain a Help argument or not
-    /// </summary>
-    /// <param name="allCommandLineArguments">
-    /// The collection of all command line arguments
-    /// </param>
-    /// <returns>
-    /// True when the collection of command line arguments contains a Help argument, false otherwise
-    /// </returns>
+    /// <inheritdoc />
     protected override bool ContainsHelpArgument(string[] allCommandLineArguments)
     {
       var result = false;

src/AtleX.CommandLineArguments/Parsers/PrefixedKeyParser.cs

@@ -34,22 +34,7 @@ public PrefixedKeyParser(string keyIndicator)
       this._keyPrefixLength = keyIndicator.Length;
     }
 
-    /// <summary>
-    /// Try to find an argument with the specified name in the specified
-    /// collection of all command line arguments
-    /// </summary>
-    /// <param name="allCommandLineArguments">
-    /// The collection of all command line arguments
-    /// </param>
-    /// <param name="argumentToFind">
-    /// The name of the argument to find
-    /// </param>
-    /// <param name="value">
-    /// The value of the argument, if found
-    /// </param>
-    /// <returns>
-    /// True when the argument with the specified name to find is found, false otherwise
-    /// </returns>
+    /// <inheritdoc />
     protected override bool TryFindRawArgumentValue(string[] allCommandLineArguments, string argumentToFind, out string value)
     {
       var result = false;
@@ -92,15 +77,7 @@ protected override bool TryFindRawArgumentValue(string[] allCommandLineArguments
       return result;
     }
 
-    /// <summary>
-    /// Gets whether the specified command line arguments contain a Help argument or not
-    /// </summary>
-    /// <param name="allCommandLineArguments">
-    /// The collection of all command line arguments
-    /// </param>
-    /// <returns>
-    /// True when the collection of command line arguments contains a Help argument, false otherwise
-    /// </returns>
+    /// <inheritdoc />
     protected override bool ContainsHelpArgument(string[] allCommandLineArguments)
     {
       var completeHelpArgument = this._keyPrefix + "help";

src/AtleX.CommandLineArguments/Parsers/TypeParsers/BoolTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class BoolTypeParser
   : TypeParser<bool>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out bool parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/ByteTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class ByteTypeParser
   : TypeParser<byte>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out byte parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/CharTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class CharTypeParser
   : TypeParser<char>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out char parseResult)
     {
       var result = (!string.IsNullOrEmpty(value) && value.Length == 1);

src/AtleX.CommandLineArguments/Parsers/TypeParsers/DateTimeTypeParser.cs

@@ -8,18 +8,7 @@ namespace AtleX.CommandLineArguments.Parsers.TypeParsers
   internal sealed class DateTimeTypeParser
   : TypeParser<DateTime>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out DateTime parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/DecimalTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class DecimalTypeParser
   : TypeParser<decimal>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out decimal parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/DoubleTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class DoubleTypeParser
   : TypeParser<double>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out double parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/FloatTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class FloatTypeParser
   : TypeParser<float>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out float parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/IntTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class IntTypeParser
   : TypeParser<int>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out int parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/LongTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class LongTypeParser
   : TypeParser<long>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out long parseResult)
     {
       bool result;

src/AtleX.CommandLineArguments/Parsers/TypeParsers/ShortTypeParser.cs

@@ -6,18 +6,7 @@
   internal sealed class ShortTypeParser
   : TypeParser<short>
   {
-    /// <summary>
-    /// Tries to parse the specified value to the specified parse result
-    /// </summary>
-    /// <param name="value">
-    /// The value to parse
-    /// </param>
-    /// <param name="parseResult">
-    /// The parsed value
-    /// </param>
-    /// <returns>
-    /// True if value was converted successfully; otherwise, false
-    /// </returns>
+    /// <inheritdoc />
     public override bool TryParse(string value, out short parseResult)
     {
       bool result;