Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions xml/System.CodeDom.Compiler/IndentedTextWriter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -490,9 +490,9 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests.</param>
<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>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous flush operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Data.SqlTypes/SqlGuid.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1690,9 +1690,9 @@
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" Index="1" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="info">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
<param name="context">The destination (see <see cref="T:System.Runtime.Serialization.StreamingContext" />) for this serialization.</param>
<summary>Populates a <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with the data needed to serialize the target object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
72 changes: 36 additions & 36 deletions xml/System.Globalization/NumberStyles.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,40 +59,40 @@
<Docs>
<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>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Globalization.NumberStyles> enumeration consists of two kinds of enumeration values that are used to parse the string representations of numeric values:
- Individual field flags, which define specific style elements (such as white space and group separators) that can be present in the parsed string.
- Composite number styles, which consist of multiple field flags that define the style elements that can be present in the parsed string.
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.
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.
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.
||Any|Currency|Float|Integer|Number|HexNumber|
|-|---------|--------------|-----------|-------------|------------|---------------|
|AllowHexSpecifier (0x0200)|0|0|0|0|0|1|
|AllowCurrencySymbol (0x0100)|1|1|0|0|0|0|
|AllowExponent (0x0080)|1|0|1|0|0|0|
|AllowThousands (0x0040)|1|1|0|0|1|0|
|AllowDecimalPoint (0x0020)|1|1|1|0|1|0|
|AllowParentheses (0x0010)|1|1|0|0|0|0|
|AllowTrailingSign (0x0008)|1|1|0|0|1|0|
|AllowLeadingSign (0x0004)|1|1|1|1|1|0|
|AllowTrailingWhite (0x0002)|1|1|1|1|1|1|
|AllowLeadingWhite (0x0001)|1|1|1|1|1|1|
||(0x1ff)|(0x17f)|(0x0a7)|(0x007)|(0x06f)|(0x203)|
## Examples
This example shows how to parse a string into a 32-bit integer by using various `NumberStyles` flags.
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Globalization.NumberStyles> enumeration consists of two kinds of enumeration values that are used to parse the string representations of numeric values:

- Individual field flags, which define specific style elements (such as white space and group separators) that can be present in the parsed string.

- Composite number styles, which consist of multiple field flags that define the style elements that can be present in the parsed string.

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.

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.

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.

||Any|Currency|Float|Integer|Number|HexNumber|
|-|---------|--------------|-----------|-------------|------------|---------------|
|AllowHexSpecifier (0x0200)|0|0|0|0|0|1|
|AllowCurrencySymbol (0x0100)|1|1|0|0|0|0|
|AllowExponent (0x0080)|1|0|1|0|0|0|
|AllowThousands (0x0040)|1|1|0|0|1|0|
|AllowDecimalPoint (0x0020)|1|1|1|0|1|0|
|AllowParentheses (0x0010)|1|1|0|0|0|0|
|AllowTrailingSign (0x0008)|1|1|0|0|1|0|
|AllowLeadingSign (0x0004)|1|1|1|1|1|0|
|AllowTrailingWhite (0x0002)|1|1|1|1|1|1|
|AllowLeadingWhite (0x0001)|1|1|1|1|1|1|
||(0x1ff)|(0x17f)|(0x0a7)|(0x007)|(0x06f)|(0x203)|



## Examples
This example shows how to parse a string into a 32-bit integer by using various `NumberStyles` flags.

:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/NumberStyles/cpp/NumberStyles.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System.Globalization/NumberStyles/Overview/NumberStyles.cs" interactive="try-dotnet" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/NumberStyles/vb/numberstyles.vb" id="Snippet1":::
Expand Down Expand Up @@ -125,7 +125,7 @@
</ReturnValue>
<MemberValue>1024</MemberValue>
<Docs>
<summary>To be added.</summary>
<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>
</Docs>
</Member>
<Member MemberName="AllowCurrencySymbol">
Expand Down Expand Up @@ -613,7 +613,7 @@
</ReturnValue>
<MemberValue>1027</MemberValue>
<Docs>
<summary>To be added.</summary>
<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>
</Docs>
</Member>
<Member MemberName="Currency">
Expand Down
41 changes: 23 additions & 18 deletions xml/System.Net/IPAddress.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2177,10 +2177,14 @@
<Parameter Name="formatProvider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<param name="formatProvider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="format">The format to use.
-or-
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>
<param name="formatProvider">The provider to use to format the value.
-or-
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>
<summary>Formats the value of the current instance using the specified format.</summary>
<returns>The value of the current instance in the specified format.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -2216,10 +2220,10 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<summary>Parses a string into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -2309,12 +2313,13 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="3" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">The span in which to write this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, contains the number of characters that were written in <paramref name="destination" />.</param>
<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>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current instance into the provided span of characters.</summary>
<returns>
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -2350,10 +2355,10 @@
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-8.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The span of characters to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<summary>Parses a span of characters into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
44 changes: 24 additions & 20 deletions xml/System.Net/IPNetwork.xml
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,10 @@
<Parameter Name="other" Type="System.Net.IPNetwork" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="other">An object to compare with this object.</param>
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -345,10 +346,12 @@
<Parameter Name="provider" Type="System.IFormatProvider" />
</Parameters>
<Docs>
<param name="format">To be added.</param>
<param name="format">The format to use.
-or-
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>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Formats the value of the current instance using the specified format.</summary>
<returns>The value of the current instance in the specified format.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -382,10 +385,10 @@
<Parameter Name="provider" Type="System.IFormatProvider" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The string to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<summary>Parses a string into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -450,12 +453,13 @@
<Parameter Name="provider" Type="System.IFormatProvider" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<param name="charsWritten">To be added.</param>
<param name="format">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="destination">The span in which to write this instance's value formatted as a span of characters.</param>
<param name="charsWritten">When this method returns, contains the number of characters that were written in <paramref name="destination" />.</param>
<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>
<param name="provider">An optional object that supplies culture-specific formatting information for <paramref name="destination" />.</param>
<summary>Tries to format the value of the current instance into the provided span of characters.</summary>
<returns>
<see langword="true" /> if the formatting was successful; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -482,10 +486,10 @@
<Parameter Name="provider" Type="System.IFormatProvider" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="provider">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="s">The span of characters to parse.</param>
<param name="provider">An object that provides culture-specific formatting information about <paramref name="s" />.</param>
<summary>Parses a span of characters into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Indicates that the instance's storage is sequentially replicated <see cref="P:System.Runtime.CompilerServices.InlineArrayAttribute.Length" /> times.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Indicates the language version of the ref safety rules used when the module was compiled.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -40,8 +40,8 @@
<Parameter Name="version" Type="System.Int32" />
</Parameters>
<Docs>
<param name="version">To be added.</param>
<summary>To be added.</summary>
<param name="version">The language version of the ref safety rules used when the module was compiled.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.RefSafetyRulesAttribute" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -61,7 +61,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the language version of the ref safety rules used when the module was compiled.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading