Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup parameter xml summaries #1209

Merged
merged 1 commit into from Dec 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions Src/FluentAssertions/Common/IClock.cs
Expand Up @@ -12,14 +12,14 @@ public interface IClock
/// <summary>
/// Will block the current thread until a time delay has passed.
/// </summary>
/// <param name="delay">The time span to wait before completing the returned task</param>
/// <param name="timeToDelay">The time span to wait before completing the returned task</param>
void Delay(TimeSpan timeToDelay);

/// <summary>
/// Creates a task that will complete after a time delay.
/// </summary>
/// <param name="delay">The time span to wait before completing the returned task</param>
/// <param name="timeoutCancellationTokenSource"></param>
/// <param name="cancellationToken"></param>
/// <returns>A task that represents the time delay.</returns>
/// <seealso cref="Task.Delay(TimeSpan)"/>
Task DelayAsync(TimeSpan delay, CancellationToken cancellationToken);
Expand Down
3 changes: 0 additions & 3 deletions Src/FluentAssertions/Equivalency/IMemberSelectionRule.cs
Expand Up @@ -21,9 +21,6 @@ public interface IMemberSelectionRule
/// A collection of members that was prepopulated by other selection rules. Can be empty.</param>
/// <param name="context"></param>
/// <param name="config"></param>
/// <param name="info">
/// Type info about the subject.
/// </param>
/// <returns>
/// The collection of members after applying this rule. Can contain less or more than was passed in.
/// </returns>
Expand Down
4 changes: 0 additions & 4 deletions Src/FluentAssertions/Events/EventAssertions.cs
Expand Up @@ -27,7 +27,6 @@ protected internal EventAssertions(IMonitor<T> monitor) : base(monitor.Subject)
/// <summary>
/// Asserts that an object has raised a particular event at least once.
/// </summary>
/// <param name="eventSource">The object exposing the event.</param>
/// <param name="eventName">
/// The name of the event that should have been raised.
/// </param>
Expand Down Expand Up @@ -59,7 +58,6 @@ public IEventRecorder Raise(string eventName, string because = "", params object
/// <summary>
/// Asserts that an object has not raised a particular event.
/// </summary>
/// <param name="eventSource">The object exposing the event.</param>
/// <param name="eventName">
/// The name of the event that should not be raised.
/// </param>
Expand Down Expand Up @@ -88,7 +86,6 @@ public void NotRaise(string eventName, string because = "", params object[] beca
/// <summary>
/// Asserts that an object has raised the <see cref="INotifyPropertyChanged.PropertyChanged"/> event for a particular property.
/// </summary>
/// <param name="eventSource">The object exposing the event.</param>
/// <param name="propertyExpression">
/// A lambda expression referring to the property for which the property changed event should have been raised, or
/// <c>null</c> to refer to all properties.
Expand Down Expand Up @@ -124,7 +121,6 @@ public void NotRaise(string eventName, string because = "", params object[] beca
/// <summary>
/// Asserts that an object has not raised the <see cref="INotifyPropertyChanged.PropertyChanged"/> event for a particular property.
/// </summary>
/// <param name="eventSource">The object exposing the event.</param>
/// <param name="propertyExpression">
/// A lambda expression referring to the property for which the property changed event should have been raised.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion Src/FluentAssertions/Execution/IAssertionScope.cs
Expand Up @@ -84,7 +84,7 @@ public interface IAssertionScope : IDisposable
/// If an expectation was set through a prior call to <see cref="AssertionScope.WithExpectation"/>, then the failure message is appended to that
/// expectation.
/// </remarks>
/// <param name="expectation">The format string that represents the failure message.</param>
/// <param name="message">The format string that represents the failure message.</param>
/// <param name="args">Optional arguments to any numbered placeholders.</param>
IAssertionScope WithExpectation(string message, params object[] args);

Expand Down
Expand Up @@ -17,22 +17,7 @@ public bool CanHandle(object value)
return value is AggregateException;
}

/// <summary>
/// Returns a <see cref="System.String" /> that represents this instance.
/// </summary>
/// <param name="value">The value for which to create a <see cref="System.String"/>.</param>
/// <param name="context"> </param>
/// <param name="formatChild"></param>
/// <param name="processedObjects">
/// A collection of objects that
/// </param>
/// <param name="nestedPropertyLevel">
/// The level of nesting for the supplied value. This is used for indenting the format string for objects that have
/// no <see cref="object.ToString()"/> override.
/// </param>
/// <returns>
/// A <see cref="System.String" /> that represents this instance.
/// </returns>
/// <inheritdoc />
public string Format(object value, FormattingContext context, FormatChild formatChild)
{
var exception = (AggregateException)value;
Expand Down
16 changes: 1 addition & 15 deletions Src/FluentAssertions/Formatting/ByteValueFormatter.cs
Expand Up @@ -14,21 +14,7 @@ public bool CanHandle(object value)
return value is byte;
}

/// <summary>
/// Returns a <see cref="System.String" /> that represents this instance.
/// </summary>
/// <param name="value">The value for which to create a <see cref="System.String"/>.</param>
/// <param name="useLineBreaks"> </param>
/// <param name="processedObjects">
/// A collection of objects that
/// </param>
/// <param name="nestedPropertyLevel">
/// The level of nesting for the supplied value. This is used for indenting the format string for objects that have
/// no <see cref="object.ToString()"/> override.
/// </param>
/// <returns>
/// A <see cref="System.String" /> that represents this instance.
/// </returns>
/// <inheritdoc />
public string Format(object value, FormattingContext context, FormatChild formatChild)
{
return "0x" + ((byte)value).ToString("X2");
Expand Down
2 changes: 1 addition & 1 deletion Src/FluentAssertions/Types/MethodInfoSelectorAssertions.cs
Expand Up @@ -18,7 +18,7 @@ public class MethodInfoSelectorAssertions
/// <summary>
/// Initializes a new instance of the <see cref="MethodInfoSelectorAssertions"/> class.
/// </summary>
/// <param name="methodInfo">The methods to assert.</param>
/// <param name="methods">The methods to assert.</param>
public MethodInfoSelectorAssertions(params MethodInfo[] methods)
{
SubjectMethods = methods;
Expand Down