forked from nsubstitute/NSubstitute
-
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.
Adding some xmldoc to the public IArgumentMatcher and IDescribeNonMat…
…ches interfaces.
- Loading branch information
Showing
2 changed files
with
27 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,33 @@ | ||
namespace NSubstitute | ||
{ | ||
/// <summary> | ||
/// Provides a specification for arguments for use with <see ctype="Arg.Matches (IArgumentMatcher)" />. | ||
/// Can additionally implement <see ctype="IDescribeNonMatches" /> to give descriptions when arguments do not match. | ||
/// </summary> | ||
public interface IArgumentMatcher | ||
{ | ||
/// <summary> | ||
/// Checks whether the <paramref name="argument"/> satisfies the condition of the matcher. | ||
/// If this throws an exception the argument will be treated as non-matching. | ||
/// </summary> | ||
/// <param name="argument"></param> | ||
/// <returns></returns> | ||
bool IsSatisfiedBy(object argument); | ||
} | ||
|
||
/// <summary> | ||
/// Provides a specification for arguments for use with <see ctype="Arg.Matches < T >(IArgumentMatcher)" />. | ||
/// Can additionally implement <see ctype="IDescribeNonMatches" /> to give descriptions when arguments do not match. | ||
/// </summary> | ||
/// <typeparam name="T">Matches arguments of type <typeparamref name="T"/> or compatible type.</typeparam> | ||
public interface IArgumentMatcher<T> | ||
{ | ||
/// <summary> | ||
/// Checks whether the <paramref name="argument"/> satisfies the condition of the matcher. | ||
/// If this throws an exception the argument will be treated as non-matching. | ||
/// </summary> | ||
/// <param name="argument"></param> | ||
/// <returns></returns> | ||
bool IsSatisfiedBy(T argument); | ||
} | ||
} |
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