Skip to content

Commit edeee5d

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Port System.Net new docs (#10151)
* System.Net.Http * System.Net.Mime * System.Net.Quic * System.Net.Security * System.Net.ServerSentEvents * System.Net.Sockets --------- Co-authored-by: Genevieve Warren <[email protected]>
1 parent 412f1ea commit edeee5d

File tree

12 files changed

+71
-58
lines changed

12 files changed

+71
-58
lines changed

‎xml/System.Net.Http/HttpIOException.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@
101101
<summary>To be added.</summary>
102102
<value>To be added.</value>
103103
<remarks>To be added.</remarks>
104+
<inheritdoc />
104105
</Docs>
105106
</Member>
106107
</Members>

‎xml/System.Net.Mime/MediaTypeNames+Application.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
<ReturnType>System.String</ReturnType>
9494
</ReturnValue>
9595
<Docs>
96-
<summary>To be added.</summary>
96+
<summary>Specifies that the <see cref="T:System.Net.Mime.MediaTypeNames.Application" /> data is in gzip format.</summary>
9797
<remarks>To be added.</remarks>
9898
</Docs>
9999
</Member>

‎xml/System.Net.Mime/MediaTypeNames+Multipart.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
<ReturnType>System.String</ReturnType>
8888
</ReturnValue>
8989
<Docs>
90-
<summary>To be added.</summary>
90+
<summary>Specifies that the <see cref="T:System.Net.Mime.MediaTypeNames.Multipart" /> data is in mixed format.</summary>
9191
<remarks>To be added.</remarks>
9292
</Docs>
9393
</Member>
@@ -107,7 +107,7 @@
107107
<ReturnType>System.String</ReturnType>
108108
</ReturnValue>
109109
<Docs>
110-
<summary>To be added.</summary>
110+
<summary>Specifies that the <see cref="T:System.Net.Mime.MediaTypeNames.Multipart" /> data is in related format.</summary>
111111
<remarks>To be added.</remarks>
112112
</Docs>
113113
</Member>

‎xml/System.Net.Mime/MediaTypeNames+Text.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
<ReturnType>System.String</ReturnType>
108108
</ReturnValue>
109109
<Docs>
110-
<summary>To be added.</summary>
110+
<summary>Specifies that the <see cref="T:System.Net.Mime.MediaTypeNames.Text" /> data is in event stream format.</summary>
111111
<remarks>To be added.</remarks>
112112
</Docs>
113113
</Member>

‎xml/System.Net.Quic/QuicConnectionOptions.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ To use a different close error code, call <xref:System.Net.Quic.QuicConnection.C
102102
<ReturnType>System.TimeSpan</ReturnType>
103103
</ReturnValue>
104104
<Docs>
105-
<summary>To be added.</summary>
106-
<value>To be added.</value>
107-
<remarks>To be added.</remarks>
105+
<summary>Gets or sets the upper bound on time when the handshake must complete. If the handshake does not complete in this time, the connection is aborted.</summary>
106+
<value>The upper bound on time when the handshake must complete. The default is 10 seconds.</value>
107+
<remarks>A value of <see cref="F:System.TimeSpan.Zero" /> means use the underlying implementation default timeout.</remarks>
108108
</Docs>
109109
</Member>
110110
<Member MemberName="IdleTimeout">
@@ -147,7 +147,7 @@ To use a different close error code, call <xref:System.Net.Quic.QuicConnection.C
147147
<ReturnType>System.Net.Quic.QuicReceiveWindowSizes</ReturnType>
148148
</ReturnValue>
149149
<Docs>
150-
<summary>To be added.</summary>
150+
<summary>Gets or sets the initial receive window sizes for the connection and individual stream types.</summary>
151151
<value>To be added.</value>
152152
<remarks>To be added.</remarks>
153153
</Docs>
@@ -168,9 +168,9 @@ To use a different close error code, call <xref:System.Net.Quic.QuicConnection.C
168168
<ReturnType>System.TimeSpan</ReturnType>
169169
</ReturnValue>
170170
<Docs>
171-
<summary>To be added.</summary>
172-
<value>To be added.</value>
173-
<remarks>To be added.</remarks>
171+
<summary>Gets or sets the interval at which keep-alive packets are sent on the connection.</summary>
172+
<value>The interval at which keep-alive packets are sent on the connection. The default value is <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />, which means keep-alive packets are never sent.</value>
173+
<remarks>A value of <see cref="F:System.TimeSpan.Zero" /> means use the underlying implementation default timeout.</remarks>
174174
</Docs>
175175
</Member>
176176
<Member MemberName="MaxInboundBidirectionalStreams">

‎xml/System.Net.Quic/QuicReceiveWindowSizes.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Represents a collection of receive window sizes for <see cref="T:System.Net.Quic.QuicConnection" /> as a whole and for individual <see cref="T:System.Net.Quic.QuicStream" /> types.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -51,7 +51,7 @@
5151
<ReturnType>System.Int32</ReturnType>
5252
</ReturnValue>
5353
<Docs>
54-
<summary>To be added.</summary>
54+
<summary>Gets or sets the initial flow-control window size for the connection.</summary>
5555
<value>To be added.</value>
5656
<remarks>To be added.</remarks>
5757
</Docs>
@@ -72,7 +72,7 @@
7272
<ReturnType>System.Int32</ReturnType>
7373
</ReturnValue>
7474
<Docs>
75-
<summary>To be added.</summary>
75+
<summary>Gets or sets the initial flow-control window size for locally initiated bidirectional streams.</summary>
7676
<value>To be added.</value>
7777
<remarks>To be added.</remarks>
7878
</Docs>
@@ -93,7 +93,7 @@
9393
<ReturnType>System.Int32</ReturnType>
9494
</ReturnValue>
9595
<Docs>
96-
<summary>To be added.</summary>
96+
<summary>Gets or sets the initial flow-control window size for remotely initiated bidirectional streams.</summary>
9797
<value>To be added.</value>
9898
<remarks>To be added.</remarks>
9999
</Docs>
@@ -114,7 +114,7 @@
114114
<ReturnType>System.Int32</ReturnType>
115115
</ReturnValue>
116116
<Docs>
117-
<summary>To be added.</summary>
117+
<summary>Gets or sets the initial flow-control window size for (remotely initiated) unidirectional streams.</summary>
118118
<value>To be added.</value>
119119
<remarks>To be added.</remarks>
120120
</Docs>

‎xml/System.Net.Security/NegotiateAuthentication.xml

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,12 @@
109109
</Parameter>
110110
</Parameters>
111111
<Docs>
112-
<param name="message">To be added.</param>
113-
<param name="signatureWriter">To be added.</param>
114-
<summary>To be added.</summary>
115-
<remarks>To be added.</remarks>
112+
<param name="message">Input message for MIC calculation.</param>
113+
<param name="signatureWriter">Buffer writer where the MIC is written.</param>
114+
<summary>Computes the integrity check of a given message.</summary>
115+
<remarks><p>Implements the GSSAPI GetMIC operation.</p>
116+
<p>The method modifies the internal state and may update sequence numbers depending on the selected algorithm. Two successive invocations thus don't produce the same result and it's important to carefully pair GetMIC and VerifyMIC calls on the both sides of the authenticated session.</p></remarks>
117+
<exception cref="T:System.InvalidOperationException">Authentication failed or has not occurred.</exception>
116118
</Docs>
117119
</Member>
118120
<Member MemberName="Dispose">
@@ -652,11 +654,13 @@ For the client side of the authentication, the property returns the target name
652654
<Parameter Name="signature" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="1" FrameworkAlternate="net-9.0" />
653655
</Parameters>
654656
<Docs>
655-
<param name="message">To be added.</param>
656-
<param name="signature">To be added.</param>
657-
<summary>To be added.</summary>
658-
<returns>To be added.</returns>
659-
<remarks>To be added.</remarks>
657+
<param name="message">Input message for MIC calculation.</param>
658+
<param name="signature">MIC to be verified.</param>
659+
<summary>Verifies the message integrity check of a given message.</summary>
660+
<returns><see langword="true" /> if the MIC is successfully verified, otherwise <see langword="false" />.</returns>
661+
<remarks><p>Implements the GSSAPI VerifyMIC operation.</p>
662+
<p>The method modifies the internal state and may update sequence numbers depending on the selected algorithm. Two successive invocations thus don't produce the same result and it's important to carefully pair GetMIC and VerifyMIC calls on the both sides of the authenticated session.</p></remarks>
663+
<exception cref="T:System.InvalidOperationException">Authentication failed or has not occurred.</exception>
660664
</Docs>
661665
</Member>
662666
<Member MemberName="Wrap">

‎xml/System.Net.ServerSentEvents/SseItemParser`1.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040
<ReturnType>T</ReturnType>
4141
</ReturnValue>
4242
<Docs>
43-
<typeparam name="T">To be added.</typeparam>
44-
<param name="eventType">To be added.</param>
45-
<param name="data">To be added.</param>
46-
<summary>To be added.</summary>
47-
<returns>To be added.</returns>
43+
<typeparam name="T">Specifies the type of the return value of the parser.</typeparam>
44+
<param name="eventType">The event's type.</param>
45+
<param name="data">The event's payload bytes.</param>
46+
<summary>Encapsulates a method for parsing the bytes payload of a server-sent event.</summary>
47+
<returns>The parsed <typeparamref name="T" />.</returns>
4848
<remarks>To be added.</remarks>
4949
</Docs>
5050
</Type>

‎xml/System.Net.ServerSentEvents/SseItem`1.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
</Attribute>
3939
</Attributes>
4040
<Docs>
41-
<typeparam name="T">To be added.</typeparam>
42-
<summary>To be added.</summary>
41+
<typeparam name="T">Specifies the type of data payload in the event.</typeparam>
42+
<summary>Represents a server-sent event.</summary>
4343
<remarks>To be added.</remarks>
4444
</Docs>
4545
<Members>
@@ -60,9 +60,9 @@
6060
<Parameter Name="eventType" Type="System.String" />
6161
</Parameters>
6262
<Docs>
63-
<param name="data">To be added.</param>
64-
<param name="eventType">To be added.</param>
65-
<summary>To be added.</summary>
63+
<param name="data">The event's payload.</param>
64+
<param name="eventType">The event's type.</param>
65+
<summary>Initializes the server-sent event.</summary>
6666
<remarks>To be added.</remarks>
6767
</Docs>
6868
</Member>
@@ -82,7 +82,7 @@
8282
<ReturnType>T</ReturnType>
8383
</ReturnValue>
8484
<Docs>
85-
<summary>To be added.</summary>
85+
<summary>Gets the event's payload.</summary>
8686
<value>To be added.</value>
8787
<remarks>To be added.</remarks>
8888
</Docs>
@@ -103,7 +103,7 @@
103103
<ReturnType>System.String</ReturnType>
104104
</ReturnValue>
105105
<Docs>
106-
<summary>To be added.</summary>
106+
<summary>Gets the event's type.</summary>
107107
<value>To be added.</value>
108108
<remarks>To be added.</remarks>
109109
</Docs>

‎xml/System.Net.ServerSentEvents/SseParser.xml

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>Provides a parser for parsing server-sent events.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>
@@ -47,10 +47,12 @@
4747
<Parameter Name="sseStream" Type="System.IO.Stream" />
4848
</Parameters>
4949
<Docs>
50-
<param name="sseStream">To be added.</param>
51-
<summary>To be added.</summary>
52-
<returns>To be added.</returns>
53-
<remarks>To be added.</remarks>
50+
<param name="sseStream">The stream containing the data to parse.</param>
51+
<summary>Creates a parser for parsing a <paramref name="sseStream" /> of server-sent events into a sequence of <see cref="T:System.Net.ServerSentEvents.SseItem`1" /> values.</summary>
52+
<returns>The enumerable of strings, which may be enumerated synchronously or asynchronously. The strings are decoded from the UTF8-encoded bytes of the payload of each event.</returns>
53+
<remarks>This overload has behavior equivalent to calling <see cref="M:System.Net.ServerSentEvents.SseParser.Create``1(System.IO.Stream,System.Net.ServerSentEvents.SseItemParser{``0})" /> with a delegate that decodes the data of each event using <see cref="P:System.Text.Encoding.UTF8" />'s GetString method.</remarks>
54+
<exception cref="T:System.ArgumentNullException">
55+
<paramref name="sseStream" /> is <see langword="null" />.</exception>
5456
</Docs>
5557
</Member>
5658
<Member MemberName="Create&lt;T&gt;">
@@ -83,12 +85,14 @@
8385
<Parameter Name="itemParser" Type="System.Net.ServerSentEvents.SseItemParser&lt;T&gt;" />
8486
</Parameters>
8587
<Docs>
86-
<typeparam name="T">To be added.</typeparam>
87-
<param name="sseStream">To be added.</param>
88-
<param name="itemParser">To be added.</param>
89-
<summary>To be added.</summary>
90-
<returns>To be added.</returns>
88+
<typeparam name="T">Specifies the type of data in each event.</typeparam>
89+
<param name="sseStream">The stream containing the data to parse.</param>
90+
<param name="itemParser">The parser to use to transform each payload of bytes into a data element.</param>
91+
<summary>Creates a parser for parsing a <paramref name="sseStream" /> of server-sent events into a sequence of <see cref="T:System.Net.ServerSentEvents.SseItem`1" /> values.</summary>
92+
<returns>The enumerable, which may be enumerated synchronously or asynchronously.</returns>
9193
<remarks>To be added.</remarks>
94+
<exception cref="T:System.ArgumentNullException">
95+
<paramref name="sseStream" /> or <paramref name="itemParser" /> is <see langword="null" />.</exception>
9296
</Docs>
9397
</Member>
9498
<Member MemberName="EventTypeDefault">
@@ -107,7 +111,7 @@
107111
<ReturnType>System.String</ReturnType>
108112
</ReturnValue>
109113
<Docs>
110-
<summary>To be added.</summary>
114+
<summary>The default <see cref="P:System.Net.ServerSentEvents.SseItem`1.EventType" /> ("message") for an event that did not explicitly specify a type.</summary>
111115
<remarks>To be added.</remarks>
112116
</Docs>
113117
</Member>

‎xml/System.Net.ServerSentEvents/SseParser`1.xml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
</Base>
2525
<Interfaces />
2626
<Docs>
27-
<typeparam name="T">To be added.</typeparam>
28-
<summary>To be added.</summary>
27+
<typeparam name="T">Specifies the type of data parsed from an event.</typeparam>
28+
<summary>Provides a parser for server-sent events information.</summary>
2929
<remarks>To be added.</remarks>
3030
</Docs>
3131
<Members>
@@ -58,9 +58,10 @@
5858
</ReturnValue>
5959
<Parameters />
6060
<Docs>
61-
<summary>To be added.</summary>
61+
<summary>Gets an enumerable of the server-sent events from this parser.</summary>
6262
<returns>To be added.</returns>
6363
<remarks>To be added.</remarks>
64+
<exception cref="T:System.InvalidOperationException">The parser has already been enumerated. Such an exception may propagate out of a call to <see cref="M:System.Collections.IEnumerator.MoveNext" />.</exception>
6465
</Docs>
6566
</Member>
6667
<Member MemberName="EnumerateAsync">
@@ -100,10 +101,12 @@
100101
</Parameter>
101102
</Parameters>
102103
<Docs>
103-
<param name="cancellationToken">To be added.</param>
104-
<summary>To be added.</summary>
104+
<param name="cancellationToken">The cancellation token to use to cancel the enumeration.</param>
105+
<summary>Gets an asynchronous enumerable of the server-sent events from this parser.</summary>
105106
<returns>To be added.</returns>
106107
<remarks>To be added.</remarks>
108+
<exception cref="T:System.InvalidOperationException">The parser has already been enumerated. Such an exception may propagate out of a call to <see cref="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync" />.</exception>
109+
<exception cref="T:System.OperationCanceledException">The enumeration was canceled. Such an exception may propagate out of a call to <see cref="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync" />.</exception>
107110
</Docs>
108111
</Member>
109112
<Member MemberName="LastEventId">
@@ -132,9 +135,9 @@
132135
<ReturnType>System.String</ReturnType>
133136
</ReturnValue>
134137
<Docs>
135-
<summary>To be added.</summary>
138+
<summary>Gets the last event ID.</summary>
136139
<value>To be added.</value>
137-
<remarks>To be added.</remarks>
140+
<remarks>This value is updated any time a new last event ID is parsed. It is not reset between SSE items.</remarks>
138141
</Docs>
139142
</Member>
140143
<Member MemberName="ReconnectionInterval">
@@ -153,9 +156,9 @@
153156
<ReturnType>System.TimeSpan</ReturnType>
154157
</ReturnValue>
155158
<Docs>
156-
<summary>To be added.</summary>
159+
<summary>Gets the reconnection interval.</summary>
157160
<value>To be added.</value>
158-
<remarks>To be added.</remarks>
161+
<remarks>If no retry event was received, this defaults to <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />, and it will only ever be <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> in that situation. If a client wishes to retry, the server-sent events specification states that the interval may then be decided by the client implementation and should be a few seconds.</remarks>
159162
</Docs>
160163
</Member>
161164
</Members>

‎xml/System.Net.Sockets/SocketOptionName.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,8 @@
722722
</ReturnValue>
723723
<MemberValue>15</MemberValue>
724724
<Docs>
725-
<summary>To be added.</summary>
725+
<summary>Enables TCP Fast Open as defined in RFC-7413. The actual observed behavior depends on OS configuration and the state of the kernel TCP cookie cache.
726+
Enabling TFO can impact interoperability and cause connectivity issues.</summary>
726727
</Docs>
727728
</Member>
728729
<Member MemberName="HeaderIncluded">

0 commit comments

Comments
 (0)