Skip to content

Commit dbc53e4

Browse files
ericstjericstj
committed
System docs
1 parent b159c2a commit dbc53e4

31 files changed

+531
-318
lines changed

‎xml/System/AggregateException.xml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -687,7 +687,9 @@
687687
<Docs>
688688
<summary>Returns the <see cref="T:System.Exception" /> that is the root cause of this exception. This exception is either the root exception or the first <see cref="T:System.AggregateException" /> that contains either multiple inner exceptions or no inner exceptions at all.</summary>
689689
<returns>The <see cref="T:System.Exception" /> that is the root cause of this exception.</returns>
690-
<remarks>To be added.</remarks>
690+
<remarks>
691+
<para>This will either be the root exception, or the first <see cref="T:System.AggregateException" /> that contains either multiple inner exceptions or no inner exceptions at all.</para>
692+
</remarks>
691693
</Docs>
692694
</Member>
693695
<Member MemberName="GetObjectData">

‎xml/System/Byte.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2223,6 +2223,7 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
22232223

22242224
]]></format>
22252225
</remarks>
2226+
<inheritdoc cref="M:System.Numerics.INumber`1.Sign(`0)" />
22262227
</Docs>
22272228
</Member>
22282229
<Member MemberName="System.IComparable.CompareTo">

‎xml/System/Convert.xml‎

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -825,10 +825,12 @@
825825
<Parameter Name="utf8Source" Type="System.ReadOnlySpan&lt;System.Byte&gt;" Index="0" FrameworkAlternate="net-10.0" />
826826
</Parameters>
827827
<Docs>
828-
<param name="utf8Source">To be added.</param>
829-
<summary>To be added.</summary>
830-
<returns>To be added.</returns>
828+
<param name="utf8Source">The UTF-8 span to convert.</param>
829+
<summary>Converts the span, which encodes binary data as hex characters, to an equivalent 8-bit unsigned integer array.</summary>
830+
<returns>An array of 8-bit unsigned integers that is equivalent to <paramref name="utf8Source" />.</returns>
831831
<remarks>To be added.</remarks>
832+
<exception cref="T:System.FormatException">The length of <paramref name="utf8Source" />, is not zero or a multiple of 2.</exception>
833+
<exception cref="T:System.FormatException">The format of <paramref name="utf8Source" /> is invalid. <paramref name="utf8Source" /> contains a non-hex character.</exception>
832834
</Docs>
833835
</Member>
834836
<Member MemberName="FromHexString">
@@ -952,12 +954,14 @@
952954
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="3" FrameworkAlternate="net-10.0" />
953955
</Parameters>
954956
<Docs>
955-
<param name="utf8Source">To be added.</param>
956-
<param name="destination">To be added.</param>
957-
<param name="bytesConsumed">To be added.</param>
958-
<param name="bytesWritten">To be added.</param>
959-
<summary>To be added.</summary>
960-
<returns>To be added.</returns>
957+
<param name="utf8Source">The span to convert.</param>
958+
<param name="destination">
959+
<para>The span in which to write the converted 8-bit unsigned integers. When this method returns value different than <see cref="F:System.Buffers.OperationStatus.Done" />, either the span remains unmodified or contains an incomplete conversion of <paramref name="utf8Source" />, up to the last valid character.</para>
960+
</param>
961+
<param name="bytesConsumed">When this method returns, contains the number of bytes that were consumed from <paramref name="utf8Source" />.</param>
962+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written to <paramref name="destination" />.</param>
963+
<summary>Converts the span of UTF-8 chars, which encodes binary data as hex characters, to an equivalent 8-bit unsigned integer span.</summary>
964+
<returns>An <see cref="T:System.Buffers.OperationStatus" /> describing the result of the operation.</returns>
961965
<remarks>To be added.</remarks>
962966
</Docs>
963967
</Member>
@@ -22911,11 +22915,12 @@
2291122915
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-10.0" />
2291222916
</Parameters>
2291322917
<Docs>
22914-
<param name="source">To be added.</param>
22915-
<param name="utf8Destination">To be added.</param>
22916-
<param name="bytesWritten">To be added.</param>
22917-
<summary>To be added.</summary>
22918-
<returns>To be added.</returns>
22918+
<param name="source">A span of 8-bit unsigned integers.</param>
22919+
<param name="utf8Destination">The UTF-8 span representation in hex of the elements in <paramref name="source" />.</param>
22920+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
22921+
<summary>Converts a span of 8-bit unsigned integers to its equivalent UTF-8 span representation that is encoded with uppercase hex characters.</summary>
22922+
<returns>
22923+
<see langword="true" /> if the conversion was successful; otherwise, <see langword="false" />.</returns>
2291922924
<remarks>To be added.</remarks>
2292022925
</Docs>
2292122926
</Member>
@@ -22989,11 +22994,12 @@
2298922994
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-10.0" />
2299022995
</Parameters>
2299122996
<Docs>
22992-
<param name="source">To be added.</param>
22993-
<param name="utf8Destination">To be added.</param>
22994-
<param name="bytesWritten">To be added.</param>
22995-
<summary>To be added.</summary>
22996-
<returns>To be added.</returns>
22997+
<param name="source">A span of 8-bit unsigned integers.</param>
22998+
<param name="utf8Destination">The UTF-8 span representation in hex of the elements in <paramref name="source" />.</param>
22999+
<param name="bytesWritten">When this method returns, contains the number of bytes that were written in <paramref name="utf8Destination" />.</param>
23000+
<summary>Converts a span of 8-bit unsigned integers to its equivalent UTF-8 span representation that is encoded with lowercase hex characters.</summary>
23001+
<returns>
23002+
<see langword="true" /> if the conversion was successful; otherwise, <see langword="false" />.</returns>
2299723003
<remarks>To be added.</remarks>
2299823004
</Docs>
2299923005
</Member>

