Skip to content

Commit

Permalink
Fixing the few missing documentation errors.
Browse files Browse the repository at this point in the history
  • Loading branch information
stazz committed Mar 19, 2019
1 parent 7226612 commit 3b4e8dc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion Source/Code/UtilPack.ProcessMonitor/ProcessMonitor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ Func<StreamWriter, Task> inputWriter
/// <param name="token">The <see cref="CancellationToken"/> to use to check on cancellation.</param>
/// <param name="stdinWriter">The optional callback to write input to the process. If no value is specified, the process will not have standard input.</param>
/// <param name="shutdownSemaphoreMaxWaitTime">The maximum time to wait for process to gracefully terminate after the cancellation token is canceled. By default, is value of <see cref="DefaultShutdownSemaphoreWaitTime"/>.</param>
/// <param name="onStdOutOrErrLine">The optional callback invoked on each event of <see cref="Process.OutputDataReceived"/>. The tuple first item is the string, the tuple second item is <c>true</c> if the string originates from error stream, and third item is the UTC <see cref="DateTime"/> when it was received by <see cref="Process.OutputDataReceived"/>.</param>
/// <returns>Asynchronously returns the process exit code. Will return <c>null</c> if given <paramref name="token"/> is canceled.</returns>
public static async Task<Int32?> CallProcessWithRedirects(
String processPath,
Expand Down Expand Up @@ -391,7 +392,7 @@ public static async Task StartProcessAsync(
/// <param name="shutdownSemaphoreName">The name of the semaphore used to signal graceful shutdown after <paramref name="token"/> cancellation. Do not use <c>"Global\"</c> prefix.</param>
/// <param name="token">The <see cref="CancellationToken"/> to use.</param>
/// <param name="stdinWriter">The optional callback to write input to the process. If no value is specified, the process will not have standard input.</param>
/// <param name="shutdownSemaphoreWaitTime">The maximum time to wait for process to gracefully terminate after the cancellation token is canceled. By default, is value of <see cref="DefaultShutdownSemaphoreWaitTime"/>.</param>
/// <param name="shutdownSemaphoreMaxWaitTime">The maximum time to wait for process to gracefully terminate after the cancellation token is canceled. By default, is value of <see cref="ProcessMonitorWithGracefulCancelability.DefaultShutdownSemaphoreWaitTime"/>.</param>
/// <param name="onTick">The optional callback to perform some action between polling for process state.</param>
/// <returns>Asynchronously returns the process exit code. Will return <c>null</c> if given <paramref name="token"/> is canceled.</returns>
/// <remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

<!-- Assembly information stuff -->
<PropertyGroup>
<VersionPrefix>1.0.0</VersionPrefix>
<VersionPrefix>2.0.0</VersionPrefix>
<VersionSuffix></VersionSuffix>
<AssemblyTitle>$(AssemblyName)</AssemblyTitle>
<Description>Easy-to-use API for spawning processes and waiting for their exit while keeping an eye on CancellationToken. Typically, extension and utitily methods of ProcessMonitorWithGracefulCancelability class from this package are used.</Description>
Expand All @@ -30,7 +30,7 @@
<PackageId>$(AssemblyName)</PackageId>
<PackageVersion>$(VersionPrefix)</PackageVersion>
<PackageVersion Condition=" '$(VersionSuffix)' != ''">$(PackageVersion)-$(VersionSuffix)</PackageVersion>
<PackageReleaseNotes>Initial release.</PackageReleaseNotes>
<PackageReleaseNotes>Complete rewrite of this library.</PackageReleaseNotes>
<PackageTags>utility async tabular data</PackageTags>
<Title>Process Monitoring</Title>
</PropertyGroup>
Expand Down

0 comments on commit 3b4e8dc

Please sign in to comment.