Skip to content

Commit 570af32

Browse files
committed
System.Net docs
1 parent a88f6f4 commit 570af32

File tree

13 files changed

+114
-54
lines changed

13 files changed

+114
-54
lines changed

xml/System.Net.Http.Headers/HeaderStringValues.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ This member is an explicit interface member implementation. It can be used only
160160
161161
]]></format>
162162
</remarks>
163+
<inheritdoc />
163164
</Docs>
164165
</Member>
165166
<Member MemberName="ToString">

xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,7 @@ This member is an explicit interface member implementation. It can be used only
379379
380380
]]></format>
381381
</remarks>
382+
<inheritdoc />
382383
</Docs>
383384
</Member>
384385
<Member MemberName="TryGetValues">

xml/System.Net.Http/HttpMethod.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -726,8 +726,8 @@
726726
<ReturnType>System.Net.Http.HttpMethod</ReturnType>
727727
</ReturnValue>
728728
<Docs>
729-
<summary>To be added.</summary>
730-
<value>To be added.</value>
729+
<summary>Gets the HTTP QUERY protocol method.</summary>
730+
<value>The HTTP QUERY method.</value>
731731
<remarks>To be added.</remarks>
732732
</Docs>
733733
</Member>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@
518518
<ReturnType>System.String</ReturnType>
519519
</ReturnValue>
520520
<Docs>
521-
<summary>To be added.</summary>
521+
<summary>Specifies that the <see cref="T:System.Net.Mime.MediaTypeNames.Application" /> data is in YAML format.</summary>
522522
<remarks>To be added.</remarks>
523523
</Docs>
524524
</Member>

