Skip to content

Commit 48a8c40

Browse files
tarekghmairaw
authored andcommitted
Add missing System.Text docs (#3236)
* Add missing System.Text docs * Update xml/System.Text/CodePagesEncodingProvider.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/CodePagesEncodingProvider.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Decoder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/StringBuilder.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Text/Encoding.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * fix build issue * Update Encoder.xml * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]> * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]> * move remarks to more central place * Update Decoder.xml * move remarks to central location * fix typo + edit
1 parent 537e5ad commit 48a8c40

File tree

5 files changed

+3757
-3455
lines changed

5 files changed

+3757
-3455
lines changed

xml/System.Text/CodePagesEncodingProvider.xml

Lines changed: 117 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -27,44 +27,89 @@
2727
<Docs>
2828
<summary>Provides access to an encoding provider for code pages that otherwise are available only in the desktop .NET Framework.</summary>
2929
<remarks>
30-
<format type="text/markdown"><![CDATA[
31-
32-
## Remarks
33-
34-
The .NET Framework for the Windows desktop supports a large set of Unicode and code page encodings. .NET Core, on the other hand, supports only the following encodings:
35-
36-
- ASCII (code page 20127), which is returned by the <xref:System.Text.Encoding.ASCII%2A?displayProperty=nameWithType> property.
37-
38-
- ISO-8859-1 (code page 28591).
39-
40-
- UTF-7 (code page 65000), which is returned by the <xref:System.Text.Encoding.UTF7%2A?displayProperty=nameWithType> property.
41-
42-
- UTF-8 (code page 65001), which is returned by the <xref:System.Text.Encoding.UTF8%2A?displayProperty=nameWithType> property.
43-
44-
- UTF-16 and UTF-16LE (code page 1200), which is returned by the <xref:System.Text.Encoding.Unicode%2A?displayProperty=nameWithType> property.
45-
46-
- UTF-16BE (code page 1201), which is instantiated by calling the <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> or <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> constructor with a `bigEndian` value of `true`.
47-
48-
- UTF-32 and UTF-32LE (code page 12000), which is returned by the <xref:System.Text.Encoding.UTF32%2A?displayProperty=nameWithType> property.
49-
50-
- UTF-32BE (code page 12001), which is instantiated by calling an <xref:System.Text.UTF32Encoding> constructor that has a `bigEndian` parameter and providing a value of `true` in the method call.
51-
52-
Other than code page 20127, code page encodings are not supported.
53-
54-
The <xref:System.Text.CodePagesEncodingProvider> class extends <xref:System.Text.EncodingProvider> to make these code pages available to .NET Core. To use these additional code pages, you do the following:
55-
56-
- Add a reference to the System.Text.Encoding.CodePages.dll assembly to your project.
57-
58-
- Retrieve a <xref:System.Text.CodePagesEncodingProvider> object from the static <xref:System.Text.CodePagesEncodingProvider.Instance%2A?displayProperty=nameWithType> property.
59-
60-
- Pass the <xref:System.Text.CodePagesEncodingProvider> object to the <xref:System.Text.Encoding.RegisterProvider%2A?displayProperty=nameWithType> method.
61-
62-
After an <xref:System.Text.EncodingProvider> object is registered, the encodings that it supports are available by calling the overloads of <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType>; you should not call the <xref:System.Text.EncodingProvider.GetEncoding%2A?displayProperty=nameWithType> overloads.
63-
30+
<format type="text/markdown"><![CDATA[
31+
32+
## Remarks
33+
34+
The .NET Framework for the Windows desktop supports a large set of Unicode and code page encodings. .NET Core, on the other hand, supports only the following encodings:
35+
36+
- ASCII (code page 20127), which is returned by the <xref:System.Text.Encoding.ASCII%2A?displayProperty=nameWithType> property.
37+
38+
- ISO-8859-1 (code page 28591).
39+
40+
- UTF-7 (code page 65000), which is returned by the <xref:System.Text.Encoding.UTF7%2A?displayProperty=nameWithType> property.
41+
42+
- UTF-8 (code page 65001), which is returned by the <xref:System.Text.Encoding.UTF8%2A?displayProperty=nameWithType> property.
43+
44+
- UTF-16 and UTF-16LE (code page 1200), which is returned by the <xref:System.Text.Encoding.Unicode%2A?displayProperty=nameWithType> property.
45+
46+
- UTF-16BE (code page 1201), which is instantiated by calling the <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> or <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> constructor with a `bigEndian` value of `true`.
47+
48+
- UTF-32 and UTF-32LE (code page 12000), which is returned by the <xref:System.Text.Encoding.UTF32%2A?displayProperty=nameWithType> property.
49+
50+
- UTF-32BE (code page 12001), which is instantiated by calling an <xref:System.Text.UTF32Encoding> constructor that has a `bigEndian` parameter and providing a value of `true` in the method call.
51+
52+
Other than code page 20127, code page encodings are not supported.
53+
54+
The <xref:System.Text.CodePagesEncodingProvider> class extends <xref:System.Text.EncodingProvider> to make these code pages available to .NET Core. To use these additional code pages, you do the following:
55+
56+
- Add a reference to the System.Text.Encoding.CodePages.dll assembly to your project.
57+
58+
- Retrieve a <xref:System.Text.CodePagesEncodingProvider> object from the static <xref:System.Text.CodePagesEncodingProvider.Instance%2A?displayProperty=nameWithType> property.
59+
60+
- Pass the <xref:System.Text.CodePagesEncodingProvider> object to the <xref:System.Text.Encoding.RegisterProvider%2A?displayProperty=nameWithType> method.
61+
62+
After an <xref:System.Text.EncodingProvider> object is registered, the encodings that it supports are available by calling the overloads of <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType>; you should not call the <xref:System.Text.EncodingProvider.GetEncoding%2A?displayProperty=nameWithType> overloads.
63+
6464
]]></format>
6565
</remarks>
6666
</Docs>
6767
<Members>
68+
<MemberGroup MemberName="GetEncoding">
69+
<AssemblyInfo>
70+
<AssemblyName>System.Text.Encoding.CodePages</AssemblyName>
71+
<AssemblyVersion>4.1.1.0</AssemblyVersion>
72+
<AssemblyVersion>4.1.2.0</AssemblyVersion>
73+
</AssemblyInfo>
74+
<Docs>
75+
<summary>To be added.</summary>
76+
<remarks>
77+
<format type="text/markdown"><![CDATA[
78+
79+
## Remarks
80+
81+
The .NET Framework supports a large number of character encodings and code pages. You can get a complete list of encodings by calling the <xref:System.Text.Encoding.GetEncodings%2A?displayProperty=nameWithType> method, which is available in the .NET Framework. On the other hand, .NET Core only supports the following encodings by default:
82+
83+
- ASCII (code page 20127), which is returned by the <xref:System.Text.Encoding.ASCII%2A?displayProperty=nameWithType> property.
84+
85+
- ISO-8859-1 (code page 28591).
86+
87+
- UTF-7 (code page 65000), which is returned by the <xref:System.Text.Encoding.UTF7%2A?displayProperty=nameWithType> property.
88+
89+
- UTF-8 (code page 65001), which is returned by the <xref:System.Text.Encoding.UTF8%2A?displayProperty=nameWithType> property.
90+
91+
- UTF-16 and UTF-16LE (code page 1200), which is returned by the <xref:System.Text.Encoding.Unicode%2A?displayProperty=nameWithType> property.
92+
93+
- UTF-16BE (code page 1201), which is instantiated by calling the <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> or <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> constructor with a `bigEndian` value of `true`.
94+
95+
- UTF-32 and UTF-32LE (code page 12000), which is returned by the <xref:System.Text.Encoding.UTF32%2A?displayProperty=nameWithType> property.
96+
97+
- UTF-32BE (code page 12001), which is instantiated by calling an <xref:System.Text.UTF32Encoding> constructor that has a `bigEndian` parameter and providing a value of `true` in the method call.
98+
99+
To retrieve an encoding that is present in .NET Framework but not in .NET Core, you do the following:
100+
101+
- Add a reference to the *System.Text.Encoding.CodePages.dll* assembly to your project.
102+
103+
- Get the <xref:System.Text.EncodingProvider> object from the static <xref:System.Text.CodePagesEncodingProvider.Instance%2A?displayProperty=nameWithType> property.
104+
105+
- Pass the <xref:System.Text.EncodingProvider> object to the <xref:System.Text.Encoding.RegisterProvider%2A?displayProperty=nameWithType> method to make the encodings supplied by the <xref:System.Text.EncodingProvider> object available to the common language runtime.
106+
107+
- Call an <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType> overload to retrieve the encoding. The <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType> method will call the corresponding <xref:System.Text.EncodingProvider.GetEncoding%2A?displayProperty=nameWithType> method to determine whether it can supply the requested encoding.
108+
109+
]]></format>
110+
</remarks>
111+
</Docs>
112+
</MemberGroup>
68113
<Member MemberName="GetEncoding">
69114
<MemberSignature Language="C#" Value="public override System.Text.Encoding GetEncoding (int codepage);" />
70115
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Text.Encoding GetEncoding(int32 codepage) cil managed" />
@@ -85,9 +130,9 @@
85130
<Parameter Name="codepage" Type="System.Int32" Index="0" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;netcore-3.0" />
86131
</Parameters>
87132
<Docs>
88-
<param name="codepage">To be added.</param>
89-
<summary>To be added.</summary>
90-
<returns>To be added.</returns>
133+
<param name="codepage">The code page identifier of the preferred encoding which the encoding provider may support.</param>
134+
<summary>Returns the encoding associated with the specified code page identifier.</summary>
135+
<returns>The encoding associated with the specified code page identifier, or <see langword="null" /> if the provider does not support the requested codepage encoding.</returns>
91136
<remarks>To be added.</remarks>
92137
</Docs>
93138
</Member>
@@ -111,10 +156,9 @@
111156
<Parameter Name="name" Type="System.String" Index="0" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;netcore-3.0" />
112157
</Parameters>
113158
<Docs>
114-
<param name="name">To be added.</param>
115-
<summary>To be added.</summary>
116-
<returns>To be added.</returns>
117-
<remarks>To be added.</remarks>
159+
<param name="name">The code page name of the preferred encoding which the encoding provider may support.</param>
160+
<summary>Returns the encoding associated with the specified code page name.</summary>
161+
<returns>The encoding associated with the specified code page, or <see langword="null" /> if the provider does not support the requested encoding.</returns>
118162
</Docs>
119163
</Member>
120164
<Member MemberName="Instance">
@@ -141,38 +185,38 @@
141185
<summary>Gets an encoding provider for code pages supported in the desktop .NET Framework but not in the current .NET Framework platform.</summary>
142186
<value>An encoding provider that allows access to encodings not supported on the current .NET Framework platform.</value>
143187
<remarks>
144-
<format type="text/markdown"><![CDATA[
145-
146-
## Remarks
147-
148-
The .NET Framework on the Windows desktop supports a large number of character encodings and code pages. You can get a complete list of encodings by calling the <xref:System.Text.Encoding.GetEncodings%2A?displayProperty=nameWithType> method, which is available in the full .NET Framework on the Windows desktop. .NET Core, on the other hand, supports only the following encodings by default:
149-
150-
- ASCII (code page 20127), which is returned by the <xref:System.Text.Encoding.ASCII%2A?displayProperty=nameWithType> property.
151-
152-
- ISO-8859-1 (code page 28591).
153-
154-
- UTF-7 (code page 65000), which is returned by the <xref:System.Text.Encoding.UTF7%2A?displayProperty=nameWithType> property.
155-
156-
- UTF-8 (code page 65001), which is returned by the <xref:System.Text.Encoding.UTF8%2A?displayProperty=nameWithType> property.
157-
158-
- UTF-16 and UTF-16LE (code page 1200), which is returned by the <xref:System.Text.Encoding.Unicode%2A?displayProperty=nameWithType> property.
159-
160-
- UTF-16BE (code page 1201), which is instantiated by calling the <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> or <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> constructor with a `bigEndian` value of `true`.
161-
162-
- UTF-32 and UTF-32LE (code page 12000), which is returned by the <xref:System.Text.Encoding.UTF32%2A?displayProperty=nameWithType> property.
163-
164-
- UTF-32BE (code page 12001), which is instantiated by calling an <xref:System.Text.UTF32Encoding> constructor that has a `bigEndian` parameter and providing a value of `true` in the method call.
165-
166-
To retrieve an encoding that is present in the .NET Framework on the Windows desktop but not in .NET Core, you do the following:
167-
168-
- Add a reference to the System.Text.Encoding.CodePages.dll assembly to your project.
169-
170-
- Get the <xref:System.Text.EncodingProvider> object from the static <xref:System.Text.CodePagesEncodingProvider.Instance%2A?displayProperty=nameWithType> property.
171-
172-
- Pass the <xref:System.Text.EncodingProvider> object to the <xref:System.Text.Encoding.RegisterProvider%2A?displayProperty=nameWithType> method to make the encodings supplied by the <xref:System.Text.EncodingProvider> object available to the common language runtime.
173-
174-
- Call an <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType> overload to retrieve the encoding. The <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType> method will call the corresponding <xref:System.Text.EncodingProvider.GetEncoding%2A?displayProperty=nameWithType> method to determine whether it can supply the requested encoding.
175-
188+
<format type="text/markdown"><![CDATA[
189+
190+
## Remarks
191+
192+
The .NET Framework supports a large number of character encodings and code pages. You can get a complete list of encodings by calling the <xref:System.Text.Encoding.GetEncodings%2A?displayProperty=nameWithType> method, which is available in the .NET Framework. On the other hand, .NET Core only supports the following encodings by default:
193+
194+
- ASCII (code page 20127), which is returned by the <xref:System.Text.Encoding.ASCII%2A?displayProperty=nameWithType> property.
195+
196+
- ISO-8859-1 (code page 28591).
197+
198+
- UTF-7 (code page 65000), which is returned by the <xref:System.Text.Encoding.UTF7%2A?displayProperty=nameWithType> property.
199+
200+
- UTF-8 (code page 65001), which is returned by the <xref:System.Text.Encoding.UTF8%2A?displayProperty=nameWithType> property.
201+
202+
- UTF-16 and UTF-16LE (code page 1200), which is returned by the <xref:System.Text.Encoding.Unicode%2A?displayProperty=nameWithType> property.
203+
204+
- UTF-16BE (code page 1201), which is instantiated by calling the <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> or <xref:System.Text.UnicodeEncoding.%23ctor%2A?displayProperty=nameWithType> constructor with a `bigEndian` value of `true`.
205+
206+
- UTF-32 and UTF-32LE (code page 12000), which is returned by the <xref:System.Text.Encoding.UTF32%2A?displayProperty=nameWithType> property.
207+
208+
- UTF-32BE (code page 12001), which is instantiated by calling an <xref:System.Text.UTF32Encoding> constructor that has a `bigEndian` parameter and providing a value of `true` in the method call.
209+
210+
To retrieve an encoding that is present in the .NET Framework on the Windows desktop but not in .NET Core, you do the following:
211+
212+
- Add a reference to the System.Text.Encoding.CodePages.dll assembly to your project.
213+
214+
- Get the <xref:System.Text.EncodingProvider> object from the static <xref:System.Text.CodePagesEncodingProvider.Instance%2A?displayProperty=nameWithType> property.
215+
216+
- Pass the <xref:System.Text.EncodingProvider> object to the <xref:System.Text.Encoding.RegisterProvider%2A?displayProperty=nameWithType> method to make the encodings supplied by the <xref:System.Text.EncodingProvider> object available to the common language runtime.
217+
218+
- Call an <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType> overload to retrieve the encoding. The <xref:System.Text.Encoding.GetEncoding%2A?displayProperty=nameWithType> method will call the corresponding <xref:System.Text.EncodingProvider.GetEncoding%2A?displayProperty=nameWithType> method to determine whether it can supply the requested encoding.
219+
176220
]]></format>
177221
</remarks>
178222
</Docs>

0 commit comments

Comments
 (0)