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.

Sign up for GitHub

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

Add ObjectDisposedException.ThrowIf XML comments #72411

Merged
merged 2 commits into from
Jul 19, 2022
Merged

Add ObjectDisposedException.ThrowIf XML comments #72411

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea252fd
Add ObjectDisposedException.ThrowIf XML comments
stephentoub Jul 18, 2022
348c2eb
Apply suggestions from code review
stephentoub Jul 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/libraries/System.Private.CoreLib/src/System/ObjectDisposedException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ protected ObjectDisposedException(SerializationInfo info, StreamingContext conte
_objectName = info.GetString("ObjectName");
}

/// <summary>Throws an <see cref="ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
/// <param name="condition">The condition to evaluate.</param>
/// <param name="instance">The object whose type's full name should be included in any resulting <see cref="ObjectDisposedException"/>.</param>
/// <exception cref="ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
[StackTraceHidden]
public static void ThrowIf([DoesNotReturnIf(true)] bool condition, object instance)
{
Expand All @@ -55,6 +59,10 @@ public static void ThrowIf([DoesNotReturnIf(true)] bool condition, object instan
}
}

/// <summary>Throws an <see cref="ObjectDisposedException"/> if the specified <paramref name="condition"/> is <see langword="true"/>.</summary>
/// <param name="condition">The condition to evaluate.</param>
/// <param name="type">The type whose full name should be included in any resulting <see cref="ObjectDisposedException"/>.</param>
/// <exception cref="ObjectDisposedException">The <paramref name="condition"/> is <see langword="true"/>.</exception>
[StackTraceHidden]
public static void ThrowIf([DoesNotReturnIf(true)] bool condition, Type type)
{
Expand Down