Skip to content

Commit 75d0922

Browse files
gewarrengewarren
authored
Fix format tag warnings (#11235)
1 parent baf544a commit 75d0922

File tree

5 files changed

+78
-33
lines changed

5 files changed

+78
-33
lines changed

‎xml/System.Globalization/CompareInfo.xml

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,23 @@
8686
</Attributes>
8787
<Docs>
8888
<summary>Implements a set of methods for culture-sensitive string comparisons.</summary>
89-
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-globalization-compareinfo">Supplemental API remarks for CompareInfo</see>.</remarks>
90-
<example>
91-
The following example shows how the <see cref="T:System.Globalization.CompareInfo" /> object associated with a <see cref="T:System.Globalization.CultureInfo" /> object affects string comparison.
89+
<remarks>
9290
<format type="text/markdown"><![CDATA[
93-
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompareInfo/cpp/CompareInfo.cpp" id="Snippet1":::
94-
:::code language="csharp" source="~/snippets/csharp/System.Globalization/CompareInfo/Overview/CompareInfo.cs" id="Snippet1":::
95-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompareInfo/VB/CompareInfo.vb" id="Snippet1":::
96-
]]></format></example>
91+
92+
## Remarks
93+
94+
For more information about this API, see [Supplemental API remarks for CompareInfo](/dotnet/fundamentals/runtime-libraries/system-globalization-compareinfo).
95+
96+
## Example
97+
98+
The following example shows how the <xref:System.Globalization.CompareInfo> object associated with a <xref:System.Globalization.CultureInfo> object affects string comparison.
99+
100+
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/CompareInfo/cpp/CompareInfo.cpp" id="Snippet1":::
101+
:::code language="csharp" source="~/snippets/csharp/System.Globalization/CompareInfo/Overview/CompareInfo.cs" id="Snippet1":::
102+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/CompareInfo/VB/CompareInfo.vb" id="Snippet1":::
103+
104+
]]></format>
105+
</remarks>
97106
<related type="ExternalDocumentation" href="https://www.microsoft.com/download/details.aspx?id=10921">Sorting Weight Tables for Windows operating systems</related>
98107
<related type="ExternalDocumentation" href="https://www.unicode.org/Public/UCA/latest/allkeys.txt">Default Unicode Collation Element Table, for Linux and macOS</related>
99108
</Docs>

‎xml/System.Globalization/CultureAndRegionInfoBuilder.xml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,22 @@
2222
</Attributes>
2323
<Docs>
2424
<summary>Defines a custom culture that is new or based on another culture and country/region. The custom culture can be installed on a computer and subsequently used by any application that is running on that computer. This class cannot be inherited.</summary>
25-
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-globalization-cultureandregioninfobuilder">Supplemental API remarks for CultureAndRegionInfoBuilder</see>.</remarks>
26-
<example>
27-
The following example defines a custom ru-US culture that represents the Russian language in the United States. The example defines the custom culture by loading settings from the Russian (Russia) <see cref="T:System.Globalization.CultureInfo" /> object and the U.S. <see cref="T:System.Globalization.RegionInfo" /> object, and then sets a number of <see cref="T:System.Globalization.CultureAndRegionInfoBuilder" /> properties. The example registers the custom culture, and then instantiates it and makes it the current culture.
25+
<remarks>
2826
<format type="text/markdown"><![CDATA[
29-
:::code language="csharp" source="~/snippets/csharp/System.Globalization/CultureAndRegionInfoBuilder/Overview/car.cs" id="Snippet1":::
30-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.cultureandregioninfobuilder.class/vb/car.vb" id="Snippet1":::
31-
]]></format></example>
27+
28+
## Remarks
29+
30+
For more information about this API, see [Supplemental API remarks for CultureAndRegionInfoBuilder](/dotnet/fundamentals/runtime-libraries/system-globalization-cultureandregioninfobuilder).
31+
32+
## Example
33+
34+
The following example defines a custom ru-US culture that represents the Russian language in the United States. The example defines the custom culture by loading settings from the Russian (Russia) <xref:System.Globalization.CultureInfo> object and the U.S. <xref:System.Globalization.RegionInfo> object, and then sets a number of <xref:System.Globalization.CultureAndRegionInfoBuilder> properties. The example registers the custom culture, and then instantiates it and makes it the current culture.
35+
36+
:::code language="csharp" source="~/snippets/csharp/System.Globalization/CultureAndRegionInfoBuilder/Overview/car.cs" id="Snippet1":::
37+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.cultureandregioninfobuilder.class/vb/car.vb" id="Snippet1":::
38+
39+
]]></format>
40+
</remarks>
3241
</Docs>
3342
<Members>
3443
<Member MemberName=".ctor">

