Skip to content

Commit 3813b8f

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Automatic port of System and System.Numerics documentation (#4666)
* Automatic port of System and System.Numerics documentation * Numerics docs. * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Changes to Vector.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent 78387e4 commit 3813b8f

File tree

8 files changed

+332
-248
lines changed

8 files changed

+332
-248
lines changed

‎xml/System.Numerics/Vector.xml‎

Lines changed: 52 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -824,10 +824,19 @@
824824
<Parameter Name="value" Type="System.Numerics.Vector&lt;System.Double&gt;" Index="0" FrameworkAlternate="net-5.0" />
825825
</Parameters>
826826
<Docs>
827-
<param name="value">To be added.</param>
828-
<summary>To be added.</summary>
829-
<returns>To be added.</returns>
830-
<remarks>To be added.</remarks>
827+
<param name="value">The source vector.</param>
828+
<summary>Returns a new vector whose elements are the smallest integral values that are greater than or equal to the given vector's elements.</summary>
829+
<returns>The vector whose elements are the smallest integral values that are greater than or equal to the given vector's elements.
830+
If a value is equal to <see cref="F:System.Double.NaN" />, <see cref="F:System.Double.NegativeInfinity" />, or <see cref="F:System.Double.PositiveInfinity" />, that value is returned.</returns>
831+
<remarks>
832+
<format type="text/markdown"><![CDATA[
833+
834+
## Remarks
835+
836+
Note that this method returns a <xref:System.Double> instead of an integral type.
837+
838+
]]></format>
839+
</remarks>
831840
</Docs>
832841
</Member>
833842
<Member MemberName="Ceiling">
@@ -852,10 +861,19 @@
852861
<Parameter Name="value" Type="System.Numerics.Vector&lt;System.Single&gt;" Index="0" FrameworkAlternate="net-5.0" />
853862
</Parameters>
854863
<Docs>
855-
<param name="value">To be added.</param>
856-
<summary>To be added.</summary>
857-
<returns>To be added.</returns>
858-
<remarks>To be added.</remarks>
864+
<param name="value">The source vector.</param>
865+
<summary>Returns a new vector whose elements are the smallest integral values that are greater than or equal to the given vector's elements.</summary>
866+
<returns>The vector whose elements are the smallest integral values that are greater than or equal to the given vector's elements.
867+
If a value is equal to <see cref="F:System.Single.NaN" />, <see cref="F:System.Single.NegativeInfinity" />, or <see cref="F:System.Single.PositiveInfinity" />, that value is returned.</returns>
868+
<remarks>
869+
<format type="text/markdown"><![CDATA[
870+
871+
## Remarks
872+
873+
Note that this method returns a <xref:System.Single> instead of an integral type.
874+
875+
]]></format>
876+
</remarks>
859877
</Docs>
860878
</Member>
861879
<Member MemberName="ConditionalSelect">
@@ -1728,10 +1746,19 @@
17281746
<Parameter Name="value" Type="System.Numerics.Vector&lt;System.Double&gt;" Index="0" FrameworkAlternate="net-5.0" />
17291747
</Parameters>
17301748
<Docs>
1731-
<param name="value">To be added.</param>
1732-
<summary>To be added.</summary>
1733-
<returns>To be added.</returns>
1734-
<remarks>To be added.</remarks>
1749+
<param name="value">The source vector.</param>
1750+
<summary>Returns a new vector whose elements are the largest integral values that are less than or equal to the given vector's elements.</summary>
1751+
<returns>The vector whose elements are the largest integral values that are less than or equal to the given vector's elements.
1752+
If a value is equal to <see cref="F:System.Double.NaN" />, <see cref="F:System.Double.NegativeInfinity" />, or <see cref="F:System.Double.PositiveInfinity" />, that value is returned.</returns>
1753+
<remarks>
1754+
<format type="text/markdown"><![CDATA[
1755+
1756+
## Remarks
1757+
1758+
Note that this method returns a <xref:System.Double> instead of an integral type.
1759+
1760+
]]></format>
1761+
</remarks>
17351762
</Docs>
17361763
</Member>
17371764
<Member MemberName="Floor">
@@ -1756,10 +1783,19 @@
17561783
<Parameter Name="value" Type="System.Numerics.Vector&lt;System.Single&gt;" Index="0" FrameworkAlternate="net-5.0" />
17571784
</Parameters>
17581785
<Docs>
1759-
<param name="value">To be added.</param>
1760-
<summary>To be added.</summary>
1761-
<returns>To be added.</returns>
1762-
<remarks>To be added.</remarks>
1786+
<param name="value">The source vector.</param>
1787+
<summary>Returns a new vector whose elements are the largest integral values that are less than or equal to the given vector's elements.</summary>
1788+
<returns>The vector whose elements are the largest integral values that are less than or equal to the given vector's elements.
1789+
If a value is equal to <see cref="F:System.Single.NaN" />, <see cref="F:System.Single.NegativeInfinity" />, or <see cref="F:System.Single.PositiveInfinity" />, that value is returned.</returns>
1790+
<remarks>
1791+
<format type="text/markdown"><![CDATA[
1792+
1793+
## Remarks
1794+
1795+
Note that this method returns a <xref:System.Single> instead of an integral type.
1796+
1797+
]]></format>
1798+
</remarks>
17631799
</Docs>
17641800
</Member>
17651801
<Member MemberName="GreaterThan">

‎xml/System/Decimal.xml‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -437,9 +437,10 @@
437437
<Parameter Name="bits" Type="System.ReadOnlySpan&lt;System.Int32&gt;" Index="0" FrameworkAlternate="net-5.0" />
438438
</Parameters>
439439
<Docs>
440-
<param name="bits">To be added.</param>
441-
<summary>To be added.</summary>
440+
<param name="bits">A span of four <see cref="T:System.Int32" /> values that contains a binary representation of a decimal value.</param>
441+
<summary>Initializes a new instance of <see cref="T:System.Decimal" /> to a decimal value represented in binary and contained in the specified span.</summary>
442442
<remarks>To be added.</remarks>
443+
<exception cref="T:System.ArgumentException">The length of <paramref name="bits" /> is not 4, or the representation of the decimal value in <paramref name="bits" /> is not valid.</exception>
443444
</Docs>
444445
</Member>
445446
<Member MemberName=".ctor">
@@ -1630,11 +1631,12 @@
16301631
<Parameter Name="destination" Type="System.Span&lt;System.Int32&gt;" Index="1" FrameworkAlternate="net-5.0" />
16311632
</Parameters>
16321633
<Docs>
1633-
<param name="d">To be added.</param>
1634-
<param name="destination">To be added.</param>
1635-
<summary>To be added.</summary>
1636-
<returns>To be added.</returns>
1634+
<param name="d">The value to convert.</param>
1635+
<param name="destination">The span into which to store the four-integer binary representation.</param>
1636+
<summary>Converts the value of a specified instance of <see cref="T:System.Decimal" /> to its equivalent binary representation.</summary>
1637+
<returns><see langword="4" />, which is the number of integers in the binary representation.</returns>
16371638
<remarks>To be added.</remarks>
1639+
<exception cref="T:System.ArgumentException">The destination span was not long enough to store the binary representation.</exception>
16381640
</Docs>
16391641
</Member>
16401642
<Member MemberName="GetHashCode">
@@ -7631,11 +7633,12 @@ This member is an explicit interface member implementation. It can be used only
76317633
<Parameter Name="valuesWritten" Type="System.Int32" RefType="out" Index="2" FrameworkAlternate="net-5.0" />
76327634
</Parameters>
76337635
<Docs>
7634-
<param name="d">To be added.</param>
7635-
<param name="destination">To be added.</param>
7636-
<param name="valuesWritten">To be added.</param>
7637-
<summary>To be added.</summary>
7638-
<returns>To be added.</returns>
7636+
<param name="d">The value to convert.</param>
7637+
<param name="destination">The span into which to store the binary representation.</param>
7638+
<param name="valuesWritten">The number of integers written to the destination.</param>
7639+
<summary>Tries to convert the value of a specified instance of <see cref="T:System.Decimal" /> to its equivalent binary representation.</summary>
7640+
<returns>
7641+
<see langword="true" /> if the decimal's binary representation was written to the destination; <see langword="false" /> if the destination wasn't long enough.</returns>
76397642
<remarks>To be added.</remarks>
76407643
</Docs>
76417644
</Member>

0 commit comments

Comments
 (0)