Skip to content

Commit 11c7735

Browse files
tannergoodingcarlossanlop
tannergooding
and
carlossanlop
authored
Adding API docs for the new IntPtr/UIntPtr and Math/MathF members (#4752)
* Adding API docs for the new IntPtr and UIntPtr members * Adding API docs for the new Math and MathF members * Apply suggestions from code review Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]>
1 parent 8ea7994 commit 11c7735

File tree

4 files changed

+170
-116
lines changed

4 files changed

+170
-116
lines changed

‎xml/System/IntPtr.xml

Lines changed: 66 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@
415415
<Parameter Name="value" Type="System.IntPtr" Index="0" FrameworkAlternate="net-5.0" />
416416
</Parameters>
417417
<Docs>
418-
<param name="value">To be added.</param>
418+
<param name="value">A signed native integer to compare.</param>
419419
<summary>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</summary>
420420
<returns>A value that indicates the relative order of the objects being compared. The return value has these meanings:
421421
<list type="table"><listheader><term> Value
@@ -458,7 +458,7 @@
458458
<Parameter Name="value" Type="System.Object" Index="0" FrameworkAlternate="net-5.0" />
459459
</Parameters>
460460
<Docs>
461-
<param name="value">To be added.</param>
461+
<param name="value">An object to compare, or <see langword="null" />.</param>
462462
<summary>Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.</summary>
463463
<returns>A value that indicates the relative order of the objects being compared. The return value has these meanings:
464464
<list type="table"><listheader><term> Value
@@ -632,7 +632,7 @@
632632
<ReturnType>System.IntPtr</ReturnType>
633633
</ReturnValue>
634634
<Docs>
635-
<summary>To be added.</summary>
635+
<summary>Represents the largest possible value of <see cref="T:System.IntPtr" />.</summary>
636636
<value>To be added.</value>
637637
<remarks>To be added.</remarks>
638638
</Docs>
@@ -659,7 +659,7 @@
659659
<ReturnType>System.IntPtr</ReturnType>
660660
</ReturnValue>
661661
<Docs>
662-
<summary>To be added.</summary>
662+
<summary>Represents the smallest possible value of <see cref="T:System.IntPtr" />.</summary>
663663
<value>To be added.</value>
664664
<remarks>To be added.</remarks>
665665
</Docs>
@@ -1326,10 +1326,16 @@
13261326
<Parameter Name="s" Type="System.String" Index="0" FrameworkAlternate="net-5.0" />
13271327
</Parameters>
13281328
<Docs>
1329-
<param name="s">To be added.</param>
1330-
<summary>To be added.</summary>
1331-
<returns>To be added.</returns>
1329+
<param name="s">A string containing a number to convert.</param>
1330+
<summary>Converts the string representation of a number to its signed native integer equivalent.</summary>
1331+
<returns>A signed native integer equivalent to the number contained in <paramref name="s" />.</returns>
13321332
<remarks>To be added.</remarks>
1333+
<exception cref="T:System.ArgumentNullException">
1334+
<paramref name="s" /> is <see langword="null" />.</exception>
1335+
<exception cref="T:System.FormatException">
1336+
<paramref name="s" /> is not in the correct format.</exception>
1337+
<exception cref="T:System.OverflowException">
1338+
<paramref name="s" /> represents a number less than <see cref="P:System.IntPtr.MinValue" /> or greater than <see cref="P:System.IntPtr.MaxValue" />.</exception>
13331339
</Docs>
13341340
</Member>
13351341
<Member MemberName="Parse">
@@ -1358,11 +1364,19 @@
13581364
<Parameter Name="style" Type="System.Globalization.NumberStyles" Index="1" FrameworkAlternate="net-5.0" />
13591365
</Parameters>
13601366
<Docs>
1361-
<param name="s">To be added.</param>
1362-
<param name="style">To be added.</param>
1363-
<summary>To be added.</summary>
1364-
<returns>To be added.</returns>
1367+
<param name="s">A string containing a number to convert.</param>
1368+
<param name="style">A bitwise combination of the enumeration values that indicates the style elements that can be present in <paramref name="s" />.</param>
1369+
<summary>Converts the string representation of a number in a specified style to its signed native integer equivalent.</summary>
1370+
<returns>A signed native integer equivalent to the number contained in <paramref name="s" />.</returns>
13651371
<remarks>To be added.</remarks>
1372+
<exception cref="T:System.ArgumentNullException">
1373+
<paramref name="s" /> is <see langword="null" />.</exception>
1374+
<exception cref="T:System.ArgumentException">
1375+
<paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value or <paramref name="style" /> is not a combination of <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> and <see cref="F:System.Globalization.NumberStyles.HexNumber" /> values.</exception>
1376+
<exception cref="T:System.FormatException">
1377+
<paramref name="s" /> is not in the correct format.</exception>
1378+
<exception cref="T:System.OverflowException">
1379+
<paramref name="s" /> represents a number less than <see cref="P:System.IntPtr.MinValue" /> or greater than <see cref="P:System.IntPtr.MaxValue" />.</exception>
13661380
</Docs>
13671381
</Member>
13681382
<Member MemberName="Parse">
@@ -1391,11 +1405,17 @@
13911405
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-5.0" />
13921406
</Parameters>
13931407
<Docs>
1394-
<param name="s">To be added.</param>
1395-
<param name="provider">To be added.</param>
1396-
<summary>To be added.</summary>
1397-
<returns>To be added.</returns>
1408+
<param name="s">A string containing a number to convert.</param>
1409+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
1410+
<summary>Converts the string representation of a number in a specified culture-specific format to its signed native integer equivalent.</summary>
1411+
<returns>A signed native integer equivalent to the number contained in <paramref name="s" />.</returns>
13981412
<remarks>To be added.</remarks>
1413+
<exception cref="T:System.ArgumentNullException">
1414+
<paramref name="s" /> is <see langword="null" />.</exception>
1415+
<exception cref="T:System.FormatException">
1416+
<paramref name="s" /> is not in the correct format.</exception>
1417+
<exception cref="T:System.OverflowException">
1418+
<paramref name="s" /> represents a number less than <see cref="P:System.IntPtr.MinValue" /> or greater than <see cref="P:System.IntPtr.MaxValue" />.</exception>
13991419
</Docs>
14001420
</Member>
14011421
<Member MemberName="Parse">
@@ -1425,12 +1445,20 @@
14251445
<Parameter Name="provider" Type="System.IFormatProvider" Index="2" FrameworkAlternate="net-5.0" />
14261446
</Parameters>
14271447
<Docs>
1428-
<param name="s">To be added.</param>
1429-
<param name="style">To be added.</param>
1430-
<param name="provider">To be added.</param>
1431-
<summary>To be added.</summary>
1432-
<returns>To be added.</returns>
1448+
<param name="s">A string containing a number to convert.</param>
1449+
<param name="style">A bitwise combination of the enumeration values that indicates the style elements that can be present in <paramref name="s" />.</param>
1450+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
1451+
<summary>Converts the string representation of a number in a specified style and culture-specific format to its signed native integer equivalent.</summary>
1452+
<returns>A signed native integer equivalent to the number contained in <paramref name="s" />.</returns>
14331453
<remarks>To be added.</remarks>
1454+
<exception cref="T:System.ArgumentNullException">
1455+
<paramref name="s" /> is <see langword="null" />.</exception>
1456+
<exception cref="T:System.ArgumentException">
1457+
<paramref name="style" /> is not a <see cref="T:System.Globalization.NumberStyles" /> value or <paramref name="style" /> is not a combination of <see cref="F:System.Globalization.NumberStyles.AllowHexSpecifier" /> and <see cref="F:System.Globalization.NumberStyles.HexNumber" /> values.</exception>
1458+
<exception cref="T:System.FormatException">
1459+
<paramref name="s" /> is not in the correct format.</exception>
1460+
<exception cref="T:System.OverflowException">
1461+
<paramref name="s" /> represents a number less than <see cref="P:System.IntPtr.MinValue" /> or greater than <see cref="P:System.IntPtr.MaxValue" />.</exception>
14341462
</Docs>
14351463
</Member>
14361464
<Member MemberName="Size">
@@ -1946,9 +1974,9 @@ This member is an explicit interface member implementation. It can be used only
19461974
<Parameter Name="provider" Type="System.IFormatProvider" Index="0" FrameworkAlternate="net-5.0" />
19471975
</Parameters>
19481976
<Docs>
1949-
<param name="provider">To be added.</param>
1950-
<summary>To be added.</summary>
1951-
<returns>To be added.</returns>
1977+
<param name="provider">An object that supplies culture-specific formatting information.</param>
1978+
<summary>Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.</summary>
1979+
<returns>The string representation of the value of this instance as specified by <paramref name="provider" />.</returns>
19521980
<remarks>To be added.</remarks>
19531981
</Docs>
19541982
</Member>
@@ -2013,6 +2041,8 @@ This member is an explicit interface member implementation. It can be used only
20132041
<related type="Article" href="/dotnet/standard/base-types/standard-numeric-format-strings">Standard Numeric Format Strings</related>
20142042
<related type="Article" href="/dotnet/standard/base-types/custom-numeric-format-strings">Custom Numeric Format Strings</related>
20152043
<related type="Article" href="/dotnet/standard/base-types/formatting-types">Formatting Types in .NET</related>
2044+
<exception cref="T:System.FormatException">
2045+
<paramref name="format" /> is invalid or not supported.</exception>
20162046
</Docs>
20172047
</Member>
20182048
<Member MemberName="ToString">
@@ -2047,7 +2077,7 @@ This member is an explicit interface member implementation. It can be used only
20472077
<param name="format">The format to use.
20482078
-or-
20492079
A <see langword="null" /> reference (<see langword="Nothing" /> in Visual Basic) to use the default format defined for the type of the <see cref="T:System.IFormattable" /> implementation.</param>
2050-
<param name="provider">To be added.</param>
2080+
<param name="provider">An object that supplies culture-specific formatting information.</param>
20512081
<summary>Formats the value of the current instance using the specified format.</summary>
20522082
<returns>The value of the current instance in the specified format.</returns>
20532083
<remarks>To be added.</remarks>
@@ -2079,10 +2109,11 @@ This member is an explicit interface member implementation. It can be used only
20792109
<Parameter Name="result" Type="System.IntPtr" RefType="out" Index="1" FrameworkAlternate="net-5.0" />
20802110
</Parameters>
20812111
<Docs>
2082-
<param name="s">To be added.</param>
2083-
<param name="result">To be added.</param>
2084-
<summary>To be added.</summary>
2085-
<returns>To be added.</returns>
2112+
<param name="s">A string containing a number to convert.</param>
2113+
<param name="result">When this method returns, contains the signed native integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or Empty, is not of the correct format, or represents a number less than <see cref="P:System.IntPtr.MinValue" /> or greater than <see cref="P:System.IntPtr.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.</param>
2114+
<summary>Converts the string representation of a number to its signed native integer equivalent. A return value indicates whether the conversion succeeded.</summary>
2115+
<returns>
2116+
<see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
20862117
<remarks>To be added.</remarks>
20872118
</Docs>
20882119
</Member>
@@ -2114,12 +2145,13 @@ This member is an explicit interface member implementation. It can be used only
21142145
<Parameter Name="result" Type="System.IntPtr" RefType="out" Index="3" FrameworkAlternate="net-5.0" />
21152146
</Parameters>
21162147
<Docs>
2117-
<param name="s">To be added.</param>
2118-
<param name="style">To be added.</param>
2119-
<param name="provider">To be added.</param>
2120-
<param name="result">To be added.</param>
2121-
<summary>To be added.</summary>
2122-
<returns>To be added.</returns>
2148+
<param name="s">A string containing a number to convert. The string is interpreted using the style specified by <paramref name="style" />.</param>
2149+
<param name="style">A bitwise combination of enumeration values that indicates the style elements that can be present in <paramref name="s" />.</param>
2150+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
2151+
<param name="result">When this method returns, contains the signed native integer value equivalent of the number contained in <paramref name="s" />, if the conversion succeeded, or zero if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" /> or Empty, is not of the correct format, or represents a number less than <see cref="P:System.IntPtr.MinValue" /> or greater than <see cref="P:System.IntPtr.MaxValue" />. This parameter is passed uninitialized; any value originally supplied in result will be overwritten.</param>
2152+
<summary>Converts the string representation of a number in a specified style and culture-specific format to its signed native integer equivalent. A return value indicates whether the conversion succeeded.</summary>
2153+
<returns>
2154+
<see langword="true" /> if <paramref name="s" /> was converted successfully; otherwise, <see langword="false" />.</returns>
21232155
<remarks>To be added.</remarks>
21242156
</Docs>
21252157
</Member>

‎xml/System/Math.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6585,7 +6585,7 @@ The following example demonstrates how to use the <xref:System.Math.Round%28Syst
65856585
</ReturnValue>
65866586
<MemberValue>6.2831853071795862</MemberValue>
65876587
<Docs>
6588-
<summary>To be added.</summary>
6588+
<summary>Represents the number of radians in one turn, specified by the constant, &#x3C4;.</summary>
65896589
<remarks>To be added.</remarks>
65906590
</Docs>
65916591
</Member>

0 commit comments

Comments
 (0)