From 36b3814f4e0e472ea4a30783533b5e80974e3e4d Mon Sep 17 00:00:00 2001 From: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com> Date: Wed, 12 Oct 2022 22:53:18 +0300 Subject: [PATCH] Cleanup --- CliFx/ApplicationConfiguration.cs | 2 +- CliFx/ApplicationMetadata.cs | 2 +- CliFx/Attributes/CommandAttribute.cs | 4 ++-- CliFx/Attributes/CommandOptionAttribute.cs | 16 +++++++-------- CliFx/Attributes/CommandParameterAttribute.cs | 6 +++--- CliFx/CliApplication.cs | 2 +- CliFx/CliApplicationBuilder.cs | 20 +++++++++---------- CliFx/Exceptions/CliFxException.cs | 2 +- CliFx/Exceptions/CommandException.cs | 2 +- CliFx/Extensibility/BindingValidationError.cs | 2 +- CliFx/Extensibility/BindingValidator.cs | 2 +- CliFx/ICommand.cs | 2 +- CliFx/Infrastructure/ConsoleReader.cs | 6 +++--- CliFx/Infrastructure/ConsoleWriter.cs | 6 +++--- CliFx/Infrastructure/DefaultTypeActivator.cs | 2 +- CliFx/Infrastructure/DelegateTypeActivator.cs | 4 ++-- CliFx/Infrastructure/FakeConsole.cs | 8 ++++---- CliFx/Infrastructure/FakeInMemoryConsole.cs | 4 ++-- CliFx/Infrastructure/IConsole.cs | 8 ++++---- CliFx/Infrastructure/SystemConsole.cs | 4 ++-- 20 files changed, 52 insertions(+), 52 deletions(-) diff --git a/CliFx/ApplicationConfiguration.cs b/CliFx/ApplicationConfiguration.cs index 956ba9b..142a3e4 100644 --- a/CliFx/ApplicationConfiguration.cs +++ b/CliFx/ApplicationConfiguration.cs @@ -24,7 +24,7 @@ public class ApplicationConfiguration public bool IsPreviewModeAllowed { get; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public ApplicationConfiguration( IReadOnlyList commandTypes, diff --git a/CliFx/ApplicationMetadata.cs b/CliFx/ApplicationMetadata.cs index 99f7dab..958dd02 100644 --- a/CliFx/ApplicationMetadata.cs +++ b/CliFx/ApplicationMetadata.cs @@ -26,7 +26,7 @@ public class ApplicationMetadata public string? Description { get; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public ApplicationMetadata( string title, diff --git a/CliFx/Attributes/CommandAttribute.cs b/CliFx/Attributes/CommandAttribute.cs index a8717d7..9c8cace 100644 --- a/CliFx/Attributes/CommandAttribute.cs +++ b/CliFx/Attributes/CommandAttribute.cs @@ -26,7 +26,7 @@ public sealed class CommandAttribute : Attribute public string? Description { get; set; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CommandAttribute(string name) { @@ -34,7 +34,7 @@ public sealed class CommandAttribute : Attribute } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CommandAttribute() { diff --git a/CliFx/Attributes/CommandOptionAttribute.cs b/CliFx/Attributes/CommandOptionAttribute.cs index 729b6d8..2337ae0 100644 --- a/CliFx/Attributes/CommandOptionAttribute.cs +++ b/CliFx/Attributes/CommandOptionAttribute.cs @@ -14,7 +14,7 @@ public sealed class CommandOptionAttribute : Attribute /// /// /// Must contain at least two characters and start with a letter. - /// Either or must be set. + /// Either or must be set. /// All options in a command must have unique names (comparison IS NOT case-sensitive). /// public string? Name { get; } @@ -23,7 +23,7 @@ public sealed class CommandOptionAttribute : Attribute /// Option short name. /// /// - /// Either or must be set. + /// Either or must be set. /// All options in a command must have unique short names (comparison IS case-sensitive). /// public char? ShortName { get; } @@ -51,7 +51,7 @@ public sealed class CommandOptionAttribute : Attribute /// a value expected by the underlying property. /// /// - /// Converter must derive from . + /// Converter must derive from . /// public Type? Converter { get; set; } @@ -60,12 +60,12 @@ public sealed class CommandOptionAttribute : Attribute /// property, after it has been bound. /// /// - /// Validators must derive from . + /// Validators must derive from . /// public Type[] Validators { get; set; } = Array.Empty(); /// - /// Initializes an instance of . + /// Initializes an instance of . /// private CommandOptionAttribute(string? name, char? shortName) { @@ -74,7 +74,7 @@ public sealed class CommandOptionAttribute : Attribute } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CommandOptionAttribute(string name, char shortName) : this(name, (char?) shortName) @@ -82,7 +82,7 @@ public sealed class CommandOptionAttribute : Attribute } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CommandOptionAttribute(string name) : this(name, null) @@ -90,7 +90,7 @@ public sealed class CommandOptionAttribute : Attribute } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CommandOptionAttribute(char shortName) : this(null, (char?) shortName) diff --git a/CliFx/Attributes/CommandParameterAttribute.cs b/CliFx/Attributes/CommandParameterAttribute.cs index feb37aa..d47c4bb 100644 --- a/CliFx/Attributes/CommandParameterAttribute.cs +++ b/CliFx/Attributes/CommandParameterAttribute.cs @@ -51,7 +51,7 @@ public sealed class CommandParameterAttribute : Attribute /// a value expected by the underlying property. /// /// - /// Converter must derive from . + /// Converter must derive from . /// public Type? Converter { get; set; } @@ -60,12 +60,12 @@ public sealed class CommandParameterAttribute : Attribute /// property, after it has been bound. /// /// - /// Validators must derive from . + /// Validators must derive from . /// public Type[] Validators { get; set; } = Array.Empty(); /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CommandParameterAttribute(int order) { diff --git a/CliFx/CliApplication.cs b/CliFx/CliApplication.cs index 41ffeb7..afb7476 100644 --- a/CliFx/CliApplication.cs +++ b/CliFx/CliApplication.cs @@ -34,7 +34,7 @@ public class CliApplication private readonly CommandBinder _commandBinder; /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CliApplication( ApplicationMetadata metadata, diff --git a/CliFx/CliApplicationBuilder.cs b/CliFx/CliApplicationBuilder.cs index 6c5d47b..e88a4dc 100644 --- a/CliFx/CliApplicationBuilder.cs +++ b/CliFx/CliApplicationBuilder.cs @@ -12,7 +12,7 @@ using CliFx.Utils.Extensions; namespace CliFx; /// -/// Builder for . +/// Builder for . /// public partial class CliApplicationBuilder { @@ -58,8 +58,8 @@ public partial class CliApplicationBuilder /// Adds commands from the specified assembly to the application. /// /// - /// This method looks for public non-abstract classes that implement - /// and are annotated by . + /// This method looks for public non-abstract classes that implement + /// and are annotated by . /// public CliApplicationBuilder AddCommandsFrom(Assembly commandAssembly) { @@ -73,8 +73,8 @@ public partial class CliApplicationBuilder /// Adds commands from the specified assemblies to the application. /// /// - /// This method looks for public non-abstract classes that implement - /// and are annotated by . + /// This method looks for public non-abstract classes that implement + /// and are annotated by . /// public CliApplicationBuilder AddCommandsFrom(IEnumerable commandAssemblies) { @@ -88,8 +88,8 @@ public partial class CliApplicationBuilder /// Adds commands from the calling assembly to the application. /// /// - /// This method looks for public non-abstract classes that implement - /// and are annotated by . + /// This method looks for public non-abstract classes that implement + /// and are annotated by . /// public CliApplicationBuilder AddCommandsFromThisAssembly() => AddCommandsFrom(Assembly.GetCallingAssembly()); @@ -159,7 +159,7 @@ public partial class CliApplicationBuilder } /// - /// Configures the application to use the specified implementation of . + /// Configures the application to use the specified implementation of . /// public CliApplicationBuilder UseConsole(IConsole console) { @@ -168,7 +168,7 @@ public partial class CliApplicationBuilder } /// - /// Configures the application to use the specified implementation of . + /// Configures the application to use the specified implementation of . /// public CliApplicationBuilder UseTypeActivator(ITypeActivator typeActivator) { @@ -189,7 +189,7 @@ public partial class CliApplicationBuilder UseTypeActivator(serviceProvider.GetService); /// - /// Creates a configured instance of . + /// Creates a configured instance of . /// public CliApplication Build() { diff --git a/CliFx/Exceptions/CliFxException.cs b/CliFx/Exceptions/CliFxException.cs index 9155497..61c779b 100644 --- a/CliFx/Exceptions/CliFxException.cs +++ b/CliFx/Exceptions/CliFxException.cs @@ -24,7 +24,7 @@ public partial class CliFxException : Exception public bool ShowHelp { get; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CliFxException( string message, diff --git a/CliFx/Exceptions/CommandException.cs b/CliFx/Exceptions/CommandException.cs index 03c83bd..558c1fe 100644 --- a/CliFx/Exceptions/CommandException.cs +++ b/CliFx/Exceptions/CommandException.cs @@ -9,7 +9,7 @@ namespace CliFx.Exceptions; public class CommandException : CliFxException { /// - /// Initializes an instance of . + /// Initializes an instance of . /// public CommandException( string message, diff --git a/CliFx/Extensibility/BindingValidationError.cs b/CliFx/Extensibility/BindingValidationError.cs index 94c6f70..c5f5df6 100644 --- a/CliFx/Extensibility/BindingValidationError.cs +++ b/CliFx/Extensibility/BindingValidationError.cs @@ -11,7 +11,7 @@ public class BindingValidationError public string Message { get; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public BindingValidationError(string message) => Message = message; } \ No newline at end of file diff --git a/CliFx/Extensibility/BindingValidator.cs b/CliFx/Extensibility/BindingValidator.cs index 67f2b81..acc3183 100644 --- a/CliFx/Extensibility/BindingValidator.cs +++ b/CliFx/Extensibility/BindingValidator.cs @@ -26,7 +26,7 @@ public abstract class BindingValidator : IBindingValidator /// Returns null if validation is successful, or an error in case of failure. /// /// - /// You can use the utility methods and to + /// You can use the utility methods and to /// create an appropriate result. /// public abstract BindingValidationError? Validate(T? value); diff --git a/CliFx/ICommand.cs b/CliFx/ICommand.cs index 33c0c01..3d0d5be 100644 --- a/CliFx/ICommand.cs +++ b/CliFx/ICommand.cs @@ -9,7 +9,7 @@ namespace CliFx; public interface ICommand { /// - /// Executes the command using the specified implementation of . + /// Executes the command using the specified implementation of . /// /// /// If the execution of the command is not asynchronous, simply end the method with diff --git a/CliFx/Infrastructure/ConsoleReader.cs b/CliFx/Infrastructure/ConsoleReader.cs index 4f30dde..9d7336a 100644 --- a/CliFx/Infrastructure/ConsoleReader.cs +++ b/CliFx/Infrastructure/ConsoleReader.cs @@ -7,7 +7,7 @@ using System.Threading.Tasks; namespace CliFx.Infrastructure; /// -/// Implements a for reading characters from a console stream. +/// Implements a for reading characters from a console stream. /// // Both the underlying stream AND the stream reader must be synchronized! // https://github.com/Tyrrrz/CliFx/issues/123 @@ -19,7 +19,7 @@ public partial class ConsoleReader : StreamReader public IConsole Console { get; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public ConsoleReader(IConsole console, Stream stream, Encoding encoding) : base(stream, encoding, false, 4096) @@ -28,7 +28,7 @@ public partial class ConsoleReader : StreamReader } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public ConsoleReader(IConsole console, Stream stream) : this(console, stream, System.Console.InputEncoding) diff --git a/CliFx/Infrastructure/ConsoleWriter.cs b/CliFx/Infrastructure/ConsoleWriter.cs index 86f074f..1138a7d 100644 --- a/CliFx/Infrastructure/ConsoleWriter.cs +++ b/CliFx/Infrastructure/ConsoleWriter.cs @@ -8,7 +8,7 @@ using CliFx.Utils; namespace CliFx.Infrastructure; /// -/// Implements a for writing characters to a console stream. +/// Implements a for writing characters to a console stream. /// // Both the underlying stream AND the stream writer must be synchronized! // https://github.com/Tyrrrz/CliFx/issues/123 @@ -20,7 +20,7 @@ public partial class ConsoleWriter : StreamWriter public IConsole Console { get; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public ConsoleWriter(IConsole console, Stream stream, Encoding encoding) : base(stream, encoding.WithoutPreamble(), 256) @@ -29,7 +29,7 @@ public partial class ConsoleWriter : StreamWriter } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public ConsoleWriter(IConsole console, Stream stream) : this(console, stream, System.Console.OutputEncoding) diff --git a/CliFx/Infrastructure/DefaultTypeActivator.cs b/CliFx/Infrastructure/DefaultTypeActivator.cs index d541c99..cd31e3f 100644 --- a/CliFx/Infrastructure/DefaultTypeActivator.cs +++ b/CliFx/Infrastructure/DefaultTypeActivator.cs @@ -4,7 +4,7 @@ using CliFx.Exceptions; namespace CliFx.Infrastructure; /// -/// Implementation of that instantiates an object +/// Implementation of that instantiates an object /// by using its parameterless constructor. /// public class DefaultTypeActivator : ITypeActivator diff --git a/CliFx/Infrastructure/DelegateTypeActivator.cs b/CliFx/Infrastructure/DelegateTypeActivator.cs index d3be063..64212f2 100644 --- a/CliFx/Infrastructure/DelegateTypeActivator.cs +++ b/CliFx/Infrastructure/DelegateTypeActivator.cs @@ -4,7 +4,7 @@ using CliFx.Exceptions; namespace CliFx.Infrastructure; /// -/// Implementation of that instantiates an object +/// Implementation of that instantiates an object /// by using a predefined function. /// public class DelegateTypeActivator : ITypeActivator @@ -12,7 +12,7 @@ public class DelegateTypeActivator : ITypeActivator private readonly Func _func; /// - /// Initializes an instance of . + /// Initializes an instance of . /// public DelegateTypeActivator(Func func) => _func = func; diff --git a/CliFx/Infrastructure/FakeConsole.cs b/CliFx/Infrastructure/FakeConsole.cs index 55cd633..4ab99f8 100644 --- a/CliFx/Infrastructure/FakeConsole.cs +++ b/CliFx/Infrastructure/FakeConsole.cs @@ -6,7 +6,7 @@ using System.Threading; namespace CliFx.Infrastructure; /// -/// Implementation of that uses the provided fake +/// Implementation of that uses the provided fake /// standard input, output, and error streams. /// /// @@ -54,7 +54,7 @@ public class FakeConsole : IConsole, IDisposable public int CursorTop { get; set; } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public FakeConsole(Stream? input = null, Stream? output = null, Stream? error = null) { @@ -73,7 +73,7 @@ public class FakeConsole : IConsole, IDisposable ); /// - /// Enqueues a simulated key press, which can then be read by calling . + /// Enqueues a simulated key press, which can then be read by calling . /// public void EnqueueKey(ConsoleKeyInfo key) => _keys.Enqueue(key); @@ -96,7 +96,7 @@ public class FakeConsole : IConsole, IDisposable /// Sends a cancellation signal to the currently executing command. /// /// - /// If the command is not cancellation-aware (i.e. it doesn't call ), + /// If the command is not cancellation-aware (i.e. it doesn't call ), /// this method will not have any effect. /// public void RequestCancellation(TimeSpan? delay = null) diff --git a/CliFx/Infrastructure/FakeInMemoryConsole.cs b/CliFx/Infrastructure/FakeInMemoryConsole.cs index 7a0a195..5ce76ab 100644 --- a/CliFx/Infrastructure/FakeInMemoryConsole.cs +++ b/CliFx/Infrastructure/FakeInMemoryConsole.cs @@ -3,7 +3,7 @@ namespace CliFx.Infrastructure; /// -/// Implementation of that uses fake +/// Implementation of that uses fake /// standard input, output, and error streams backed by in-memory stores. /// /// @@ -24,7 +24,7 @@ public class FakeInMemoryConsole : FakeConsole } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public FakeInMemoryConsole() : this(new MemoryStream(), new MemoryStream(), new MemoryStream()) diff --git a/CliFx/Infrastructure/IConsole.cs b/CliFx/Infrastructure/IConsole.cs index a8fbd70..a261ca0 100644 --- a/CliFx/Infrastructure/IConsole.cs +++ b/CliFx/Infrastructure/IConsole.cs @@ -105,12 +105,12 @@ public interface IConsole } /// -/// Extensions for . +/// Extensions for . /// public static class ConsoleExtensions { /// - /// Sets the specified foreground color and returns an + /// Sets the specified foreground color and returns an /// that will reset the color back to its previous value upon disposal. /// public static IDisposable WithForegroundColor(this IConsole console, ConsoleColor foregroundColor) @@ -122,7 +122,7 @@ public static class ConsoleExtensions } /// - /// Sets the specified background color and returns an + /// Sets the specified background color and returns an /// that will reset the color back to its previous value upon disposal. /// public static IDisposable WithBackgroundColor(this IConsole console, ConsoleColor backgroundColor) @@ -134,7 +134,7 @@ public static class ConsoleExtensions } /// - /// Sets the specified foreground and background colors and returns an + /// Sets the specified foreground and background colors and returns an /// that will reset the colors back to their previous values upon disposal. /// public static IDisposable WithColors( diff --git a/CliFx/Infrastructure/SystemConsole.cs b/CliFx/Infrastructure/SystemConsole.cs index 74fbaa6..4134830 100644 --- a/CliFx/Infrastructure/SystemConsole.cs +++ b/CliFx/Infrastructure/SystemConsole.cs @@ -4,7 +4,7 @@ using System.Threading; namespace CliFx.Infrastructure; /// -/// Implementation of that represents the real system console. +/// Implementation of that represents the real system console. /// public class SystemConsole : IConsole, IDisposable { @@ -71,7 +71,7 @@ public class SystemConsole : IConsole, IDisposable } /// - /// Initializes an instance of . + /// Initializes an instance of . /// public SystemConsole() {