aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Monteiro <marknr.monteiro@protonmail.com>2020-04-05 09:25:23 -0400
committerMark Monteiro <marknr.monteiro@protonmail.com>2020-04-05 09:25:23 -0400
commit3d8501e462c1b4f9953444873e3ea64e085916a0 (patch)
tree2c89fef22993c7ca4317bd422f0de98910299588
parent658e963e933319029d7cb730b2daab27e42feac5 (diff)
Document exception
-rw-r--r--MediaBrowser.Common/Extensions/ProcessExtensions.cs1
1 files changed, 1 insertions, 0 deletions
diff --git a/MediaBrowser.Common/Extensions/ProcessExtensions.cs b/MediaBrowser.Common/Extensions/ProcessExtensions.cs
index 6b205049d..c74787122 100644
--- a/MediaBrowser.Common/Extensions/ProcessExtensions.cs
+++ b/MediaBrowser.Common/Extensions/ProcessExtensions.cs
@@ -16,6 +16,7 @@ namespace MediaBrowser.Common.Extensions
/// <param name="process">The process to wait for.</param>
/// <param name="timeout">The duration to wait before cancelling waiting for the task.</param>
/// <returns>True if the task exited normally, false if the timeout elapsed before the process exited.</returns>
+ /// <exception cref="InvalidOperationException">If <see cref="Process.EnableRaisingEvents"/> is not set to true for the process.</exception>
public static async Task<bool> WaitForExitAsync(this Process process, TimeSpan timeout)
{
using (var cancelTokenSource = new CancellationTokenSource(timeout))