Skip to content

Commit ee01b27

Browse files
committed
Add documentation for IsDefinedMouseAction too
1 parent 4cab64a commit ee01b27

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/Input/Command/MouseActionConverter.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,11 @@ public override object ConvertTo(ITypeDescriptorContext context, CultureInfo cul
110110
};
111111
}
112112

113-
// Helper like Enum.IsDefined, for MouseAction.
113+
/// <summary>
114+
/// Helper function similar to <see cref="Enum.IsDefined{MouseAction}(MouseAction)"/>, just lighter and faster.
115+
/// </summary>
116+
/// <param name="mouseAction">The value to test against.</param>
117+
/// <returns><see langword="true"/> if <paramref name="mouseAction"/> falls in enumeration range, <see langword="false"/> otherwise.</returns>
114118
internal static bool IsDefinedMouseAction(MouseAction mouseAction)
115119
{
116120
return mouseAction >= MouseAction.None && mouseAction <= MouseAction.MiddleDoubleClick;

0 commit comments

Comments
 (0)