‎xml/System.Globalization/CultureInfo.xml

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,23 @@
8686
</Attributes>
8787
<Docs>
8888
<summary>Provides information about a specific culture (called a *locale* for unmanaged code development). The information includes the names for the culture, the writing system, the calendar used, the sort order of strings, and formatting for dates and numbers.</summary>
89-
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-globalization-cultureinfo">Supplemental API remarks for CultureInfo</see>.</remarks>
90-
<example>
91-
The following example shows how to create a <see cref="T:System.Globalization.CultureInfo" /> object for Spanish (Spain) with the international sort and another <see cref="T:System.Globalization.CultureInfo" /> object with the traditional sort.
89+
<remarks>
9290
<format type="text/markdown"><![CDATA[
93-
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Globalization.CultureInfo_esES/CPP/spanishspain.cpp" id="Snippet1":::
94-
:::code language="csharp" source="~/snippets/csharp/System.Globalization/CultureInfo/Overview/spanishspain.cs" id="Snippet1":::
95-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Globalization.CultureInfo_esES/VB/spanishspain.vb" id="Snippet1":::
96-
]]></format></example>
91+
92+
## Remarks
93+
94+
For more information about this API, see [Supplemental API remarks for CultureInfo](/dotnet/fundamentals/runtime-libraries/system-globalization-cultureinfo).
95+
96+
## Example
97+
98+
The following example shows how to create a <xref:System.Globalization.CultureInfo> object for Spanish (Spain) with the international sort and another <xref:System.Globalization.CultureInfo> object with the traditional sort.
99+
100+
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Globalization.CultureInfo_esES/CPP/spanishspain.cpp" id="Snippet1":::
101+
:::code language="csharp" source="~/snippets/csharp/System.Globalization/CultureInfo/Overview/spanishspain.cs" id="Snippet1":::
102+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Globalization.CultureInfo_esES/VB/spanishspain.vb" id="Snippet1":::
103+
104+
]]></format>
105+
</remarks>
97106
<altmember cref="T:System.Globalization.CultureAndRegionInfoBuilder" />
98107
<altmember cref="T:System.Globalization.RegionInfo" />
99108
</Docs>

‎xml/System.Globalization/RegionInfo.xml

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,23 @@
7373
</Attributes>
7474
<Docs>
7575
<summary>Contains information about the country/region.</summary>
76-
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-globalization-regioninfo">Supplemental API remarks for RegionInfo</see>.</remarks>
77-
<example>
78-
The following example demonstrates several members of the <see cref="T:System.Globalization.RegionInfo" /> class.
76+
<remarks>
7977
<format type="text/markdown"><![CDATA[
80-
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Globalization.RegionInfo/CPP/regioninfo.cpp" id="Snippet1":::
81-
:::code language="csharp" source="~/snippets/csharp/System.Globalization/RegionInfo/Overview/regioninfo.cs" interactive="try-dotnet" id="Snippet1":::
82-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Globalization.RegionInfo/VB/regioninfo.vb" id="Snippet1":::
83-
]]></format></example>
78+
79+
## Remarks
80+
81+
For more information about this API, see [Supplemental API remarks for RegionInfo](/dotnet/fundamentals/runtime-libraries/system-globalization-regioninfo).
82+
83+
## Example
84+
85+
The following example demonstrates several members of the <xref:System.Globalization.RegionInfo> class.
86+
87+
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Globalization.RegionInfo/CPP/regioninfo.cpp" id="Snippet1":::
88+
:::code language="csharp" source="~/snippets/csharp/System.Globalization/RegionInfo/Overview/regioninfo.cs" interactive="try-dotnet" id="Snippet1":::
89+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Globalization.RegionInfo/VB/regioninfo.vb" id="Snippet1":::
90+
91+
]]></format>
92+
</remarks>
8493
<altmember cref="T:System.Globalization.CultureInfo" />
8594
</Docs>
8695
<Members>

