Skip to content

Commit ae1563d

Browse files
AArnottethomson
authored andcommitted
Improve xml doc comments for extensibility point API
1 parent f6f3cb6 commit ae1563d

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

LibGit2Sharp/SmartSubtransportStream.cs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,20 @@ protected virtual void Free()
4444
}
4545

4646
/// <summary>
47-
/// Requests that the stream write the next length bytes of the stream to the provided Stream object.
47+
/// Reads from the transport into the provided <paramref name="dataStream"/> object.
4848
/// </summary>
49+
/// <param name="dataStream">The stream to copy the read bytes into.</param>
50+
/// <param name="length">The number of bytes expected from the underlying transport.</param>
51+
/// <param name="bytesRead">Receives the number of bytes actually read.</param>
52+
/// <returns>The error code to propagate back to the native code that requested this operation. 0 is expected, and exceptions may be thrown.</returns>
4953
public abstract int Read(Stream dataStream, long length, out long bytesRead);
5054

5155
/// <summary>
52-
/// Requests that the stream write the first length bytes of the provided Stream object to the stream.
56+
/// Writes the content of a given stream to the transport.
5357
/// </summary>
58+
/// <param name="dataStream">The stream with the data to write to the transport.</param>
59+
/// <param name="length">The number of bytes to read from <paramref name="dataStream"/>.</param>
60+
/// <returns>The error code to propagate back to the native code that requested this operation. 0 is expected, and exceptions may be thrown.</returns>
5461
public abstract int Write(Stream dataStream, long length);
5562

5663
/// <summary>

0 commit comments

Comments
 (0)