Skip to content

Commit 64854a6

Browse files
ericstjericstj
committed
System docs
1 parent 799e0db commit 64854a6

File tree

5 files changed

+112
-66
lines changed

5 files changed

+112
-66
lines changed

‎xml/System/BinaryData.xml‎

Lines changed: 99 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,13 @@
123123
</Parameter>
124124
</Parameters>
125125
<Docs>
126-
<param name="data">To be added.</param>
127-
<param name="mediaType">To be added.</param>
128-
<summary>To be added.</summary>
126+
<param name="data">The array to wrap.</param>
127+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
128+
<summary>
129+
<para>Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided byte array and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
130+
</summary>
129131
<remarks>To be added.</remarks>
132+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
130133
</Docs>
131134
</Member>
132135
<Member MemberName=".ctor">
@@ -153,10 +156,13 @@
153156
</Parameter>
154157
</Parameters>
155158
<Docs>
156-
<param name="data">To be added.</param>
157-
<param name="mediaType">To be added.</param>
158-
<summary>To be added.</summary>
159+
<param name="data">Byte data to wrap.</param>
160+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
161+
<summary>
162+
<para>Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided bytes and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
163+
</summary>
159164
<remarks>To be added.</remarks>
165+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
160166
</Docs>
161167
</Member>
162168
<Member MemberName=".ctor">
@@ -183,10 +189,13 @@
183189
</Parameter>
184190
</Parameters>
185191
<Docs>
186-
<param name="data">To be added.</param>
187-
<param name="mediaType">To be added.</param>
188-
<summary>To be added.</summary>
192+
<param name="data">The string data.</param>
193+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
194+
<summary>
195+
<para>Creates a <see cref="T:System.BinaryData" /> instance from a string by converting the string to bytes using the UTF-8 encoding and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
196+
</summary>
189197
<remarks>To be added.</remarks>
198+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
190199
</Docs>
191200
</Member>
192201
<Member MemberName=".ctor">
@@ -221,6 +230,7 @@
221230
<param name="type">The type to use when serializing the data. If not specified, <see cref="M:System.Object.GetType" /> will be used to determine the type.</param>
222231
<summary>Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object to JSON using <see cref="T:System.Text.Json.JsonSerializer" />.</summary>
223232
<remarks>To be added.</remarks>
233+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
224234
</Docs>
225235
</Member>
226236
<Member MemberName=".ctor">
@@ -252,6 +262,7 @@
252262
<param name="type">The type to use when serializing the data. If not specified, <see cref="M:System.Object.GetType" /> will be used to determine the type.</param>
253263
<summary>Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object to JSON using <see cref="T:System.Text.Json.JsonSerializer" />.</summary>
254264
<remarks>To be added.</remarks>
265+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
255266
</Docs>
256267
</Member>
257268
<Member MemberName="Empty">
@@ -397,11 +408,14 @@
397408
</Parameter>
398409
</Parameters>
399410
<Docs>
400-
<param name="data">To be added.</param>
401-
<param name="mediaType">To be added.</param>
402-
<summary>To be added.</summary>
403-
<returns>To be added.</returns>
411+
<param name="data">The array to wrap.</param>
412+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
413+
<summary>
414+
<para>Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided byte array and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
415+
</summary>
416+
<returns>A wrapper over <paramref name="data" />.</returns>
404417
<remarks>To be added.</remarks>
418+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
405419
</Docs>
406420
</Member>
407421
<Member MemberName="FromBytes">
@@ -437,11 +451,14 @@
437451
</Parameter>
438452
</Parameters>
439453
<Docs>
440-
<param name="data">To be added.</param>
441-
<param name="mediaType">To be added.</param>
442-
<summary>To be added.</summary>
443-
<returns>To be added.</returns>
454+
<param name="data">Byte data to wrap.</param>
455+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
456+
<summary>
457+
<para>Creates a <see cref="T:System.BinaryData" /> instance by wrapping the provided <see cref="T:System.ReadOnlyMemory`1" /> and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
458+
</summary>
459+
<returns>A wrapper over <paramref name="data" />.</returns>
444460
<remarks>To be added.</remarks>
461+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
445462
</Docs>
446463
</Member>
447464
<Member MemberName="FromFile">
@@ -463,9 +480,9 @@
463480
<Parameter Name="path" Type="System.String" />
464481
</Parameters>
465482
<Docs>
466-
<param name="path">To be added.</param>
467-
<summary>To be added.</summary>
468-
<returns>To be added.</returns>
483+
<param name="path">The path to the file.</param>
484+
<summary>Creates a <see cref="T:System.BinaryData" /> instance from the specified file.</summary>
485+
<returns>A value representing all of the data from the file.</returns>
469486
<remarks>To be added.</remarks>
470487
</Docs>
471488
</Member>
@@ -496,11 +513,14 @@
496513
</Parameter>
497514
</Parameters>
498515
<Docs>
499-
<param name="path">To be added.</param>
500-
<param name="mediaType">To be added.</param>
501-
<summary>To be added.</summary>
502-
<returns>To be added.</returns>
516+
<param name="path">The path to the file.</param>
517+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
518+
<summary>
519+
<para>Creates a <see cref="T:System.BinaryData" /> instance from the specified file and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
520+
</summary>
521+
<returns>A value representing all of the data from the file.</returns>
503522
<remarks>To be added.</remarks>
523+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
504524
</Docs>
505525
</Member>
506526
<Member MemberName="FromFileAsync">
@@ -522,10 +542,10 @@
522542
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
523543
</Parameters>
524544
<Docs>
525-
<param name="path">To be added.</param>
526-
<param name="cancellationToken">To be added.</param>
527-
<summary>To be added.</summary>
528-
<returns>To be added.</returns>
545+
<param name="path">The path to the file.</param>
546+
<param name="cancellationToken">A token that may be used to cancel the operation.</param>
547+
<summary>Creates a <see cref="T:System.BinaryData" /> instance from the specified file.</summary>
548+
<returns>A value representing all of the data from the file.</returns>
529549
<remarks>To be added.</remarks>
530550
</Docs>
531551
</Member>
@@ -556,12 +576,15 @@
556576
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
557577
</Parameters>
558578
<Docs>
559-
<param name="path">To be added.</param>
560-
<param name="mediaType">To be added.</param>
561-
<param name="cancellationToken">To be added.</param>
562-
<summary>To be added.</summary>
563-
<returns>To be added.</returns>
579+
<param name="path">The path to the file.</param>
580+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
581+
<param name="cancellationToken">A token that may be used to cancel the operation.</param>
582+
<summary>
583+
<para>Creates a <see cref="T:System.BinaryData" /> instance from the specified file and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
584+
</summary>
585+
<returns>A value representing all of the data from the file.</returns>
564586
<remarks>To be added.</remarks>
587+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
565588
</Docs>
566589
</Member>
567590
<Member MemberName="FromObjectAsJson&lt;T&gt;">
@@ -616,6 +639,7 @@
616639
<summary>Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object using the <see cref="T:System.Text.Json.JsonSerializer" />.</summary>
617640
<returns>A value representing the UTF-8 encoding of the JSON representation of <paramref name="jsonSerializable" />.</returns>
618641
<remarks>To be added.</remarks>
642+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
619643
</Docs>
620644
</Member>
621645
<Member MemberName="FromObjectAsJson&lt;T&gt;">
@@ -654,6 +678,7 @@
654678
<summary>Creates a <see cref="T:System.BinaryData" /> instance by serializing the provided object using the <see cref="T:System.Text.Json.JsonSerializer" />.</summary>
655679
<returns>A value representing the UTF-8 encoding of the JSON representation of <paramref name="jsonSerializable" />.</returns>
656680
<remarks>To be added.</remarks>
681+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
657682
</Docs>
658683
</Member>
659684
<Member MemberName="FromStream">
@@ -708,11 +733,15 @@
708733
</Parameter>
709734
</Parameters>
710735
<Docs>
711-
<param name="stream">To be added.</param>
712-
<param name="mediaType">To be added.</param>
713-
<summary>To be added.</summary>
714-
<returns>To be added.</returns>
736+
<param name="stream">Stream containing the data.</param>
737+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
738+
<summary>
739+
<para>Creates a <see cref="T:System.BinaryData" /> instance from the specified stream and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
740+
<para>The stream is not disposed by this method.</para>
741+
</summary>
742+
<returns>A value representing all of the data remaining in <paramref name="stream" />.</returns>
715743
<remarks>To be added.</remarks>
744+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
716745
</Docs>
717746
</Member>
718747
<Member MemberName="FromStreamAsync">
@@ -769,13 +798,17 @@
769798
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
770799
</Parameters>
771800
<Docs>
772-
<param name="stream">To be added.</param>
773-
<param name="mediaType">To be added.</param>
774-
<param name="cancellationToken">To be added.</param>
775-
<summary>To be added.</summary>
776-
<returns>To be added.</returns>
801+
<param name="stream">Stream containing the data.</param>
802+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</param>
803+
<param name="cancellationToken">A token that may be used to cancel the operation.</param>
804+
<summary>
805+
<para>Creates a <see cref="T:System.BinaryData" /> instance from the specified stream and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
806+
<para>The stream is not disposed by this method.</para>
807+
</summary>
808+
<returns>A value representing all of the data remaining in <paramref name="stream" />.</returns>
777809
<remarks>To be added.</remarks>
778810
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
811+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
779812
</Docs>
780813
</Member>
781814
<Member MemberName="FromString">
@@ -830,11 +863,14 @@
830863
</Parameter>
831864
</Parameters>
832865
<Docs>
833-
<param name="data">To be added.</param>
834-
<param name="mediaType">To be added.</param>
835-
<summary>To be added.</summary>
836-
<returns>To be added.</returns>
866+
<param name="data">The string data.</param>
867+
<param name="mediaType">MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Text.Plain" />.</param>
868+
<summary>
869+
<para>Creates a <see cref="T:System.BinaryData" /> instance from a string by converting the string to bytes using the UTF-8 encoding and sets <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
870+
</summary>
871+
<returns>A value representing the UTF-8 encoding of <paramref name="data" />.</returns>
837872
<remarks>To be added.</remarks>
873+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
838874
</Docs>
839875
</Member>
840876
<Member MemberName="GetHashCode">
@@ -931,9 +967,10 @@
931967
<ReturnType>System.String</ReturnType>
932968
</ReturnValue>
933969
<Docs>
934-
<summary>To be added.</summary>
970+
<summary>Gets the MIME type of this data, e.g. <see cref="F:System.Net.Mime.MediaTypeNames.Application.Octet" />.</summary>
935971
<value>To be added.</value>
936972
<remarks>To be added.</remarks>
973+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
937974
</Docs>
938975
</Member>
939976
<Member MemberName="op_Implicit">
@@ -1160,17 +1197,18 @@
11601197
<summary>Converts the value of this instance to a string using UTF-8.</summary>
11611198
<returns>A string representation of the value of this instance.</returns>
11621199
<remarks>
1163-
<format type="text/markdown"><![CDATA[
1164-
1165-
## Remarks
1166-
1167-
No special treatment is given to the contents of the data. It is merely decoded as a UTF-8 string.
1168-
For a JPEG or other binary file format, the string will largely be nonsense with many embedded NUL characters.
1169-
UTF-8 JSON values will look like their file or network representation,
1170-
including starting and stopping quotes on a string.
1171-
1200+
<format type="text/markdown"><![CDATA[
1201+
1202+
## Remarks
1203+
1204+
No special treatment is given to the contents of the data. It is merely decoded as a UTF-8 string.
1205+
For a JPEG or other binary file format, the string will largely be nonsense with many embedded NUL characters.
1206+
UTF-8 JSON values will look like their file or network representation,
1207+
including starting and stopping quotes on a string.
1208+
11721209
]]></format>
11731210
</remarks>
1211+
<seealso cref="M:System.BinaryData.ToObjectFromJson``1(System.Text.Json.JsonSerializerOptions)" />
11741212
</Docs>
11751213
</Member>
11761214
<Member MemberName="WithMediaType">
@@ -1200,9 +1238,12 @@ No special treatment is given to the contents of the data. It is merely decoded
12001238
</Parameters>
12011239
<Docs>
12021240
<param name="mediaType">To be added.</param>
1203-
<summary>To be added.</summary>
1204-
<returns>To be added.</returns>
1241+
<summary>
1242+
<para>Creates a <see cref="T:System.BinaryData" /> instance by wrapping the same data and changed <see cref="P:System.BinaryData.MediaType" /> to <see pref="mediaType" /> value.</para>
1243+
</summary>
1244+
<returns>A wrapper over the same data with specified <see cref="P:System.BinaryData.MediaType" />.</returns>
12051245
<remarks>To be added.</remarks>
1246+
<seealso cref="T:System.Net.Mime.MediaTypeNames" />
12061247
</Docs>
12071248
</Member>
12081249
</Members>

‎xml/System/MemoryExtensions.xml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3151,7 +3151,8 @@ Returns `default` when `array` is `null`.
31513151
<param name="value1">The second value to search for.</param>
31523152
<param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing elements, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> for the type of an element.</param>
31533153
<summary>Searches for an occurrence of either of the specified values.</summary>
3154-
<returns><see langword="true" /> if an occurrence of either value is found; otherwise <see langword="false" />.</returns>
3154+
<returns>
3155+
<see langword="true" /> if an occurrence of either value is found; otherwise <see langword="false" />.</returns>
31553156
<remarks>To be added.</remarks>
31563157
</Docs>
31573158
</Member>
@@ -3333,7 +3334,8 @@ Returns `default` when `array` is `null`.
33333334
<param name="value2">The third value to search for.</param>
33343335
<param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing elements, or <see langword="null" /> to use the default <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> for the type of an element.</param>
33353336
<summary>Searches for any occurrence of the specified values in the specified span.</summary>
3336-
<returns><see langword="true" /> if any of the values is found; otherwise, <see langword="false" /></returns>
3337+
<returns>
3338+
<see langword="true" /> if any of the values is found; otherwise, <see langword="false" /></returns>
33373339
<remarks>To be added.</remarks>
33383340
</Docs>
33393341
</Member>
@@ -10728,7 +10730,8 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
1072810730
</summary>
1072910731
<remarks>To be added.</remarks>
1073010732
<exception cref="T:System.ArgumentException">The <paramref name="destination" /> span was shorter than the <paramref name="source" /> span.</exception>
10731-
<exception cref="T:System.ArgumentException"><paramref name="source" /> and <paramref name="destination" /> overlap but don't refer to the same starting location.</exception>
10733+
<exception cref="T:System.ArgumentException">
10734+
<paramref name="source" /> and <paramref name="destination" /> overlap but don't refer to the same starting location.</exception>
1073210735
<exception cref="T:System.ArgumentNullException">
1073310736
<paramref name="values" /> is <see langword="null" />.</exception>
1073410737
</Docs>
@@ -10849,7 +10852,8 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
1084910852
</summary>
1085010853
<remarks>To be added.</remarks>
1085110854
<exception cref="T:System.ArgumentException">The <paramref name="destination" /> span was shorter than the <paramref name="source" /> span.</exception>
10852-
<exception cref="T:System.ArgumentException"><paramref name="source" /> and <paramref name="destination" /> overlap but don't refer to the same starting location.</exception>
10855+
<exception cref="T:System.ArgumentException">
10856+
<paramref name="source" /> and <paramref name="destination" /> overlap but don't refer to the same starting location.</exception>
1085310857
<exception cref="T:System.ArgumentNullException">
1085410858
<paramref name="values" /> is <see langword="null" />.</exception>
1085510859
</Docs>

‎xml/System/ReadOnlySpan`1+Enumerator.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,8 @@ If `MoveNext` passes the end of the span, `MoveNext` returns `false`. When the e
249249
<ReturnType>T</ReturnType>
250250
</ReturnValue>
251251
<Docs>
252-
<summary>To be added.</summary>
253-
<value>To be added.</value>
252+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
253+
<value>The element in the collection at the current position of the enumerator.</value>
254254
<remarks>To be added.</remarks>
255255
</Docs>
256256
</Member>

‎xml/System/Span`1+Enumerator.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,8 +245,8 @@ If `MoveNext` passes the end of the span, `MoveNext` returns `false`. When the e
245245
<ReturnType>T</ReturnType>
246246
</ReturnValue>
247247
<Docs>
248-
<summary>To be added.</summary>
249-
<value>To be added.</value>
248+
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
249+
<value>The element in the collection at the current position of the enumerator.</value>
250250
<remarks>To be added.</remarks>
251251
</Docs>
252252
</Member>

0 commit comments

Comments
 (0)