‎xml/System.Globalization/SortVersion.xml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,22 @@
5656
</Attributes>
5757
<Docs>
5858
<summary>Provides information about the version of Unicode used to compare and order strings.</summary>
59-
<remarks>For more information about this API, see <see href="/dotnet/fundamentals/runtime-libraries/system-globalization-sortversion">Supplemental API remarks for SortVersion</see>.</remarks>
60-
<example>
61-
The following example contains a portion of the source code from an application that uses the <see cref="T:System.Globalization.SortVersion" /> class to ensure that the native names of <see cref="T:System.Globalization.RegionInfo" /> objects are ordered appropriately for the current system and current culture. It uses the <see cref="T:System.IO.BinaryReader" /> and <see cref="T:System.IO.BinaryWriter" /> objects to store and retrieve ordered data from a data file named `Regions.dat` rather than retrieving and ordering data each time the application is run. The example first checks to determine whether the data file exists. If it does not, it creates the data and sets the `reindex` flag, which indicates that the data must be resorted and saved again. Otherwise, it retrieves the data and compares the saved <see cref="T:System.Globalization.SortVersion" /> object with the <see cref="T:System.Globalization.SortVersion" /> object for the current culture on the current system. If they are not equal, or if the `reindex` flag had been set previously, it resorts to the <see cref="T:System.Globalization.RegionInfo" /> data.
59+
<remarks>
6260
<format type="text/markdown"><![CDATA[
63-
:::code language="csharp" source="~/snippets/csharp/System.Globalization/SortVersion/Overview/example1.cs" id="Snippet1":::
64-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.sortversion/vb/example1.vb" id="Snippet1":::
65-
]]></format></example>
61+
62+
## Remarks
63+
64+
For more information about this API, see [Supplemental API remarks for SortVersion](/dotnet/fundamentals/runtime-libraries/system-globalization-sortversion).
65+
66+
## Example
67+
68+
The following example contains a portion of the source code from an application that uses the <xref:System.Globalization.SortVersion> class to ensure that the native names of <xref:System.Globalization.RegionInfo> objects are ordered appropriately for the current system and current culture. It uses the <xref:System.IO.BinaryReader> and <xref:System.IO.BinaryWriter> objects to store and retrieve ordered data from a data file named `Regions.dat` rather than retrieving and ordering data each time the application is run. The example first checks to determine whether the data file exists. If it does not, it creates the data and sets the `reindex` flag, which indicates that the data must be resorted and saved again. Otherwise, it retrieves the data and compares the saved <xref:System.Globalization.SortVersion> object with the <xref:System.Globalization.SortVersion> object for the current culture on the current system. If they aren't equal, or if the `reindex` flag had been set previously, it resorts to the <xref:System.Globalization.RegionInfo> data.
69+
70+
:::code language="csharp" source="~/snippets/csharp/System.Globalization/SortVersion/Overview/example1.cs" id="Snippet1":::
71+
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.globalization.sortversion/vb/example1.vb" id="Snippet1":::
72+
73+
]]></format>
74+
</remarks>
6675
<altmember cref="P:System.Globalization.CompareInfo.Version" />
6776
</Docs>
6877
<Members>

0 commit comments

Comments
 (0)