Skip to content

Ported docs from System.Net #7117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 9, 2021
Merged

Ported docs from System.Net #7117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0dc465
Ported docs from https://github.com/dotnet/runtime/pull/57855
ManickaP Sep 8, 2021
7e86e1d
Update xml/System.Net.Http/HeaderEncodingSelector`1.xml
carlossanlop Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion xml/System.Net.Http/HeaderEncodingSelector`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<ReturnType>System.Text.Encoding</ReturnType>
</ReturnValue>
<Docs>
<typeparam name="TContext">To be added.</typeparam>
<typeparam name="TContext">The type of the headers that are being encoded/decoded.</typeparam>
<param name="headerName">The name of the header to specify for the encoding.</param>
<param name="context">The type we are encoding/decoding the headers for.</param>
<summary>Represents a method that specifies the encoding to use when interpreting header values.</summary>
Expand Down
19 changes: 15 additions & 4 deletions xml/System.Net.Http/HttpContent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,10 +311,21 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="net-5.0;net-6.0" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
<summary>Serializes the HTTP content to a memory stream.</summary>
<returns>The output memory stream which contains the serialized HTTP content.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Once the operation completes, the returned memory stream represents the HTTP content. The returned stream can then be used to read the content using various stream APIs.
The <xref:System.Net.Http.HttpContent.CreateContentReadStream(System.Threading.CancellationToken)> method buffers the content to a memory stream.
Derived classes can override this behavior if there is a better way to retrieve the content as stream.
For example, a byte array or a string could use a more efficient method way such as wrapping a read-only MemoryStream around the bytes or string.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CreateContentReadStreamAsync">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net.Http/SocketsHttpHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -768,7 +768,7 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r
<ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a writable dictionary (that is, a map) of custom properties for the HttpClient requests. The dictionary is initialized empty; you can insert and query key-value pairs for your custom handlers and special processing.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Net.Security/NegotiateStream.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4131,7 +4131,7 @@ This method reads asynchronously as much data as is available into `buffer` and
<param name="buffer">A region of memory that contains the data to write to the <see cref="T:System.Net.Security.NegotiateStream" />.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>Write asynchronously the specified number of <see cref="T:System.Byte" />s to the underlying stream.</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> that represents the asynchronous read operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down Expand Up @@ -4177,7 +4177,7 @@ This method reads asynchronously as much data as is available into `buffer` and
<param name="count">A <see cref="T:System.Int32" /> containing the number of bytes to read from <paramref name="buffer" />.</param>
<param name="cancellationToken">To be added.</param>
<summary>Write asynchronously the specified number of <see cref="T:System.Byte" />s to the underlying stream.</summary>
<returns>To be added.</returns>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous read operation.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net.Security/SslApplicationProtocol.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ For a complete list of supported protocols, see [TLS Application-Layer Protocol
<ReturnType>System.Net.Security.SslApplicationProtocol</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Defines a <see cref="T:System.Net.Security.SslApplicationProtocol" /> instance for HTTP 3.0.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down