Make stream public and add doc #1011
Conversation
| } | ||
|
|
||
| /// <summary> | ||
| /// Ensures that the buffer is filled |
There was a problem hiding this comment.
not that it is filled, but that it is not empty.
|
I am OK with this. |
| { | ||
| internal class BufferedReadStream : Stream | ||
| /// <summary> | ||
| /// A Stream that wraps another stream and allows reading lines |
There was a problem hiding this comment.
End the sentence with a period. Doc comments are kind of like HTML, where newlines are just whitespace. For that reason, every sentence needs to be a complete sentence because it will all show up as one paragraph in the final docs.
| /// <summary> | ||
| /// Creates a new stream | ||
| /// </summary> | ||
| /// <param name="inner">Wrapped stream</param> |
There was a problem hiding this comment.
Would this be The stream to wrap.?
| } | ||
|
|
||
| /// <summary> | ||
| /// The currently buffered data |
There was a problem hiding this comment.
See earlier comment about ending sentences with periods. Please apply to all new doc comments.
| /// <summary> | ||
| /// Ensures that the buffer is not empty | ||
| /// </summary> | ||
| /// <returns>buffer has data</returns> |
There was a problem hiding this comment.
For these types of docs, you can do something similar to this: https://github.com/aspnet/Mvc/blob/760c8f38678118734399c58c2dac981ea6e47046/src/Microsoft.AspNetCore.Mvc.Abstractions/Formatters/IOutputFormatter.cs#L18
/// <returns>Returns <c>true</c> if the formatter can write the response; <c>false</c> otherwise.</returns>
| /// <summary> | ||
| /// Ensures that a minimum amount of buffered data is available | ||
| /// </summary> | ||
| /// <param name="minCount">Minimum amount of buffered data</param> |
| /// Ensures that a minimum amount of buffered data is available | ||
| /// </summary> | ||
| /// <param name="minCount">Minimum amount of buffered data</param> | ||
| /// <returns>Minimum amount of buffered data available</returns> |
4 participants
Changes: