Clean up doc comments for PushStreamContent (#311)

Fixes https://github.com/aspnet/AspNetWebStack/issues/310
This commit is contained in:
Pranav K 2022-01-13 15:49:37 -08:00 коммит произвёл GitHub
Родитель c55dd95aeb
Коммит d1df0c8297
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 23 добавлений и 10 удалений

Просмотреть файл

@ -25,7 +25,7 @@ namespace System.Net.Http
/// Initializes a new instance of the <see cref="PushStreamContent"/> class. The /// Initializes a new instance of the <see cref="PushStreamContent"/> class. The
/// <paramref name="onStreamAvailable"/> action is called when an output stream /// <paramref name="onStreamAvailable"/> action is called when an output stream
/// has become available allowing the action to write to it directly. When the /// has become available allowing the action to write to it directly. When the
/// stream is closed, it will signal to the content that is has completed and the /// stream is closed, it will signal to the content that it has completed and the
/// HTTP request or response will be completed. /// HTTP request or response will be completed.
/// </summary> /// </summary>
/// <param name="onStreamAvailable">The action to call when an output stream is available.</param> /// <param name="onStreamAvailable">The action to call when an output stream is available.</param>
@ -37,8 +37,9 @@ namespace System.Net.Http
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PushStreamContent"/> class. /// Initializes a new instance of the <see cref="PushStreamContent"/> class.
/// </summary> /// </summary>
/// <param name="onStreamAvailable">The action to call when an output stream is available. The stream is automatically /// <param name="onStreamAvailable">The action to call when an output stream is available. When the
/// closed when the return task is completed.</param> /// output stream is closed or disposed, it will signal to the content that it has completed and the
/// HTTP request or response will be completed.</param>
public PushStreamContent(Func<Stream, HttpContent, TransportContext, Task> onStreamAvailable) public PushStreamContent(Func<Stream, HttpContent, TransportContext, Task> onStreamAvailable)
: this(onStreamAvailable, (MediaTypeHeaderValue)null) : this(onStreamAvailable, (MediaTypeHeaderValue)null)
{ {
@ -47,6 +48,8 @@ namespace System.Net.Http
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given media type. /// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given media type.
/// </summary> /// </summary>
/// <param name="onStreamAvailable">The action to call when an output stream is available.</param>
/// <param name="mediaType">The value of the Content-Type content header on an HTTP response.</param>
public PushStreamContent(Action<Stream, HttpContent, TransportContext> onStreamAvailable, string mediaType) public PushStreamContent(Action<Stream, HttpContent, TransportContext> onStreamAvailable, string mediaType)
: this(Taskify(onStreamAvailable), new MediaTypeHeaderValue(mediaType)) : this(Taskify(onStreamAvailable), new MediaTypeHeaderValue(mediaType))
{ {
@ -55,6 +58,10 @@ namespace System.Net.Http
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given media type. /// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given media type.
/// </summary> /// </summary>
/// <param name="onStreamAvailable">The action to call when an output stream is available. When the
/// output stream is closed or disposed, it will signal to the content that it has completed and the
/// HTTP request or response will be completed.</param>
/// <param name="mediaType">The value of the Content-Type content header on an HTTP response.</param>
public PushStreamContent(Func<Stream, HttpContent, TransportContext, Task> onStreamAvailable, string mediaType) public PushStreamContent(Func<Stream, HttpContent, TransportContext, Task> onStreamAvailable, string mediaType)
: this(onStreamAvailable, new MediaTypeHeaderValue(mediaType)) : this(onStreamAvailable, new MediaTypeHeaderValue(mediaType))
{ {
@ -63,6 +70,8 @@ namespace System.Net.Http
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given <see cref="MediaTypeHeaderValue"/>. /// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given <see cref="MediaTypeHeaderValue"/>.
/// </summary> /// </summary>
/// <param name="onStreamAvailable">The action to call when an output stream is available.</param>
/// <param name="mediaType">The value of the Content-Type content header on an HTTP response.</param>
public PushStreamContent(Action<Stream, HttpContent, TransportContext> onStreamAvailable, MediaTypeHeaderValue mediaType) public PushStreamContent(Action<Stream, HttpContent, TransportContext> onStreamAvailable, MediaTypeHeaderValue mediaType)
: this(Taskify(onStreamAvailable), mediaType) : this(Taskify(onStreamAvailable), mediaType)
{ {
@ -71,6 +80,10 @@ namespace System.Net.Http
/// <summary> /// <summary>
/// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given <see cref="MediaTypeHeaderValue"/>. /// Initializes a new instance of the <see cref="PushStreamContent"/> class with the given <see cref="MediaTypeHeaderValue"/>.
/// </summary> /// </summary>
/// <param name="onStreamAvailable">The action to call when an output stream is available. When the
/// output stream is closed or disposed, it will signal to the content that it has completed and the
/// HTTP request or response will be completed.</param>
/// <param name="mediaType">The value of the Content-Type content header on an HTTP response.</param>
public PushStreamContent(Func<Stream, HttpContent, TransportContext, Task> onStreamAvailable, MediaTypeHeaderValue mediaType) public PushStreamContent(Func<Stream, HttpContent, TransportContext, Task> onStreamAvailable, MediaTypeHeaderValue mediaType)
{ {
if (onStreamAvailable == null) if (onStreamAvailable == null)