Skip to content

Commit 19980b8

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Port new docs for System.CodeDom, System.Globalization and System.Runtime.CompilerServices, System.Net (EII) and System.Data.SqlTypes (EII) (dotnet#9131)
* System.CodeDom * System.Globalization * System.Runtime.CompilerServices * System.Net (EII) * System.Data.SqlTypes (EII) * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> --------- Co-authored-by: Genevieve Warren <[email protected]>
1 parent a556c3b commit 19980b8

File tree

8 files changed

+97
-87
lines changed

8 files changed

+97
-87
lines changed

‎xml/System.CodeDom.Compiler/IndentedTextWriter.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -490,9 +490,9 @@
490490
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="net-8.0" />
491491
</Parameters>
492492
<Docs>
493-
<param name="cancellationToken">To be added.</param>
494-
<summary>To be added.</summary>
495-
<returns>To be added.</returns>
493+
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests.</param>
494+
<summary>Clears all buffers for this <see cref="T:System.CodeDom.Compiler.IndentedTextWriter" /> asynchronously and causes any buffered data to be written to the underlying device.</summary>
495+
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous flush operation.</returns>
496496
<remarks>To be added.</remarks>
497497
</Docs>
498498
</Member>

‎xml/System.Data.SqlTypes/SqlGuid.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1690,9 +1690,9 @@
16901690
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" Index="1" FrameworkAlternate="net-8.0" />
16911691
</Parameters>
16921692
<Docs>
1693-
<param name="info">To be added.</param>
1694-
<param name="context">To be added.</param>
1695-
<summary>To be added.</summary>
1693+
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
1694+
<param name="context">The destination (see <see cref="T:System.Runtime.Serialization.StreamingContext" />) for this serialization.</param>
1695+
<summary>Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data needed to serialize the target object.</summary>
16961696
<remarks>To be added.</remarks>
16971697
</Docs>
16981698
</Member>

‎xml/System.Globalization/NumberStyles.xml

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -59,40 +59,40 @@
5959
<Docs>
6060
<summary>Determines the styles permitted in numeric string arguments that are passed to the <see langword="Parse" /> and <see langword="TryParse" /> methods of the integral and floating-point numeric types.</summary>
6161
<remarks>
62-
<format type="text/markdown"><![CDATA[
63-
64-
## Remarks
65-
The <xref:System.Globalization.NumberStyles> enumeration consists of two kinds of enumeration values that are used to parse the string representations of numeric values:
66-
67-
- Individual field flags, which define specific style elements (such as white space and group separators) that can be present in the parsed string.
68-
69-
- Composite number styles, which consist of multiple field flags that define the style elements that can be present in the parsed string.
70-
71-
Except for `AllowHexSpecifier`, the individual field flags in the <xref:System.Globalization.NumberStyles> enumeration define style elements that are used when parsing the string representation of a decimal number. `None` indicates that only digits can be present in the parsed string. The remaining individual field flags define style elements that may be, but do not have to be, present in the string representation of a decimal number for the parse operation to succeed. In contrast, the `AllowHexSpecifier` flag indicates that the string to be parsed is always interpreted as a hexadecimal value. The only individual field flags that can be used with `AllowHexSpecifier` are `AllowLeadingWhite` and `AllowTrailingWhite`. The <xref:System.Globalization.NumberStyles> enumeration includes a composite number style, `HexNumber`, that consists of all three flags.
72-
73-
The symbols (such as the currency symbol, the group separator, the decimal separator, and the positive and negative signs) that can appear in the string to be parsed are defined by the members of the <xref:System.Globalization.NumberFormatInfo?displayProperty=nameWithType> object that is passed either implicitly or explicitly to the `Parse` method. The members table in this topic provides a description of each individual flag and indicates its relationship to <xref:System.Globalization.NumberFormatInfo> properties.
74-
75-
The following table lists the composite number styles and indicates which individual field flags they include. A "1" in a cell indicates that the composite number style includes the individual number style in that row. A "0" indicates that the composite number style does not include the individual number style.
76-
77-
||Any|Currency|Float|Integer|Number|HexNumber|
78-
|-|---------|--------------|-----------|-------------|------------|---------------|
79-
|AllowHexSpecifier (0x0200)|0|0|0|0|0|1|
80-
|AllowCurrencySymbol (0x0100)|1|1|0|0|0|0|
81-
|AllowExponent (0x0080)|1|0|1|0|0|0|
82-
|AllowThousands (0x0040)|1|1|0|0|1|0|
83-
|AllowDecimalPoint (0x0020)|1|1|1|0|1|0|
84-
|AllowParentheses (0x0010)|1|1|0|0|0|0|
85-
|AllowTrailingSign (0x0008)|1|1|0|0|1|0|
86-
|AllowLeadingSign (0x0004)|1|1|1|1|1|0|
87-
|AllowTrailingWhite (0x0002)|1|1|1|1|1|1|
88-
|AllowLeadingWhite (0x0001)|1|1|1|1|1|1|
89-
||(0x1ff)|(0x17f)|(0x0a7)|(0x007)|(0x06f)|(0x203)|
90-
91-
92-
93-
## Examples
94-
This example shows how to parse a string into a 32-bit integer by using various `NumberStyles` flags.
95-
62+
<format type="text/markdown"><![CDATA[
63+
64+
## Remarks
65+
The <xref:System.Globalization.NumberStyles> enumeration consists of two kinds of enumeration values that are used to parse the string representations of numeric values:
66+
67+
- Individual field flags, which define specific style elements (such as white space and group separators) that can be present in the parsed string.
68+
69+
- Composite number styles, which consist of multiple field flags that define the style elements that can be present in the parsed string.
70+
71+
Except for `AllowHexSpecifier`, the individual field flags in the <xref:System.Globalization.NumberStyles> enumeration define style elements that are used when parsing the string representation of a decimal number. `None` indicates that only digits can be present in the parsed string. The remaining individual field flags define style elements that may be, but do not have to be, present in the string representation of a decimal number for the parse operation to succeed. In contrast, the `AllowHexSpecifier` flag indicates that the string to be parsed is always interpreted as a hexadecimal value. The only individual field flags that can be used with `AllowHexSpecifier` are `AllowLeadingWhite` and `AllowTrailingWhite`. The <xref:System.Globalization.NumberStyles> enumeration includes a composite number style, `HexNumber`, that consists of all three flags.
72+
73+
The symbols (such as the currency symbol, the group separator, the decimal separator, and the positive and negative signs) that can appear in the string to be parsed are defined by the members of the <xref:System.Globalization.NumberFormatInfo?displayProperty=nameWithType> object that is passed either implicitly or explicitly to the `Parse` method. The members table in this topic provides a description of each individual flag and indicates its relationship to <xref:System.Globalization.NumberFormatInfo> properties.
74+
75+
The following table lists the composite number styles and indicates which individual field flags they include. A "1" in a cell indicates that the composite number style includes the individual number style in that row. A "0" indicates that the composite number style does not include the individual number style.
76+
77+
||Any|Currency|Float|Integer|Number|HexNumber|
78+
|-|---------|--------------|-----------|-------------|------------|---------------|
79+
|AllowHexSpecifier (0x0200)|0|0|0|0|0|1|
80+
|AllowCurrencySymbol (0x0100)|1|1|0|0|0|0|
81+
|AllowExponent (0x0080)|1|0|1|0|0|0|
82+
|AllowThousands (0x0040)|1|1|0|0|1|0|
83+
|AllowDecimalPoint (0x0020)|1|1|1|0|1|0|
84+
|AllowParentheses (0x0010)|1|1|0|0|0|0|
85+
|AllowTrailingSign (0x0008)|1|1|0|0|1|0|
86+
|AllowLeadingSign (0x0004)|1|1|1|1|1|0|
87+
|AllowTrailingWhite (0x0002)|1|1|1|1|1|1|
88+
|AllowLeadingWhite (0x0001)|1|1|1|1|1|1|
89+
||(0x1ff)|(0x17f)|(0x0a7)|(0x007)|(0x06f)|(0x203)|
90+
91+
92+
93+
## Examples
94+
This example shows how to parse a string into a 32-bit integer by using various `NumberStyles` flags.
95+
9696
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/NumberStyles/cpp/NumberStyles.cpp" id="Snippet1":::
9797
:::code language="csharp" source="~/snippets/csharp/System.Globalization/NumberStyles/Overview/NumberStyles.cs" interactive="try-dotnet" id="Snippet1":::
9898
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/NumberStyles/vb/numberstyles.vb" id="Snippet1":::
@@ -125,7 +125,7 @@
125125
</ReturnValue>
126126
<MemberValue>1024</MemberValue>
127127
<Docs>
128-
<summary>To be added.</summary>
128+
<summary>Indicates that the numeric string represents a binary value. Valid binary values include the numeric digits 0 and 1. Strings that are parsed using this style do not employ a prefix; <c>0b</c> cannot be used. A string that is parsed with the <see cref="F:System.Globalization.NumberStyles.AllowBinarySpecifier" /> style will always be interpreted as a binary value. The only flags that can be combined with <see cref="F:System.Globalization.NumberStyles.AllowBinarySpecifier" /> are <see cref="F:System.Globalization.NumberStyles.AllowLeadingWhite" /> and <see cref="F:System.Globalization.NumberStyles.AllowTrailingWhite" />. The <see cref="T:System.Globalization.NumberStyles" /> enumeration includes a composite style, <see cref="F:System.Globalization.NumberStyles.BinaryNumber" />, that consists of these three flags.</summary>
129129
</Docs>
130130
</Member>
131131
<Member MemberName="AllowCurrencySymbol">
@@ -613,7 +613,7 @@
613613
</ReturnValue>
614614
<MemberValue>1027</MemberValue>
615615
<Docs>
616-
<summary>To be added.</summary>
616+
<summary>Indicates that the <see cref="F:System.Globalization.NumberStyles.AllowLeadingWhite" />, <see cref="F:System.Globalization.NumberStyles.AllowTrailingWhite" />, and <see cref="F:System.Globalization.NumberStyles.AllowBinarySpecifier" /> styles are used. This is a composite number style.</summary>
617617
</Docs>
618618
</Member>
619619
<Member MemberName="Currency">

‎xml/System.Net/IPAddress.xml

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2177,10 +2177,14 @@
21772177
<Parameter Name="formatProvider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
21782178
</Parameters>
21792179
<Docs>
2180-
<param name="format">To be added.</param>
2181-
<param name="formatProvider">To be added.</param>
2182-
<summary>To be added.</summary>
2183-
<returns>To be added.</returns>
2180+
<param name="format">The format to use.
2181+
-or-
2182+
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>
2183+
<param name="formatProvider">The provider to use to format the value.
2184+
-or-
2185+
A <see langword="null" /> reference (<see langword="Nothing" /> in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.</param>
2186+
<summary>Formats the value of the current instance using the specified format.</summary>
2187+
<returns>The value of the current instance in the specified format.</returns>
21842188
<remarks>To be added.</remarks>
21852189
</Docs>
21862190
</Member>
@@ -2216,10 +2220,10 @@
22162220
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
22172221
</Parameters>
22182222
<Docs>
2219-
<param name="s">To be added.</param>
2220-
<param name="provider">To be added.</param>
2221-
<summary>To be added.</summary>
2222-
<returns>To be added.</returns>
2223+
<param name="s">The string to parse.</param>
2224+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
2225+
<summary>Parses a string into a value.</summary>
2226+
<returns>The result of parsing <paramref name="s" />.</returns>
22232227
<remarks>To be added.</remarks>
22242228
</Docs>
22252229
</Member>
@@ -2309,12 +2313,13 @@
23092313
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="net-8.0" />
23102314
</Parameters>
23112315
<Docs>
2312-
<param name="destination">To be added.</param>
2313-
<param name="charsWritten">To be added.</param>
2314-
<param name="format">To be added.</param>
2315-
<param name="provider">To be added.</param>
2316-
<summary>To be added.</summary>
2317-
<returns>To be added.</returns>
2316+
<param name="destination">The span in which to write this instance's value formatted as a span of characters.</param>
2317+
<param name="charsWritten">When this method returns, contains the number of characters that were written in <paramref name="destination" />.</param>
2318+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
2319+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
2320+
<summary>Tries to format the value of the current instance into the provided span of characters.</summary>
2321+
<returns>
2322+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
23182323
<remarks>To be added.</remarks>
23192324
</Docs>
23202325
</Member>
@@ -2350,10 +2355,10 @@
23502355
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
23512356
</Parameters>
23522357
<Docs>
2353-
<param name="s">To be added.</param>
2354-
<param name="provider">To be added.</param>
2355-
<summary>To be added.</summary>
2356-
<returns>To be added.</returns>
2358+
<param name="s">The span of characters to parse.</param>
2359+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
2360+
<summary>Parses a span of characters into a value.</summary>
2361+
<returns>The result of parsing <paramref name="s" />.</returns>
23572362
<remarks>To be added.</remarks>
23582363
</Docs>
23592364
</Member>

‎xml/System.Net/IPNetwork.xml

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,10 @@
137137
<Parameter Name="other" Type="System.Net.IPNetwork" />
138138
</Parameters>
139139
<Docs>
140-
<param name="other">To be added.</param>
141-
<summary>To be added.</summary>
142-
<returns>To be added.</returns>
140+
<param name="other">An object to compare with this object.</param>
141+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
142+
<returns>
143+
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
143144
<remarks>To be added.</remarks>
144145
</Docs>
145146
</Member>
@@ -345,10 +346,12 @@
345346
<Parameter Name="provider" Type="System.IFormatProvider" />
346347
</Parameters>
347348
<Docs>
348-
<param name="format">To be added.</param>
349+
<param name="format">The format to use.
350+
-or-
351+
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>
349352
<param name="provider">To be added.</param>
350-
<summary>To be added.</summary>
351-
<returns>To be added.</returns>
353+
<summary>Formats the value of the current instance using the specified format.</summary>
354+
<returns>The value of the current instance in the specified format.</returns>
352355
<remarks>To be added.</remarks>
353356
</Docs>
354357
</Member>
@@ -382,10 +385,10 @@
382385
<Parameter Name="provider" Type="System.IFormatProvider" />
383386
</Parameters>
384387
<Docs>
385-
<param name="s">To be added.</param>
386-
<param name="provider">To be added.</param>
387-
<summary>To be added.</summary>
388-
<returns>To be added.</returns>
388+
<param name="s">The string to parse.</param>
389+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
390+
<summary>Parses a string into a value.</summary>
391+
<returns>The result of parsing <paramref name="s" />.</returns>
389392
<remarks>To be added.</remarks>
390393
</Docs>
391394
</Member>
@@ -450,12 +453,13 @@
450453
<Parameter Name="provider" Type="System.IFormatProvider" />
451454
</Parameters>
452455
<Docs>
453-
<param name="destination">To be added.</param>
454-
<param name="charsWritten">To be added.</param>
455-
<param name="format">To be added.</param>
456-
<param name="provider">To be added.</param>
457-
<summary>To be added.</summary>
458-
<returns>To be added.</returns>
456+
<param name="destination">The span in which to write this instance's value formatted as a span of characters.</param>
457+
<param name="charsWritten">When this method returns, contains the number of characters that were written in <paramref name="destination" />.</param>
458+
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format for <paramref name="destination" />.</param>
459+
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
460+
<summary>Tries to format the value of the current instance into the provided span of characters.</summary>
461+
<returns>
462+
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
459463
<remarks>To be added.</remarks>
460464
</Docs>
461465
</Member>
@@ -482,10 +486,10 @@
482486
<Parameter Name="provider" Type="System.IFormatProvider" />
483487
</Parameters>
484488
<Docs>
485-
<param name="s">To be added.</param>
486-
<param name="provider">To be added.</param>
487-
<summary>To be added.</summary>
488-
<returns>To be added.</returns>
489+
<param name="s">The span of characters to parse.</param>
490+
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
491+
<summary>Parses a span of characters into a value.</summary>
492+
<returns>The result of parsing <paramref name="s" />.</returns>
489493
<remarks>To be added.</remarks>
490494
</Docs>
491495
</Member>

‎xml/System.Runtime.CompilerServices/InlineArrayAttribute.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>Indicates that the instance's storage is sequentially replicated <see cref="P:System.Runtime.CompilerServices.InlineArrayAttribute.Length" /> times.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>

‎xml/System.Runtime.CompilerServices/RefSafetyRulesAttribute.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Indicates the language version of the ref safety rules used when the module was compiled.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -40,8 +40,8 @@
4040
<Parameter Name="version" Type="System.Int32" />
4141
</Parameters>
4242
<Docs>
43-
<param name="version">To be added.</param>
44-
<summary>To be added.</summary>
43+
<param name="version">The language version of the ref safety rules used when the module was compiled.</param>
44+
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.RefSafetyRulesAttribute" /> class.</summary>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>
@@ -61,7 +61,7 @@
6161
<ReturnType>System.Int32</ReturnType>
6262
</ReturnValue>
6363
<Docs>
64-
<summary>To be added.</summary>
64+
<summary>Gets the language version of the ref safety rules used when the module was compiled.</summary>
6565
<value>To be added.</value>
6666
<remarks>To be added.</remarks>
6767
</Docs>

0 commit comments

Comments
 (0)