Skip to content

Commit bd41ce6

Browse files
tannergoodingtannergooding
authored
Porting new docs for the System namespace (dotnet#9163)
1 parent 6c1d5b6 commit bd41ce6

36 files changed

+674
-425
lines changed

‎xml/System/ArgumentException.xml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -776,10 +776,14 @@ The following example demonstrates how to throw and catch an <xref:System.Argume
776776
</Parameter>
777777
</Parameters>
778778
<Docs>
779-
<param name="argument">To be added.</param>
780-
<param name="paramName">To be added.</param>
781-
<summary>To be added.</summary>
779+
<param name="argument">The string argument to validate.</param>
780+
<param name="paramName">The name of the parameter with which <paramref name="argument" /> corresponds.</param>
781+
<summary>Throws an exception if <paramref name="argument" /> is <see langword="null" />, empty, or consists only of white-space characters.</summary>
782782
<remarks>To be added.</remarks>
783+
<exception cref="T:System.ArgumentNullException">
784+
<paramref name="argument" /> is <see langword="null" />.</exception>
785+
<exception cref="T:System.ArgumentException">
786+
<paramref name="argument" /> is empty or consists only of white-space characters.</exception>
783787
</Docs>
784788
</Member>
785789
</Members>

‎xml/System/ArgumentOutOfRangeException.xml

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -856,10 +856,10 @@ The following example defines a class to contain information about an invited gu
856856
</Parameters>
857857
<Docs>
858858
<typeparam name="T">To be added.</typeparam>
859-
<param name="value">To be added.</param>
860-
<param name="other">To be added.</param>
861-
<param name="paramName">To be added.</param>
862-
<summary>To be added.</summary>
859+
<param name="value">The argument to validate as not equal to <paramref name="other" />.</param>
860+
<param name="other">The value to compare with <paramref name="value" />.</param>
861+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
862+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is equal to <paramref name="other" />.</summary>
863863
<remarks>To be added.</remarks>
864864
</Docs>
865865
</Member>
@@ -904,10 +904,10 @@ The following example defines a class to contain information about an invited gu
904904
</Parameters>
905905
<Docs>
906906
<typeparam name="T">To be added.</typeparam>
907-
<param name="value">To be added.</param>
908-
<param name="other">To be added.</param>
909-
<param name="paramName">To be added.</param>
910-
<summary>To be added.</summary>
907+
<param name="value">The argument to validate as less than or equal to <paramref name="other" />.</param>
908+
<param name="other">The value to compare with <paramref name="value" />.</param>
909+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
910+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is greater than <paramref name="other" />.</summary>
911911
<remarks>To be added.</remarks>
912912
</Docs>
913913
</Member>
@@ -952,10 +952,10 @@ The following example defines a class to contain information about an invited gu
952952
</Parameters>
953953
<Docs>
954954
<typeparam name="T">To be added.</typeparam>
955-
<param name="value">To be added.</param>
956-
<param name="other">To be added.</param>
957-
<param name="paramName">To be added.</param>
958-
<summary>To be added.</summary>
955+
<param name="value">The argument to validate as less than <paramref name="other" />.</param>
956+
<param name="other">The value to compare with <paramref name="value" />.</param>
957+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
958+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is greater than or equal to <paramref name="other" />.</summary>
959959
<remarks>To be added.</remarks>
960960
</Docs>
961961
</Member>
@@ -1000,10 +1000,10 @@ The following example defines a class to contain information about an invited gu
10001000
</Parameters>
10011001
<Docs>
10021002
<typeparam name="T">To be added.</typeparam>
1003-
<param name="value">To be added.</param>
1004-
<param name="other">To be added.</param>
1005-
<param name="paramName">To be added.</param>
1006-
<summary>To be added.</summary>
1003+
<param name="value">The argument to validate as greater than or equal to <paramref name="other" />.</param>
1004+
<param name="other">The value to compare with <paramref name="value" />.</param>
1005+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
1006+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is less than <paramref name="other" />.</summary>
10071007
<remarks>To be added.</remarks>
10081008
</Docs>
10091009
</Member>
@@ -1048,10 +1048,10 @@ The following example defines a class to contain information about an invited gu
10481048
</Parameters>
10491049
<Docs>
10501050
<typeparam name="T">To be added.</typeparam>
1051-
<param name="value">To be added.</param>
1052-
<param name="other">To be added.</param>
1053-
<param name="paramName">To be added.</param>
1054-
<summary>To be added.</summary>
1051+
<param name="value">The argument to validate as greater than <paramref name="other" />.</param>
1052+
<param name="other">The value to compare with <paramref name="value" />.</param>
1053+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
1054+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is less than or equal to <paramref name="other" />.</summary>
10551055
<remarks>To be added.</remarks>
10561056
</Docs>
10571057
</Member>
@@ -1095,9 +1095,9 @@ The following example defines a class to contain information about an invited gu
10951095
</Parameters>
10961096
<Docs>
10971097
<typeparam name="T">To be added.</typeparam>
1098-
<param name="value">To be added.</param>
1099-
<param name="paramName">To be added.</param>
1100-
<summary>To be added.</summary>
1098+
<param name="value">The argument to validate as non-negative.</param>
1099+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
1100+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is negative.</summary>
11011101
<remarks>To be added.</remarks>
11021102
</Docs>
11031103
</Member>
@@ -1141,9 +1141,9 @@ The following example defines a class to contain information about an invited gu
11411141
</Parameters>
11421142
<Docs>
11431143
<typeparam name="T">To be added.</typeparam>
1144-
<param name="value">To be added.</param>
1145-
<param name="paramName">To be added.</param>
1146-
<summary>To be added.</summary>
1144+
<param name="value">The argument to validate as non-zero or non-negative.</param>
1145+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
1146+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is negative or zero.</summary>
11471147
<remarks>To be added.</remarks>
11481148
</Docs>
11491149
</Member>
@@ -1188,10 +1188,10 @@ The following example defines a class to contain information about an invited gu
11881188
</Parameters>
11891189
<Docs>
11901190
<typeparam name="T">To be added.</typeparam>
1191-
<param name="value">To be added.</param>
1192-
<param name="other">To be added.</param>
1193-
<param name="paramName">To be added.</param>
1194-
<summary>To be added.</summary>
1191+
<param name="value">The argument to validate as equal to <paramref name="other" />.</param>
1192+
<param name="other">The value to compare with <paramref name="value" />.</param>
1193+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
1194+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is not equal to <paramref name="other" />.</summary>
11951195
<remarks>To be added.</remarks>
11961196
</Docs>
11971197
</Member>
@@ -1235,9 +1235,9 @@ The following example defines a class to contain information about an invited gu
12351235
</Parameters>
12361236
<Docs>
12371237
<typeparam name="T">To be added.</typeparam>
1238-
<param name="value">To be added.</param>
1239-
<param name="paramName">To be added.</param>
1240-
<summary>To be added.</summary>
1238+
<param name="value">The argument to validate as non-zero.</param>
1239+
<param name="paramName">The name of the parameter with which <paramref name="value" /> corresponds.</param>
1240+
<summary>Throws an <see cref="T:System.ArgumentOutOfRangeException" /> if <paramref name="value" /> is zero.</summary>
12411241
<remarks>To be added.</remarks>
12421242
</Docs>
12431243
</Member>

‎xml/System/Byte.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6091,6 +6091,7 @@ This member is an explicit interface member implementation. It can be used only
60916091
<summary>To be added.</summary>
60926092
<returns>To be added.</returns>
60936093
<remarks>To be added.</remarks>
6094+
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
60946095
</Docs>
60956096
</Member>
60966097
<Member MemberName="TryFormat">

‎xml/System/Char.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5719,6 +5719,7 @@ This member is an explicit interface member implementation. It can be used only
57195719
<summary>To be added.</summary>
57205720
<returns>To be added.</returns>
57215721
<remarks>To be added.</remarks>
5722+
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
57225723
</Docs>
57235724
</Member>
57245725
<Member MemberName="System.Numerics.IAdditionOperators&lt;System.Char,System.Char,System.Char&gt;.op_Addition">

‎xml/System/DateOnly.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -380,10 +380,10 @@
380380
<Parameter Name="day" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-8.0" />
381381
</Parameters>
382382
<Docs>
383-
<param name="year">To be added.</param>
384-
<param name="month">To be added.</param>
385-
<param name="day">To be added.</param>
386-
<summary>To be added.</summary>
383+
<param name="year">When this method returns, represents the <see cref="P:System.DateOnly.Year" /> value of this <see cref="T:System.DateOnly" /> instance.</param>
384+
<param name="month">When this method returns, represents the <see cref="P:System.DateOnly.Month" /> value of this <see cref="T:System.DateOnly" /> instance.</param>
385+
<param name="day">When this method returns, represents the <see cref="P:System.DateOnly.Day" /> value of this <see cref="T:System.DateOnly" /> instance.</param>
386+
<summary>Deconstructs <see cref="T:System.DateOnly" /> by <see cref="P:System.DateOnly.Year" />, <see cref="P:System.DateOnly.Month" />, and <see cref="P:System.DateOnly.Day" />.</summary>
387387
<remarks>To be added.</remarks>
388388
</Docs>
389389
</Member>
@@ -1507,6 +1507,7 @@
15071507
<summary>To be added.</summary>
15081508
<returns>To be added.</returns>
15091509
<remarks>To be added.</remarks>
1510+
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
15101511
</Docs>
15111512
</Member>
15121513
<Member MemberName="TryFormat">

‎xml/System/DateTime.xml

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -646,9 +646,10 @@ The behavior of the .NET Framework and COM means that if your application round-
646646
<Parameter Name="time" Type="System.TimeOnly" Index="1" FrameworkAlternate="net-8.0" />
647647
</Parameters>
648648
<Docs>
649-
<param name="date">To be added.</param>
650-
<param name="time">To be added.</param>
651-
<summary>To be added.</summary>
649+
<param name="date">The date part.</param>
650+
<param name="time">The time part.</param>
651+
<summary>Initializes a new instance of the <see cref="T:System.DateTime" /> structure to the specified <see cref="T:System.DateOnly" /> and <see cref="T:System.TimeOnly" />.
652+
The new instance will have the <see cref="F:System.DateTimeKind.Unspecified" /> kind.</summary>
652653
<remarks>To be added.</remarks>
653654
</Docs>
654655
</Member>
@@ -731,10 +732,10 @@ The behavior of the .NET Framework and COM means that if your application round-
731732
<Parameter Name="kind" Type="System.DateTimeKind" Index="2" FrameworkAlternate="net-8.0" />
732733
</Parameters>
733734
<Docs>
734-
<param name="date">To be added.</param>
735-
<param name="time">To be added.</param>
736-
<param name="kind">To be added.</param>
737-
<summary>To be added.</summary>
735+
<param name="date">The date part.</param>
736+
<param name="time">The time part.</param>
737+
<param name="kind">One of the enumeration values that indicates whether <paramref name="date" /> and <paramref name="time" /> specify a local time, Coordinated Universal Time (UTC), or neither.</param>
738+
<summary>Initializes a new instance of the <see cref="T:System.DateTime" /> structure to the specified <see cref="T:System.DateOnly" /> and <see cref="T:System.TimeOnly" /> and respecting the specified <see cref="T:System.DateTimeKind" />.</summary>
738739
<remarks>To be added.</remarks>
739740
</Docs>
740741
</Member>
@@ -3301,9 +3302,9 @@ The value parameter is rounded to the nearest integer.
33013302
<Parameter Name="time" Type="System.TimeOnly" RefType="out" Index="1" FrameworkAlternate="net-8.0" />
33023303
</Parameters>
33033304
<Docs>
3304-
<param name="date">To be added.</param>
3305-
<param name="time">To be added.</param>
3306-
<summary>To be added.</summary>
3305+
<param name="date">When this method returns, represents the <see cref="P:System.DateOnly" /> value of this <see cref="T:System.DateTime" /> instance.</param>
3306+
<param name="time">When this method returns, represents the <see cref="P:System.TimeOnly" /> value of this <see cref="T:System.DateTime" /> instance.</param>
3307+
<summary>Deconstructs this <see cref="T:System.DateTime" /> instance by <see cref="T:System.DateOnly" /> and <see cref="T:System.TimeOnly" />.</summary>
33073308
<remarks>To be added.</remarks>
33083309
</Docs>
33093310
</Member>
@@ -3340,10 +3341,10 @@ The value parameter is rounded to the nearest integer.
33403341
<Parameter Name="day" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-8.0" />
33413342
</Parameters>
33423343
<Docs>
3343-
<param name="year">To be added.</param>
3344-
<param name="month">To be added.</param>
3345-
<param name="day">To be added.</param>
3346-
<summary>To be added.</summary>
3344+
<param name="year">When this method returns, represents the <see cref="P:System.DateTime.Year" /> value of this <see cref="T:System.DateTime" /> instance.</param>
3345+
<param name="month">When this method returns, represents the <see cref="P:System.DateTime.Month" /> value of this <see cref="T:System.DateTime" /> instance.</param>
3346+
<param name="day">When this method returns, represents the <see cref="P:System.DateTime.Day" /> value of this <see cref="T:System.DateTime" /> instance.</param>
3347+
<summary>Deconstructs this <see cref="T:System.DateOnly" /> instance by <see cref="P:System.DateTime.Year" />, <see cref="P:System.DateTime.Month" />, and <see cref="P:System.DateTime.Day" />.</summary>
33473348
<remarks>To be added.</remarks>
33483349
</Docs>
33493350
</Member>
@@ -7113,6 +7114,7 @@ The following example demonstrates the <xref:System.DateTime.Parse%28System.Stri
71137114
]]></format>
71147115
</remarks>
71157116
<related type="Article" href="/dotnet/standard/datetime/performing-arithmetic-operations">Performing Arithmetic Operations with Dates and Times</related>
7117+
<exception cref="T:System.ArgumentOutOfRangeException">The result is less than <see cref="F:System.DateTime.MinValue">DateTime.MinValue</see> or greater than <see cref="F:System.DateTime.MaxValue">DateTime.MaxValue</see>.</exception>
71167118
</Docs>
71177119
</Member>
71187120
<Member MemberName="Subtract">
@@ -9553,6 +9555,7 @@ The following example illustrates how the string representation of a <xref:Syste
95539555
<summary>To be added.</summary>
95549556
<returns>To be added.</returns>
95559557
<remarks>To be added.</remarks>
9558+
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
95569559
</Docs>
95579560
</Member>
95589561
<Member MemberName="TryFormat">