‎xml/System/DateTime.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5108,6 +5108,7 @@ juillet 2009
51085108
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
51095109
</remarks>
51105110
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5111+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThan(`0,`1)" />
51115112
</Docs>
51125113
</Member>
51135114
<Member MemberName="op_GreaterThanOrEqual">
@@ -5174,6 +5175,7 @@ juillet 2009
51745175
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
51755176
</remarks>
51765177
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5178+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThanOrEqual(`0,`1)" />
51775179
</Docs>
51785180
</Member>
51795181
<Member MemberName="op_Inequality">
@@ -5306,6 +5308,7 @@ juillet 2009
53065308
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
53075309
</remarks>
53085310
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5311+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThan(`0,`1)" />
53095312
</Docs>
53105313
</Member>
53115314
<Member MemberName="op_LessThanOrEqual">
@@ -5372,6 +5375,7 @@ juillet 2009
53725375
The equivalent method for this operator is <xref:System.DateTime.Compare%28System.DateTime%2CSystem.DateTime%29?displayProperty=nameWithType>]]></format>
53735376
</remarks>
53745377
<altmember cref="M:System.DateTime.CompareTo(System.DateTime)" />
5378+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThanOrEqual(`0,`1)" />
53755379
</Docs>
53765380
</Member>
53775381
<MemberGroup MemberName="op_Subtraction">

‎xml/System/DateTimeOffset.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3652,6 +3652,7 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
36523652

36533653
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
36543654
</remarks>
3655+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThan(`0,`1)" />
36553656
</Docs>
36563657
</Member>
36573658
<Member MemberName="op_GreaterThanOrEqual">
@@ -3724,6 +3725,7 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
37243725

37253726
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
37263727
</remarks>
3728+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThanOrEqual(`0,`1)" />
37273729
</Docs>
37283730
</Member>
37293731
<Member MemberName="op_Implicit">
@@ -3940,6 +3942,7 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
39403942

39413943
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
39423944
</remarks>
3945+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThan(`0,`1)" />
39433946
</Docs>
39443947
</Member>
39453948
<Member MemberName="op_LessThanOrEqual">
@@ -4012,6 +4015,7 @@ If you rely on properties such as <xref:System.DateTimeOffset.Now> or <xref:Syst
40124015

40134016
The equivalent method for this operator is <xref:System.DateTimeOffset.Compare%28System.DateTimeOffset%2CSystem.DateTimeOffset%29?displayProperty=nameWithType>]]></format>
40144017
</remarks>
4018+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThanOrEqual(`0,`1)" />
40154019
</Docs>
40164020
</Member>
40174021
<MemberGroup MemberName="op_Subtraction">

