-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename ICommandLineValidatable.Validate to ICommandLineProcessed.Proc…
…ess and update documentation.
- Loading branch information
Showing
4 changed files
with
28 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
namespace RT.CommandLine; | ||
|
||
/// <summary> | ||
/// Contains methods to post-process a class representing command-line options as populated by <see | ||
/// cref="CommandLineParser"/>.</summary> | ||
/// <remarks> | ||
/// If an input doesn’t parse correctly, throw <see cref="CommandLineValidationException"/> with a helpful, descriptive | ||
/// message that is displayed to the user.</remarks> | ||
public interface ICommandLineProcessed | ||
{ | ||
/// <summary> | ||
/// When implemented in a class, performs application-specific post-processing of the options class.</summary> | ||
/// <remarks> | ||
/// When <see cref="CommandLineParser"/> invokes this method, all parsed commands and options have already been | ||
/// populated. This method can thus alter the class in application-specific ways, perform further parsing, or further | ||
/// validate the options for constraints such as mutual exclusivity. To report a validation error, this method should | ||
/// throw a <see cref="CommandLineValidationException"/> with a helpful, descriptive message that is displayed to the | ||
/// user.</remarks> | ||
void Process(); | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters