Skip to content

Commit b4bd52b

Browse files
Jan JahodaJan Jahoda
andauthored
Http sync follow up (#4905)
* Add the http sync follow up * Fix closing tag Co-authored-by: Jan Jahoda <[email protected]>
1 parent 2d73781 commit b4bd52b

11 files changed

+25
-160
lines changed

xml/System.Net.Http/ByteArrayContent.xml

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -159,14 +159,7 @@
159159
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
160160
<summary>Creates an HTTP content stream for reading. It uses the memory from the <see cref="T:System.Net.Http.ByteArrayContent" /> as a backing store.</summary>
161161
<returns>The HTTP content stream.</returns>
162-
<remarks>
163-
<format type="text/markdown"><![CDATA[
164-
165-
## Remarks
166-
This operation blocks until all of the content stream has been created.
167-
168-
]]></format>
169-
</remarks>
162+
<remarks>To be added.</remarks>
170163
</Docs>
171164
</Member>
172165
<Member MemberName="CreateContentReadStreamAsync">
@@ -237,14 +230,7 @@ This operation blocks until all of the content stream has been created.
237230
<param name="context">Optional information about the transport, like the channel binding token. This parameter can be <see langword="null" />.</param>
238231
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
239232
<summary>Serializes and writes the byte array provided in the constructor to an HTTP content stream.</summary>
240-
<remarks>
241-
<format type="text/markdown"><![CDATA[
242-
243-
## Remarks
244-
This operation blocks until the whole byte array has been written to `stream` or until `cancellationToken` cancels the operation.
245-
246-
]]></format>
247-
</remarks>
233+
<remarks>To be added.</remarks>
248234
</Docs>
249235
</Member>
250236
<Member MemberName="SerializeToStreamAsync">

xml/System.Net.Http/DelegatingHandler.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,7 @@
228228
<remarks>
229229
<format type="text/markdown"><![CDATA[
230230
231-
## Remarks
232-
This operation blocks until the entire response, including content, is read.
231+
## Remarks
233232
234233
The <xref:System.Net.Http.DelegatingHandler.Send%2A> method is mainly used by the system and not by applications. When this method is called, it calls the <xref:System.Net.Http.DelegatingHandler.Send%2A> method on the inner handler.
235234

xml/System.Net.Http/HttpClient.xml

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2695,14 +2695,7 @@ The <paramref name="requestUri" /> is not an absolute URI.
26952695
<param name="request">The HTTP request message to send.</param>
26962696
<summary>Sends an HTTP request with the specified request.</summary>
26972697
<returns>An HTTP response message.</returns>
2698-
<remarks>
2699-
<format type="text/markdown"><![CDATA[
2700-
2701-
## Remarks
2702-
This operation blocks until the entire response, including content, is read.
2703-
2704-
]]></format>
2705-
</remarks>
2698+
<remarks>To be added.</remarks>
27062699
<exception cref="T:System.ArgumentNullException">The <paramref name="request" /> is <see langword="null" />.</exception>
27072700
<exception cref="T:System.NotSupportedException">The HTTP version is 2.0 or higher or the version policy is set to <see cref="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />.
27082701

@@ -2746,14 +2739,7 @@ The custom <see cref="T:System.Net.Http.HttpMessageHandler" /> does not override
27462739
<param name="completionOption">One of the enumeration values that specifies when the operation should complete (as soon as a response is available or after reading the response content).</param>
27472740
<summary>Sends an HTTP request.</summary>
27482741
<returns>The HTTP response message.</returns>
2749-
<remarks>
2750-
<format type="text/markdown"><![CDATA[
2751-
2752-
## Remarks
2753-
This operation blocks until the entire response, including content, is read.
2754-
2755-
]]></format>
2756-
</remarks>
2742+
<remarks>To be added.</remarks>
27572743
<exception cref="T:System.ArgumentNullException">The <paramref name="request" /> is <see langword="null" />.</exception>
27582744
<exception cref="T:System.NotSupportedException">The HTTP version is 2.0 or higher or the version policy is set to <see cref="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />.
27592745

@@ -2797,14 +2783,7 @@ The custom <see cref="T:System.Net.Http.HttpMessageHandler" /> does not override
27972783
<param name="cancellationToken">The token to cancel the operation.</param>
27982784
<summary>Sends an HTTP request with the specified request and cancellation token.</summary>
27992785
<returns>The HTTP response message.</returns>
2800-
<remarks>
2801-
<format type="text/markdown"><![CDATA[
2802-
2803-
## Remarks
2804-
This operation blocks until the entire response, including content, is read or `cancellationToken` cancels the operation.
2805-
2806-
]]></format>
2807-
</remarks>
2786+
<remarks>To be added.</remarks>
28082787
<exception cref="T:System.ArgumentNullException">The <paramref name="request" /> is <see langword="null" />.</exception>
28092788
<exception cref="T:System.NotSupportedException">The HTTP version is 2.0 or higher or the version policy is set to <see cref="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />.
28102789

@@ -2854,14 +2833,7 @@ The custom <see cref="T:System.Net.Http.HttpMessageHandler" /> does not override
28542833
<param name="cancellationToken">The token to cancel the operation.</param>
28552834
<summary>Sends an HTTP request with the specified request, completion option and cancellation token.</summary>
28562835
<returns>The HTTP response message.</returns>
2857-
<remarks>
2858-
<format type="text/markdown"><![CDATA[
2859-
2860-
## Remarks
2861-
This operation blocks until the entire response, including content, is read or `cancellationToken` cancels the operation.
2862-
2863-
]]></format>
2864-
</remarks>
2836+
<remarks>To be added.</remarks>
28652837
<exception cref="T:System.ArgumentNullException">The <paramref name="request" /> is <see langword="null" />.</exception>
28662838
<exception cref="T:System.NotSupportedException">The HTTP version is 2.0 or higher or the version policy is set to <see cref="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />.
28672839

xml/System.Net.Http/HttpClientHandler.xml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -832,14 +832,7 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA
832832
<param name="cancellationToken">A cancellation token to cancel the operation.</param>
833833
<summary>Creates an instance of <see cref="T:System.Net.Http.HttpResponseMessage" /> based on the information provided in the <see cref="T:System.Net.Http.HttpRequestMessage" />.</summary>
834834
<returns>The HTTP response message.</returns>
835-
<remarks>
836-
<format type="text/markdown"><![CDATA[
837-
838-
## Remarks
839-
This operation blocks until the response message is read.
840-
841-
]]></format>
842-
</remarks>
835+
<remarks>To be added.</remarks>
843836
<exception cref="T:System.ArgumentNullException">The <paramref name="request" /> was <see langword="null" />.</exception>
844837
<exception cref="T:System.NotSupportedException">For HTTP/2 and higher or when requesting version upgrade is enabled by <see cref="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />.
845838

xml/System.Net.Http/HttpContent.xml

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,7 @@
9292
<param name="context">Information about the transport (for example, the channel binding token). This parameter may be <see langword="null" />.</param>
9393
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
9494
<summary>Serializes the HTTP content into a stream of bytes and copies it to <paramref name="stream" />.</summary>
95-
<remarks>
96-
<format type="text/markdown"><![CDATA[
97-
98-
## Remarks
99-
This operation blocks until all of the content is written to the stream object.
100-
101-
]]></format>
102-
</remarks>
95+
<remarks>To be added.</remarks>
10396
<exception cref="T:System.ArgumentNullException">The <paramref name="stream" /> was <see langword="null" />.</exception>
10497
</Docs>
10598
</Member>
@@ -747,14 +740,7 @@ This operation blocks until all of the content is written to the stream object.
747740
<Docs>
748741
<summary>Serializes the HTTP content and returns a stream that represents the content.</summary>
749742
<returns>The stream that represents the HTTP content.</returns>
750-
<remarks>
751-
<format type="text/markdown"><![CDATA[
752-
753-
## Remarks
754-
This operation blocks until all of the stream that represents content has been read.
755-
756-
]]></format>
757-
</remarks>
743+
<remarks>To be added.</remarks>
758744
</Docs>
759745
</Member>
760746
<Member MemberName="ReadAsStream">
@@ -782,14 +768,7 @@ This operation blocks until all of the stream that represents content has been r
782768
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
783769
<summary>Serializes the HTTP content and returns a stream that represents the content.</summary>
784770
<returns>The stream that represents the HTTP content.</returns>
785-
<remarks>
786-
<format type="text/markdown"><![CDATA[
787-
788-
## Remarks
789-
This operation blocks until all of the stream that represents content has been read.
790-
791-
]]></format>
792-
</remarks>
771+
<remarks>To be added.</remarks>
793772
</Docs>
794773
</Member>
795774
<Member MemberName="ReadAsStreamAsync">
@@ -989,16 +968,9 @@ This operation blocks until all of the stream that represents content has been r
989968
<param name="stream">The target stream.</param>
990969
<param name="context">Information about the transport (for example, the channel binding token). This parameter may be <see langword="null" />.</param>
991970
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
992-
<summary>When overridden in a derived class, serializes the HTTP content to a stream. Otherwise, throws a <see cref="T:System.NotImplementedException" />.</summary>
993-
<remarks>
994-
<format type="text/markdown"><![CDATA[
995-
996-
## Remarks
997-
This operation blocks until all of the content has been serialized to the stream object.
998-
999-
]]></format>
1000-
</remarks>
1001-
<exception cref="T:System.NotImplementedException">The method is not overridden in the derived class.</exception>
971+
<summary>When overridden in a derived class, serializes the HTTP content to a stream. Otherwise, throws a <see cref="T:System.NotSupportedException" />.</summary>
972+
<remarks>To be added.</remarks>
973+
<exception cref="T:System.NotSupportedException">The method is not overridden in the derived class.</exception>
1002974
</Docs>
1003975
</Member>
1004976
<Member MemberName="SerializeToStreamAsync">

xml/System.Net.Http/HttpMessageHandler.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,10 @@
198198
<Docs>
199199
<param name="request">The HTTP request message to send.</param>
200200
<param name="cancellationToken">The cancellation token to cancel operation.</param>
201-
<summary>When overridden in a derived class, sends an HTTP request with the specified request and cancellation token. Otherwise, throws a <see cref="T:System.NotImplementedException" />.</summary>
201+
<summary>When overridden in a derived class, sends an HTTP request with the specified request and cancellation token. Otherwise, throws a <see cref="T:System.NotSupportedException" />.</summary>
202202
<returns>The HTTP response message.</returns>
203203
<remarks>To be added.</remarks>
204-
<exception cref="T:System.NotImplementedException">The method is not overridden in the derived class.</exception>
204+
<exception cref="T:System.NotSupportedException">The method is not overridden in the derived class.</exception>
205205
</Docs>
206206
</Member>
207207
<Member MemberName="SendAsync">

xml/System.Net.Http/HttpMessageInvoker.xml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -234,16 +234,7 @@
234234
<param name="cancellationToken">The cancellation token to cancel operation.</param>
235235
<summary>Sends an HTTP request with the specified request and cancellation token.</summary>
236236
<returns>The HTTP response message.</returns>
237-
<remarks>
238-
<format type="text/markdown"><![CDATA[
239-
240-
## Remarks
241-
This operation blocks until the entire response, including content, is read.
242-
243-
Most applications that are connecting to a web site will use one of the <xref:System.Net.Http.HttpClient.Send%2A> or <xref:System.Net.Http.HttpClient.SendAsync%2A> methods on the <xref:System.Net.Http.HttpClient> class.
244-
245-
]]></format>
246-
</remarks>
237+
<remarks>To be added.</remarks>
247238
<exception cref="T:System.ArgumentNullException">The <paramref name="request" /> was <see langword="null" />.</exception>
248239
<exception cref="T:System.NotSupportedException">For HTTP/2 and higher or when requesting version upgrade is enabled by <see cref="F:System.Net.Http.HttpVersionPolicy.RequestVersionOrHigher" />.
249240

xml/System.Net.Http/MessageProcessingHandler.xml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -230,14 +230,7 @@
230230
<param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
231231
<summary>Sends an HTTP request to the inner handler to send to the server.</summary>
232232
<returns>The HTTP response message.</returns>
233-
<remarks>
234-
<format type="text/markdown"><![CDATA[
235-
236-
## Remarks
237-
This operation blocks until the entire response, including content, is read, or until `cancellationToken` cancels the operation.
238-
239-
]]></format>
240-
</remarks>
233+
<remarks>To be added.</remarks>
241234
</Docs>
242235
</Member>
243236
<Member MemberName="SendAsync">

xml/System.Net.Http/MultipartContent.xml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,6 @@
221221
## Remarks
222222
This method overrides <xref:System.Net.Http.HttpContent.CreateContentReadStream%2A?displayProperty=nameWithType> to use a custom stream that contains an array, with each HTTP content entity and its boundary encoded and serialized to a <xref:System.IO.MemoryStream> instance.
223223
224-
This operation blocks until all of the content has been written to the memory stream.
225-
226224
]]></format>
227225
</remarks>
228226
</Docs>
@@ -447,14 +445,7 @@ This operation blocks until all of the content has been written to the memory st
447445
<param name="context">Information about the transport (for example, the channel binding token). This parameter may be <see langword="null" />.</param>
448446
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
449447
<summary>Serializes the multipart HTTP content to a stream.</summary>
450-
<remarks>
451-
<format type="text/markdown"><![CDATA[
452-
453-
## Remarks
454-
This operation blocks untill all of the content has been serialized to the stream object passed in the `stream` parameter.
455-
456-
]]></format>
457-
</remarks>
448+
<remarks>To be added.</remarks>
458449
</Docs>
459450
</Member>
460451
<Member MemberName="SerializeToStreamAsync">

xml/System.Net.Http/ReadOnlyMemoryContent.xml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,7 @@
138138
<param name="context">Information about the transport (for example, the channel binding token). This parameter may be <see langword="null" />.</param>
139139
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
140140
<summary>Serializes the multipart HTTP content to a stream.</summary>
141-
<remarks>
142-
<format type="text/markdown"><![CDATA[
143-
144-
## Remarks
145-
This operation blocks until all of the content has been serialized to the stream object passed as the `stream` parameter.
146-
147-
]]></format>
148-
</remarks>
141+
<remarks>To be added.</remarks>
149142
</Docs>
150143
</Member>
151144
<Member MemberName="SerializeToStreamAsync">

xml/System.Net.Http/StreamContent.xml

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -150,18 +150,9 @@ The <xref:System.Net.Http.StreamContent> object calls <xref:System.IO.Stream.Dis
150150
</Parameters>
151151
<Docs>
152152
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
153-
<summary>Writes the HTTP stream content to a memory stream.</summary>
153+
<summary>Returns the HTTP stream as a read-only stream.</summary>
154154
<returns>The HTTP content stream.</returns>
155-
<remarks>
156-
<format type="text/markdown"><![CDATA[
157-
158-
## Remarks
159-
This operation blocks until all of the content has been written to the memory stream.
160-
161-
The <xref:System.Net.Http.StreamContent.CreateContentReadStream%2A> method buffers the content to a memory stream. Derived classes can override this behavior if there's a better way to retrieve the content as stream. For example, a byte array or a string could use a more efficient mechanism, such as wrapping a read-only <xref:System.IO.MemoryStream> around the bytes or string.
162-
163-
]]></format>
164-
</remarks>
155+
<remarks>To be added.</remarks>
165156
</Docs>
166157
</Member>
167158
<Member MemberName="CreateContentReadStreamAsync">
@@ -192,18 +183,9 @@ This operation blocks until all of the content has been written to the memory st
192183
</ReturnValue>
193184
<Parameters />
194185
<Docs>
195-
<summary>Write the HTTP stream content to a memory stream as an asynchronous operation.</summary>
186+
<summary>Returns the HTTP stream as a read-only stream as an asynchronous operation.</summary>
196187
<returns>The task object representing the asynchronous operation.</returns>
197-
<remarks>
198-
<format type="text/markdown"><![CDATA[
199-
200-
## Remarks
201-
This operation will not block. The returned <xref:System.Threading.Tasks.Task%601> object will complete after all of the content has been written to the memory stream.
202-
203-
The <xref:System.Net.Http.StreamContent.CreateContentReadStreamAsync%2A> 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 <xref:System.IO.MemoryStream> around the bytes or string.)
204-
205-
]]></format>
206-
</remarks>
188+
<remarks>To be added.</remarks>
207189
</Docs>
208190
</Member>
209191
<Member MemberName="Dispose">
@@ -277,14 +259,7 @@ This operation blocks until all of the content has been written to the memory st
277259
<param name="context">Information about the transport (for example, the channel binding token). This parameter may be <see langword="null" />.</param>
278260
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
279261
<summary>Serializes the multipart HTTP content to a stream.</summary>
280-
<remarks>
281-
<format type="text/markdown"><![CDATA[
282-
283-
## Remarks
284-
This operation blocks until all of the content has been serialized to the stream object passed as the `stream` parameter.
285-
286-
]]></format>
287-
</remarks>
262+
<remarks>To be added.</remarks>
288263
</Docs>
289264
</Member>
290265
<Member MemberName="SerializeToStreamAsync">

0 commit comments

Comments
 (0)