Skip to content

Commit 3102ab4

Browse files
author
Ron Petrusha
committed
Restored enumeration member remarks dotnet#2
1 parent 5a9256a commit 3102ab4

File tree

8 files changed

+40
-152
lines changed

8 files changed

+40
-152
lines changed

xml/System.Globalization/CultureTypes.xml

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,22 @@
4444
4545
These culture type values are returned by the <xref:System.Globalization.CultureInfo.CultureTypes%2A?displayProperty=nameWithType> property, and also serve as a filter that limits the cultures returned by the <xref:System.Globalization.CultureInfo.GetCultures%2A?displayProperty=nameWithType> method. For more information on cultures, see <xref:System.Globalization.CultureInfo>.
4646
47-
Generally, your application should enumerate all cultures by using the `CultureTypes.AllCultures` value. This allows enumeration of custom cultures as well as the other culture types.
47+
Generally, you enumerate all cultures by using the `CultureTypes.AllCultures` value. This allows enumeration of custom cultures as well as the other culture types.
4848
4949
Note that all `CultureTypes` members have been deprecated except for `CultureTypes.AllCultures`, `CultureTypes.NeutralCultures`, and `CultureTypes.SpecificCultures`.
50+
51+
.NET recognizes the following culture types, all of which are included in enumerations returned by the `CultureTypes.AllTypes` enumeration member:
52+
53+
- **Specific cultures**, which specify a country/region and a language. The names of these cultures follow RFC 4646. The format is \<languagecode2>-\<country/regioncode2>", where \<languagecode2> is a lowercase two-letter code derived from ISO 639-1, and \<country/regioncode2> is an uppercase two-letter code derived from ISO 3166. For example, "en-US" for English (United States) is a specific culture. Custom specific cultures (that is, cultures that are application- rather than system-defined) can have any user-specified name, not just a standards-compliant one.
54+
55+
- **Neutral cultures**, which specify a language without respect to a country/region. The names of neutral cultures consist of the lowercase two-letter code derived from ISO 639-1. For example: "en" (English) is a neutral culture. Custom neutral cultures (that is, cultures that are application- rather than system-defined) can have any user-specified name, not just a two-letter code.
5056
57+
The invariant culture is included in the array of cultures returned by the <xref:System.Globalization.CultureInfo.GetCultures%2A?displayProperty=nameWithType> method that specifies this value.
58+
59+
- Custom cultures.
60+
61+
In Windows versions prior to Windows 10, the `UserCustomCulture` value is assigned to custom cultures created by the developer. In Windows 10, the `UserCustomCulture` value is also assigned to system cultures that are not backed by a complete set of cultural data and that do not have unique local identifiers. (All cultures of type `UserCustomCulture` share a <xref:System.Globalization.CultureInfo.LCID%2A?displayProperty=nameWithType> value of `LOCALE_CUSTOM_UNSPECIFIED` (0x1000, or 4096)). As a result, the `CultureInfo.GetCultures(CultureTypes.UserCustomCulture)` method returns different sets of cultures on different Windows versions.
62+
5163
## Examples
5264
5365
The following example demonstrates the `CultureTypes.AllCultures` enumeration member and the <xref:System.Globalization.CultureInfo.CultureTypes%2A> property.
@@ -201,17 +213,6 @@ On .NET Framework 4 and later versions and .NET Core running on Windows, it incl
201213
<MemberValue>1</MemberValue>
202214
<Docs>
203215
<summary>Cultures that are associated with a language but are not specific to a country/region. </summary>
204-
<remarks>
205-
<format type="text/markdown"><![CDATA[
206-
207-
## Remarks
208-
209-
The names of .NET cultures consist of the lowercase two-letter code derived from ISO 639-1. For example: "en" (English) is a neutral culture. Custom cultures (that is, cultures that are application- rather than system-defined) can have any user-specified name, not just a two-letter code.
210-
211-
The invariant culture is included in the array of cultures returned by the <xref:System.Globalization.CultureInfo.GetCultures%2A?displayProperty=nameWithType> method that specifies this value.
212-
213-
]]></format>
214-
</remarks>
215216
</Docs>
216217
</Member>
217218
<Member MemberName="ReplacementCultures">
@@ -275,17 +276,6 @@ The names of .NET cultures consist of the lowercase two-letter code derived from
275276
<MemberValue>2</MemberValue>
276277
<Docs>
277278
<summary>Cultures that are specific to a country/region. </summary>
278-
<remarks>
279-
<format type="text/markdown"><![CDATA[
280-
281-
## Remarks
282-
283-
The names of these cultures follow RFC 4646 (Windows Vista and later). The format is "&lt;languagecode2&gt;-&lt;country/regioncode2&gt;", where &lt;languagecode2&gt; is a lowercase two-letter code derived from ISO 639-1 and &lt;country/regioncode2&gt; is an uppercase two-letter code derived from ISO 3166. For example, "en-US" for English (United States) is a specific culture.
284-
285-
Custom cultures (that is, cultures that are application- rather than system-defined) can have any user-specified name, not just a standard-compliant one.
286-
287-
]]></format>
288-
</remarks>
289279
</Docs>
290280
</Member>
291281
<Member MemberName="UserCustomCulture">
@@ -317,15 +307,6 @@ Custom cultures (that is, cultures that are application- rather than system-defi
317307
<MemberValue>8</MemberValue>
318308
<Docs>
319309
<summary>**This member is deprecated.** Custom cultures created by the user.</summary>
320-
<remarks>
321-
<format type="text/markdown"><![CDATA[
322-
323-
## Remarks
324-
325-
In Windows versions prior to Windows 10, the `UserCustomCulture` value is assigned to custom cultures created by the developer. In Windows 10, the `UserCustomCulture` value is also assigned to system cultures that are not backed by a complete set of cultural data and that do not have unique local identifiers. (All cultures of type `UserCustomCulture` share a <xref:System.Globalization.CultureInfo.LCID%2A?displayProperty=nameWithType> value of `LOCALE_CUSTOM_UNSPECIFIED` (0x1000, or 4096)). As a result, the `CultureInfo.GetCultures(CultureTypes.UserCustomCulture)` method returns different sets of cultures on different Windows versions.
326-
327-
]]></format>
328-
</remarks>
329310
</Docs>
330311
</Member>
331312
<Member MemberName="WindowsOnlyCultures">

xml/System.Globalization/DateTimeStyles.xml

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,7 @@
108108
</ReturnValue>
109109
<MemberValue>16</MemberValue>
110110
<Docs>
111-
<summary>Date and time are returned as a Coordinated Universal Time (UTC). If the input string denotes a local time, through a time zone specifier or <see cref="F:System.Globalization.DateTimeStyles.AssumeLocal" />, the date and time are converted from the local time to UTC. If the input string denotes a UTC time, through a time zone specifier or <see cref="F:System.Globalization.DateTimeStyles.AssumeUniversal" />, no conversion occurs. If the input string does not denote a local or UTC time, no conversion occurs and the resulting <see cref="P:System.DateTime.Kind" /> property is <see cref="F:System.DateTimeKind.Unspecified" />.</summary>
112-
<remarks>
113-
<format type="text/markdown"><![CDATA[
114-
115-
## Remarks
116-
This value cannot be used with RoundtripKind.
117-
118-
]]></format>
119-
</remarks>
111+
<summary>Date and time are returned as a Coordinated Universal Time (UTC). If the input string denotes a local time, through a time zone specifier or <see cref="F:System.Globalization.DateTimeStyles.AssumeLocal" />, the date and time are converted from the local time to UTC. If the input string denotes a UTC time, through a time zone specifier or <see cref="F:System.Globalization.DateTimeStyles.AssumeUniversal" />, no conversion occurs. If the input string does not denote a local or UTC time, no conversion occurs and the resulting <see cref="P:System.DateTime.Kind" /> property is <see cref="F:System.DateTimeKind.Unspecified" />. This value cannot be used with <see cref="F:System.Globalization.DateTimeStyles.RoundtripKind" />.</summary>
120112
</Docs>
121113
</Member>
122114
<Member MemberName="AllowInnerWhite">
@@ -295,15 +287,7 @@
295287
</ReturnValue>
296288
<MemberValue>32</MemberValue>
297289
<Docs>
298-
<summary>If no time zone is specified in the parsed string, the string is assumed to denote a local time.</summary>
299-
<remarks>
300-
<format type="text/markdown"><![CDATA[
301-
302-
## Remarks
303-
This value cannot be used with AssumeUniversal or RoundtripKind.
304-
305-
]]></format>
306-
</remarks>
290+
<summary>If no time zone is specified in the parsed string, the string is assumed to denote a local time. This value cannot be used with <see cref="F:System.Globalization.DateTimeStyles.AssumeUniversal" /> or <see cref="F:System.Globalization.DateTimeStyles.RoundtripKind" />.</summary>
307291
</Docs>
308292
</Member>
309293
<Member MemberName="AssumeUniversal">
@@ -338,15 +322,7 @@
338322
</ReturnValue>
339323
<MemberValue>64</MemberValue>
340324
<Docs>
341-
<summary>If no time zone is specified in the parsed string, the string is assumed to denote a UTC.</summary>
342-
<remarks>
343-
<format type="text/markdown"><![CDATA[
344-
345-
## Remarks
346-
This value cannot be used with AssumeLocal or RoundtripKind.
347-
348-
]]></format>
349-
</remarks>
325+
<summary>If no time zone is specified in the parsed string, the string is assumed to denote a UTC. This value cannot be used with <see cref="F:System.Globalization.DateTimeStyles.AssumeLocal" /> or <see cref="F:System.Globalization.DateTimeStyles.RoundtripKind" />.</summary>
350326
</Docs>
351327
</Member>
352328
<Member MemberName="NoCurrentDateDefault">

xml/System.IO.Pipes/PipeAccessRights.xml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -413,17 +413,7 @@
413413
</ReturnValue>
414414
<MemberValue>1048576</MemberValue>
415415
<Docs>
416-
<summary>Specifies whether the application can wait for a pipe handle to synchronize with the completion of an I/O operation.</summary>
417-
<remarks>
418-
<format type="text/markdown"><![CDATA[
419-
420-
## Remarks
421-
The Synchronize value is automatically set when allowing access to the pipe and automatically excluded when denying access to the pipe.
422-
423-
The right to create a pipe requires this value. Note that if you do not explicitly set this value when you create a pipe, the value will be set automatically for you.
424-
425-
]]></format>
426-
</remarks>
416+
<summary>Specifies whether the application can wait for a pipe handle to synchronize with the completion of an I/O operation. This value is automatically set when allowing access to the pipe and automatically excluded when denying access to the pipe. The right to create a pipe requires this value. Note that if you do not explicitly set this value when you create a pipe, the value will be set automatically for you.</summary>
427417
</Docs>
428418
</Member>
429419
<Member MemberName="TakeOwnership">

xml/System.IO/FileOptions.xml

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@
4242
<summary>Represents advanced options for creating a <see cref="T:System.IO.FileStream" /> object.</summary>
4343
<remarks>
4444
<format type="text/markdown"><![CDATA[
45+
46+
## Remarks
47+
48+
Specifying the `FileOptions.SequentialScan` flag can increase performance for applications that read large files using sequential access. Performance gains can be even more noticeable for applications that read large files mostly sequentially, but occasionally skip over small ranges of bytes.
4549
4650
## Examples
4751
The following example shows how to use the Asynchronous value when creating a file stream.
@@ -260,15 +264,7 @@
260264
</ReturnValue>
261265
<MemberValue>134217728</MemberValue>
262266
<Docs>
263-
<summary>Indicates that the file is to be accessed sequentially from beginning to end. The system can use this as a hint to optimize file caching. If an application moves the file pointer for random access, optimum caching may not occur; however, correct operation is still guaranteed.</summary>
264-
<remarks>
265-
<format type="text/markdown"><![CDATA[
266-
267-
## Remarks
268-
Specifying this flag can increase performance for applications that read large files using sequential access. Performance gains can be even more noticeable for applications that read large files mostly sequentially, but occasionally skip over small ranges of bytes.
269-
270-
]]></format>
271-
</remarks>
267+
<summary>Indicates that the file is to be accessed sequentially from beginning to end. The system can use this as a hint to optimize file caching. If an application moves the file pointer for random access, optimum caching may not occur; however, correct operation is still guaranteed. Specifying this flag can increase performance in some cases. </summary>
272268
</Docs>
273269
</Member>
274270
<Member MemberName="WriteThrough">

xml/System.Reflection.Metadata/SignatureTypeCode.xml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -638,15 +638,7 @@
638638
</ReturnValue>
639639
<MemberValue>64</MemberValue>
640640
<Docs>
641-
<summary>Precedes a type <see cref="System.Reflection.Metadata.EntityHandle" /> in signatures.</summary>
642-
<remarks>
643-
<format type="text/markdown"><![CDATA[
644-
645-
## Remarks
646-
In raw metadata, this will be encoded as either ELEMENT_TYPE_CLASS (0x12) for reference types and ELEMENT_TYPE_VALUETYPE (0x11) for value types. This is collapsed to a single code because Windows Runtime projections can project from class to value type or vice-versa and the raw code is misleading in those cases.
647-
648-
]]></format>
649-
</remarks>
641+
<summary>Precedes a type <see cref="System.Reflection.Metadata.EntityHandle" /> in signatures. In raw metadata, this is encoded as either ELEMENT_TYPE_CLASS (0x12) for reference types or ELEMENT_TYPE_VALUETYPE (0x11) for value types. This is collapsed to a single code because Windows Runtime projections can project from class to value type or vice-versa, and the raw code is misleading in those cases.</summary>
650642
</Docs>
651643
</Member>
652644
<Member MemberName="UInt16">

xml/System.Reflection/BindingFlags.xml

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
## Remarks
5151
These `BindingFlags` control binding for a great many classes in the `System`, `System.Reflection`, and `System.Runtime` namespaces that invoke, create, get, set, and find members and types.
5252
53-
`BindingFlags` are used in the following <xref:System.Type> methods and other places such as <xref:System.Reflection.MethodBase.Invoke%2A?displayProperty=nameWithType> :
53+
`BindingFlags` are used in the following <xref:System.Type> methods and other places such as <xref:System.Reflection.MethodBase.Invoke%2A?displayProperty=nameWithType>:
5454
5555
- <xref:System.Reflection.MethodBase.Invoke%2A?displayProperty=nameWithType>
5656
@@ -95,7 +95,7 @@
9595
> [!NOTE]
9696
> You must specify `Instance` or `Static` along with `Public` or `NonPublic` or no members will be returned.
9797
98-
The following table lists the coercions performed by the default <xref:System.Reflection.Binder.ChangeType%2A?displayProperty=nameWithType>. This table applies especially to the `ExactBinding` binding flag.
98+
The following table lists the coercions performed by the default <xref:System.Reflection.Binder.ChangeType%2A?displayProperty=nameWithType>. This table applies especially to the `BindingFlags.ExactBinding` binding flag. The general principle is that <xref:System.Reflection.Binder.ChangeType%2A> should perform only widening coercions, which never lose data. An example of a widening coercion is coercing a value that is a 32-bit signed integer to a value that is a 64-bit signed integer. This is distinguished from a narrowing coercion, which may lose data. An example of a narrowing coercion is coercing a 64-bit signed integer to a 32-bit signed integer.
9999
100100
|Source Type|Target Type|
101101
|-----------------|-----------------|
@@ -112,9 +112,14 @@
112112
|`Int64`|`Single`, `Double`|
113113
|`Single`|`Double`|
114114
|Non-reference|By-reference.|
115+
116+
When the `BindingFlags.ExactBinding` binding flag is used, reflection models the accessibility rules of the common type system. For example, if the caller is in the same assembly, the caller does not need special permissions for internal members. Otherwise, the caller needs <xref:System.Security.Permissions.ReflectionPermission>. This is consistent with the lookup of members that are protected, private, and so on.
115117
116118
117119
120+
121+
122+
118123
## Examples
119124
The following example demonstrates many of the binding flags.
120125
@@ -312,19 +317,7 @@
312317
</ReturnValue>
313318
<MemberValue>65536</MemberValue>
314319
<Docs>
315-
<summary>Specifies that types of the supplied arguments must exactly match the types of the corresponding formal parameters. Reflection throws an exception if the caller supplies a non-null <see langword="Binder" /> object, since that implies that the caller is supplying <see langword="BindToXXX" /> implementations that will pick the appropriate method.</summary>
316-
<remarks>
317-
<format type="text/markdown"><![CDATA[
318-
319-
## Remarks
320-
Reflection models the accessibility rules of the common type system. For example, if the caller is in the same assembly, the caller does not need special permissions for internal members. Otherwise, the caller needs <xref:System.Security.Permissions.ReflectionPermission>. This is consistent with lookup of members that are protected, private, and so on.
321-
322-
The general principle is that <xref:System.Reflection.Binder.ChangeType%2A> should perform only widening coercions, which never lose data. An example of a widening coercion is coercing a value that is a 32-bit signed integer to a value that is a 64-bit signed integer. This is distinguished from a narrowing coercion, which may lose data. An example of a narrowing coercion is coercing a 64-bit signed integer to a 32-bit signed integer.
323-
324-
The default binder ignores this flag, while custom binders can implement the semantics of this flag.
325-
326-
]]></format>
327-
</remarks>
320+
<summary>Specifies that types of the supplied arguments must exactly match the types of the corresponding formal parameters. Reflection throws an exception if the caller supplies a non-null <see langword="Binder" /> object, since that implies that the caller is supplying <see langword="BindToXXX" /> implementations that will pick the appropriate method. The default binder ignores this flag, while custom binders can implement the semantics of this flag.</summary>
328321
</Docs>
329322
</Member>
330323
<Member MemberName="FlattenHierarchy">
@@ -679,15 +672,7 @@
679672
</ReturnValue>
680673
<MemberValue>262144</MemberValue>
681674
<Docs>
682-
<summary>Returns the set of members whose parameter count matches the number of supplied arguments. This binding flag is used for methods with parameters that have default values and methods with variable arguments (varargs). This flag should only be used with <see cref="M:System.Type.InvokeMember(System.String,System.Reflection.BindingFlags,System.Reflection.Binder,System.Object,System.Object[],System.Reflection.ParameterModifier[],System.Globalization.CultureInfo,System.String[])" />.</summary>
683-
<remarks>
684-
<format type="text/markdown"><![CDATA[
685-
686-
## Remarks
687-
Parameters with default values are used only in calls where trailing arguments are omitted. They must be the last arguments.
688-
689-
]]></format>
690-
</remarks>
675+
<summary>Returns the set of members whose parameter count matches the number of supplied arguments. This binding flag is used for methods with parameters that have default values and methods with variable arguments (varargs). This flag should only be used with <see cref="M:System.Type.InvokeMember(System.String,System.Reflection.BindingFlags,System.Reflection.Binder,System.Object,System.Object[],System.Reflection.ParameterModifier[],System.Globalization.CultureInfo,System.String[])" />.<br/><br/>Parameters with default values are used only in calls where trailing arguments are omitted. They must be the last arguments.</summary>
691676
</Docs>
692677
</Member>
693678
<Member MemberName="Public">

0 commit comments

Comments
 (0)