Skip to content

Commit 63c3601

Browse files
committed
Add docs re wrapped stream ownership
1 parent 83d817f commit 63c3601

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/Serilog.Sinks.File/FileLifecycleHooks.cs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,13 @@ namespace Serilog
99
public abstract class FileLifecycleHooks
1010
{
1111
/// <summary>
12-
/// Wraps <paramref name="sourceStream"/> in another stream, such as a GZipStream, then returns the wrapped stream
12+
/// Wraps <paramref name="underlyingStream"/> in another stream, such as a GZipStream, then returns the wrapped stream
1313
/// </summary>
14-
/// <param name="sourceStream">The source log file stream</param>
14+
/// <remarks>
15+
/// Serilog is responsible for disposing of the wrapped stream
16+
/// </remarks>
17+
/// <param name="underlyingStream">The underlying log file stream</param>
1518
/// <returns>The wrapped stream</returns>
16-
public abstract Stream Wrap(Stream sourceStream);
19+
public abstract Stream Wrap(Stream underlyingStream);
1720
}
1821
}

0 commit comments

Comments
 (0)