xml/System.Net.Quic/QuicConnection.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ If <xref:System.Net.Quic.QuicConnection.CloseAsync(System.Int64,System.Threading
293293
<ReturnType>System.Net.Security.TlsCipherSuite</ReturnType>
294294
</ReturnValue>
295295
<Docs>
296-
<summary>To be added.</summary>
296+
<summary>Gets the cipher suite which was negotiated for this connection.</summary>
297297
<value>To be added.</value>
298298
<remarks>To be added.</remarks>
299299
</Docs>
@@ -404,7 +404,7 @@ If <xref:System.Net.Quic.QuicConnection.CloseAsync(System.Int64,System.Threading
404404
<ReturnType>System.Security.Authentication.SslProtocols</ReturnType>
405405
</ReturnValue>
406406
<Docs>
407-
<summary>To be added.</summary>
407+
<summary>Gets a <see cref="T:System.Security.Authentication.SslProtocols" /> value that indicates the security protocol used to authenticate this connection.</summary>
408408
<value>To be added.</value>
409409
<remarks>To be added.</remarks>
410410
</Docs>

xml/System.Net.Quic/QuicStream.xml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-
119119
<summary>Begins an asynchronous read operation. (Consider using <see cref="M:System.IO.Stream.ReadAsync(System.Byte[],System.Int32,System.Int32)" /> instead.)</summary>
120120
<returns>An <see cref="T:System.IAsyncResult" /> that represents the asynchronous read, which could still be pending.</returns>
121121
<remarks>To be added.</remarks>
122+
<inheritdoc />
122123
</Docs>
123124
</Member>
124125
<Member MemberName="BeginWrite">
@@ -169,6 +170,7 @@ Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-
169170
<summary>Begins an asynchronous write operation. (Consider using <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> instead.)</summary>
170171
<returns>An <see langword="IAsyncResult" /> that represents the asynchronous write, which could still be pending.</returns>
171172
<remarks>To be added.</remarks>
173+
<inheritdoc />
172174
</Docs>
173175
</Member>
174176
<Member MemberName="CanRead">
@@ -220,6 +222,7 @@ Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-
220222
<value>
221223
<see langword="true" /> if the stream supports seeking; otherwise, <see langword="false" />.</value>
222224
<remarks>To be added.</remarks>
225+
<inheritdoc />
223226
</Docs>
224227
</Member>
225228
<Member MemberName="CanTimeout">
@@ -245,6 +248,7 @@ Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-
245248
<value>
246249
<see langword="true" /> if the current stream can time out; otherwise, <see langword="false" />.</value>
247250
<remarks>To be added.</remarks>
251+
<inheritdoc />
248252
</Docs>
249253
</Member>
250254
<Member MemberName="CanWrite">
@@ -270,6 +274,7 @@ Corresponds to [STOP_SENDING](https://www.rfc-editor.org/rfc/rfc9000.html#frame-
270274
<value>
271275
<see langword="true" /> if the stream supports writing; otherwise, <see langword="false" />.</value>
272276
<remarks>To be added.</remarks>
277+
<inheritdoc />
273278
</Docs>
274279
</Member>
275280
<Member MemberName="CompleteWrites">
@@ -386,6 +391,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
386391
<returns>The number of bytes read from the stream, between zero (0) and the number of bytes requested.</returns>
387392
<remarks>
388393
<c>ReadAsync</c> returns zero (0) only if zero bytes were requested or if no more bytes will be available because it's at the end of the stream; otherwise, read operations do not complete until at least one byte is available. If zero bytes are requested, read operations may complete immediately or may not complete until at least one byte is available (but without consuming any data).</remarks>
394+
<inheritdoc />
389395
</Docs>
390396
</Member>
391397
<Member MemberName="EndWrite">
@@ -413,6 +419,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
413419
<param name="asyncResult">A reference to the outstanding asynchronous I/O request.</param>
414420
<summary>Ends an asynchronous write operation. (Consider using <see cref="M:System.IO.Stream.WriteAsync(System.Byte[],System.Int32,System.Int32)" /> instead.)</summary>
415421
<remarks>To be added.</remarks>
422+
<inheritdoc />
416423
</Docs>
417424
</Member>
418425
<Member MemberName="Flush">
@@ -466,6 +473,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
466473
<returns>A task that represents the asynchronous flush operation.</returns>
467474
<remarks>To be added.</remarks>
468475
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
476+
<inheritdoc />
469477
</Docs>
470478
</Member>
471479
<Member MemberName="Id">
@@ -516,6 +524,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
516524
<value>A long value representing the length of the stream in bytes.</value>
517525
<remarks>To be added.</remarks>
518526
<exception cref="T:System.NotSupportedException">In all cases.</exception>
527+
<inheritdoc />
519528
</Docs>
520529
</Member>
521530
<Member MemberName="Position">
@@ -541,6 +550,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
541550
<value>The current position within the stream.</value>
542551
<remarks>To be added.</remarks>
543552
<exception cref="T:System.NotSupportedException">In all cases.</exception>
553+
<inheritdoc />
544554
</Docs>
545555
</Member>
546556
<Member MemberName="Read">
@@ -633,6 +643,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
633643
<returns>A task that represents the asynchronous read operation.</returns>
634644
<remarks>The value of its <see cref="P:System.Threading.Tasks.ValueTask`1.Result" /> property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached.</remarks>
635645
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
646+
<inheritdoc />
636647
</Docs>
637648
</Member>
638649
<Member MemberName="ReadAsync">
@@ -667,6 +678,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
667678
<returns>A task that represents the asynchronous read operation.</returns>
668679
<remarks>The value of the <see cref="P:System.Threading.Tasks.ValueTask`1.Result" /> property contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if <paramref name="count" /> is 0 or if the end of the stream has been reached.</remarks>
669680
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
681+
<inheritdoc />
670682
</Docs>
671683
</Member>
672684
<Member MemberName="ReadByte">
@@ -692,6 +704,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
692704
<summary>Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.</summary>
693705
<returns>The unsigned byte cast to an <see cref="T:System.Int32" />, or -1 if at the end of the stream.</returns>
694706
<remarks>To be added.</remarks>
707+
<inheritdoc />
695708
</Docs>
696709
</Member>
697710
<Member MemberName="ReadsClosed">
@@ -772,6 +785,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
772785
<returns>The new position within the current stream.</returns>
773786
<remarks>To be added.</remarks>
774787
<exception cref="T:System.NotSupportedException">In all cases.</exception>
788+
<inheritdoc />
775789
</Docs>
776790
</Member>
777791
<Member MemberName="SetLength">
@@ -800,6 +814,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
800814
<summary>Sets the length of the stream. This method is not currently supported and always throws a <see cref="T:System.NotSupportedException" />.</summary>
801815
<remarks>To be added.</remarks>
802816
<exception cref="T:System.NotSupportedException">In all cases.</exception>
817+
<inheritdoc />
803818
</Docs>
804819
</Member>
805820
<Member MemberName="ToString">
@@ -940,6 +955,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
940955
<returns>A task that represents the asynchronous write operation.</returns>
941956
<remarks>To be added.</remarks>
942957
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
958+
<inheritdoc />
943959
</Docs>
944960
</Member>
945961
<Member MemberName="WriteAsync">
@@ -973,6 +989,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
973989
<returns>A task that represents the asynchronous write operation.</returns>
974990
<remarks>To be added.</remarks>
975991
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
992+
<inheritdoc cref="M:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)" />
976993
</Docs>
977994
</Member>
978995
<Member MemberName="WriteAsync">
@@ -1007,6 +1024,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
10071024
<returns>A task that represents the asynchronous write operation.</returns>
10081025
<remarks>To be added.</remarks>
10091026
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
1027+
<inheritdoc />
10101028
</Docs>
10111029
</Member>
10121030
<Member MemberName="WriteByte">
@@ -1034,6 +1052,7 @@ Equivalent to using <xref:System.Net.Quic.QuicStream.WriteAsync(System.ReadOnlyM
10341052
<param name="value">The byte to write to the stream.</param>
10351053
<summary>Writes a byte to the current position in the stream and advances the position within the stream by one byte.</summary>
10361054
<remarks>To be added.</remarks>
1055+
<inheritdoc />
10371056
</Docs>
10381057
</Member>
10391058
<Member MemberName="WritesClosed">

xml/System.Net.Quic/QuicStreamType.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<BaseTypeName>System.Enum</BaseTypeName>
1717
</Base>
1818
<Docs>
19-
<summary>Represents the type of a stream.</summary>
19+
<summary>Represents the type of a stream as defined in <see href="https://www.rfc-editor.org/rfc/rfc9000.html#name-stream-types-and-identifier">RFC9000</see>.</summary>
2020
<remarks>To be added.</remarks>
2121
</Docs>
2222
<Members>

xml/System.Net.Security/SslClientAuthenticationOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
<ReturnType>System.Boolean</ReturnType>
143143
</ReturnValue>
144144
<Docs>
145-
<summary>To be added.</summary>
145+
<summary>Gets or sets a value that indicates whether the the rsa_pkcs1_* family of TLS signature algorithms is enabled for use in the TLS handshake.</summary>
146146
<value>To be added.</value>
147147
<remarks>To be added.</remarks>
148148
</Docs>
@@ -176,7 +176,7 @@
176176
<ReturnType>System.Boolean</ReturnType>
177177
</ReturnValue>
178178
<Docs>
179-
<summary>To be added.</summary>
179+
<summary>Gets or sets a value that indicates whether the the rsa_pss_* family of TLS signature algorithms is enabled for use in the TLS handshake.</summary>
180180
<value>To be added.</value>
181181
<remarks>To be added.</remarks>
182182
</Docs>

xml/System.Net.Security/SslServerAuthenticationOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@
140140
<ReturnType>System.Boolean</ReturnType>
141141
</ReturnValue>
142142
<Docs>
143-
<summary>To be added.</summary>
143+
<summary>Gets or sets a value that indicates whether the the rsa_pkcs1_* family of TLS signature algorithms is enabled for use in the TLS handshake.</summary>
144144
<value>To be added.</value>
145145
<remarks>To be added.</remarks>
146146
</Docs>
@@ -174,7 +174,7 @@
174174
<ReturnType>System.Boolean</ReturnType>
175175
</ReturnValue>
176176
<Docs>
177-
<summary>To be added.</summary>
177+
<summary>Gets or sets a value that indicates whether the the rsa_pss_* family of TLS signature algorithms is enabled for use in the TLS handshake.</summary>
178178
<value>To be added.</value>
179179
<remarks>To be added.</remarks>
180180
</Docs>

0 commit comments

Comments
 (0)