‎xml/System/Decimal.xml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3390,6 +3390,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
33903390
</remarks>
33913391
<exception cref="T:System.OverflowException">The return value is less than <see cref="F:System.Decimal.MinValue">Decimal.MinValue</see> or greater than <see cref="F:System.Decimal.MaxValue">Decimal.MaxValue</see>.</exception>
33923392
<altmember cref="M:System.Decimal.Subtract(System.Decimal,System.Decimal)" />
3393+
<inheritdoc cref="M:System.Numerics.IDecrementOperators`1.op_Decrement(`0)" />
33933394
</Docs>
33943395
</Member>
33953396
<Member MemberName="op_Division">
@@ -3468,6 +3469,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
34683469
<paramref name="d2" /> is zero.</exception>
34693470
<exception cref="T:System.OverflowException">The return value is less than <see cref="F:System.Decimal.MinValue">Decimal.MinValue</see> or greater than <see cref="F:System.Decimal.MaxValue">Decimal.MaxValue</see>.</exception>
34703471
<altmember cref="M:System.Decimal.Divide(System.Decimal,System.Decimal)" />
3472+
<inheritdoc cref="M:System.Numerics.IDivisionOperators`3.op_Division(`0,`1)" />
34713473
</Docs>
34723474
</Member>
34733475
<Member MemberName="op_Equality">
@@ -3545,6 +3547,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
35453547
</remarks>
35463548
<altmember cref="M:System.Decimal.Equals(System.Object)" />
35473549
<altmember cref="M:System.Decimal.op_Inequality(System.Decimal,System.Decimal)" />
3550+
<inheritdoc cref="M:System.Numerics.IEqualityOperators`3.op_Equality(`0,`1)" />
35483551
</Docs>
35493552
</Member>
35503553
<MemberGroup MemberName="op_Explicit">
@@ -4537,6 +4540,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
45374540
The equivalent method for this operator is <xref:System.Decimal.Compare%28System.Decimal%2CSystem.Decimal%29?displayProperty=nameWithType>]]></format>
45384541
</remarks>
45394542
<altmember cref="M:System.Decimal.Compare(System.Decimal,System.Decimal)" />
4543+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThan(`0,`1)" />
45404544
</Docs>
45414545
</Member>
45424546
<Member MemberName="op_GreaterThanOrEqual">
@@ -4615,6 +4619,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
46154619
The equivalent method for this operator is <xref:System.Decimal.Compare%28System.Decimal%2CSystem.Decimal%29?displayProperty=nameWithType>]]></format>
46164620
</remarks>
46174621
<altmember cref="M:System.Decimal.Compare(System.Decimal,System.Decimal)" />
4622+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_GreaterThanOrEqual(`0,`1)" />
46184623
</Docs>
46194624
</Member>
46204625
<MemberGroup MemberName="op_Implicit">
@@ -5318,6 +5323,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
53185323
</remarks>
53195324
<exception cref="T:System.OverflowException">The return value is less than <see cref="F:System.Decimal.MinValue">Decimal.MinValue</see> or greater than <see cref="F:System.Decimal.MaxValue">Decimal.MaxValue</see>.</exception>
53205325
<altmember cref="M:System.Decimal.Add(System.Decimal,System.Decimal)" />
5326+
<inheritdoc cref="M:System.Numerics.IIncrementOperators`1.op_Increment(`0)" />
53215327
</Docs>
53225328
</Member>
53235329
<Member MemberName="op_Inequality">
@@ -5398,6 +5404,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
53985404
</remarks>
53995405
<altmember cref="M:System.Decimal.Equals(System.Object)" />
54005406
<altmember cref="M:System.Decimal.op_Equality(System.Decimal,System.Decimal)" />
5407+
<inheritdoc cref="M:System.Numerics.IEqualityOperators`3.op_Inequality(`0,`1)" />
54015408
</Docs>
54025409
</Member>
54035410
<Member MemberName="op_LessThan">
@@ -5476,6 +5483,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
54765483
The equivalent method for this operator is <xref:System.Decimal.Compare%28System.Decimal%2CSystem.Decimal%29?displayProperty=nameWithType>]]></format>
54775484
</remarks>
54785485
<altmember cref="M:System.Decimal.Compare(System.Decimal,System.Decimal)" />
5486+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThan(`0,`1)" />
54795487
</Docs>
54805488
</Member>
54815489
<Member MemberName="op_LessThanOrEqual">
@@ -5554,6 +5562,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
55545562
The equivalent method for this operator is <xref:System.Decimal.Compare%28System.Decimal%2CSystem.Decimal%29?displayProperty=nameWithType>]]></format>
55555563
</remarks>
55565564
<altmember cref="M:System.Decimal.Compare(System.Decimal,System.Decimal)" />
5565+
<inheritdoc cref="M:System.Numerics.IComparisonOperators`3.op_LessThanOrEqual(`0,`1)" />
55575566
</Docs>
55585567
</Member>
55595568
<Member MemberName="op_Modulus">
@@ -5627,6 +5636,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
56275636
<paramref name="d2" /> is <see langword="zero" />.</exception>
56285637
<exception cref="T:System.OverflowException">The return value is less than <see cref="F:System.Decimal.MinValue">Decimal.MinValue</see> or greater than <see cref="F:System.Decimal.MaxValue">Decimal.MaxValue</see>.</exception>
56295638
<altmember cref="M:System.Decimal.Remainder(System.Decimal,System.Decimal)" />
5639+
<inheritdoc cref="M:System.Numerics.IModulusOperators`3.op_Modulus(`0,`1)" />
56305640
</Docs>
56315641
</Member>
56325642
<Member MemberName="op_Multiply">
@@ -5703,6 +5713,7 @@ For <xref:System.Numerics.IFloatingPointIeee754%601>, this method matches the IE
57035713
</remarks>
57045714
<exception cref="T:System.OverflowException">The return value is less than <see cref="F:System.Decimal.MinValue">Decimal.MinValue</see> or greater than <see cref="F:System.Decimal.MaxValue">Decimal.MaxValue</see>.</exception>
57055715
<altmember cref="M:System.Decimal.Multiply(System.Decimal,System.Decimal)" />
5716+
<inheritdoc cref="M:System.Numerics.IMultiplyOperators`3.op_Multiply(`0,`1)" />
57065717
</Docs>
57075718
</Member>
57085719
<Member MemberName="op_Subtraction">
@@ -7036,6 +7047,7 @@ It is recommended that a function return `1`, `0`, and `-1`, respectively.
70367047

70377048
]]></format>
70387049
</remarks>
7050+
<inheritdoc cref="M:System.Numerics.INumber`1.Sign(`0)" />
70397051
</Docs>
70407052
</Member>
70417053
<Member MemberName="Subtract">

0 commit comments

Comments
 (0)