‎xml/System/DateTimeOffset.xml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -427,10 +427,10 @@
427427
<Parameter Name="offset" Type="System.TimeSpan" Index="2" FrameworkAlternate="net-8.0" />
428428
</Parameters>
429429
<Docs>
430-
<param name="date">To be added.</param>
431-
<param name="time">To be added.</param>
432-
<param name="offset">To be added.</param>
433-
<summary>To be added.</summary>
430+
<param name="date">The date part.</param>
431+
<param name="time">The time part.</param>
432+
<param name="offset">The time's offset from Coordinated Universal Time (UTC).</param>
433+
<summary>Initializes a new instance of the <see cref="T:System.DateTimeOffset" /> structure using the specified <paramref name="date" />, <paramref name="time" />, and <paramref name="offset" />.</summary>
434434
<remarks>To be added.</remarks>
435435
</Docs>
436436
</Member>
@@ -2153,10 +2153,10 @@ The resulting <see cref="T:System.DateTimeOffset" /> value is greater than <see
21532153
<Parameter Name="offset" Type="System.TimeSpan" RefType="out" Index="2" FrameworkAlternate="net-8.0" />
21542154
</Parameters>
21552155
<Docs>
2156-
<param name="date">To be added.</param>
2157-
<param name="time">To be added.</param>
2158-
<param name="offset">To be added.</param>
2159-
<summary>To be added.</summary>
2156+
<param name="date">When this method returns, represents the <see cref="P:System.DateOnly" /> value of this <see cref="T:System.DateTimeOffset" /> instance.</param>
2157+
<param name="time">When this method returns, represents the <see cref="P:System.TimeOnly" /> value of this <see cref="T:System.DateTimeOffset" /> instance.</param>
2158+
<param name="offset">When this method returns, represents the <see cref="P:System.DateTimeOffset.Offset" /> value of this <see cref="T:System.DateTimeOffset" /> instance.</param>
2159+
<summary>Deconstructs this <see cref="T:System.DateTimeOffset" /> instance by <see cref="T:System.DateOnly" />, <see cref="T:System.TimeOnly" />, and <see cref="T:System.TimeSpan" />.</summary>
21602160
<remarks>To be added.</remarks>
21612161
</Docs>
21622162
</Member>
@@ -6199,7 +6199,7 @@ Me.ToUtcDateTime().ToFileTime()
61996199
<ReturnType>System.Int32</ReturnType>
62006200
</ReturnValue>
62016201
<Docs>
6202-
<summary>To be added.</summary>
6202+
<summary>Gets the time's offset from Coordinated Universal Time (UTC) in minutes.</summary>
62036203
<value>To be added.</value>
62046204
<remarks>To be added.</remarks>
62056205
</Docs>
@@ -6422,6 +6422,7 @@ Me.ToUtcDateTime().ToFileTime()
64226422
<summary>To be added.</summary>
64236423
<returns>To be added.</returns>
64246424
<remarks>To be added.</remarks>
6425+
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
64256426
</Docs>
64266427
</Member>
64276428
<Member MemberName="TryFormat">

‎xml/System/Decimal.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10600,6 +10600,7 @@ This member is an explicit interface member implementation. It can be used only
1060010600
<summary>To be added.</summary>
1060110601
<returns>To be added.</returns>
1060210602
<remarks>To be added.</remarks>
10603+
<inheritdoc cref="M:System.IUtf8SpanFormattable.TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)" />
1060310604
</Docs>
1060410605
</Member>
1060510606
<Member MemberName="TryFormat">

0 commit comments

Comments
 (0)