Skip to content

Commit ac3b9ec

Browse files
author
Ron Petrusha
authored
Removed more enumeration member remarks (#2484)
* Removed more enumeration member remarks * Additional corrections
1 parent bf5a87c commit ac3b9ec

File tree

6 files changed

+30
-164
lines changed

6 files changed

+30
-164
lines changed

‎xml/System.Runtime.Serialization.Formatters/FormatterTypeStyle.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,15 @@
3535
</Attributes>
3636
<Docs>
3737
<summary>Indicates the format in which type descriptions are laid out in the serialized stream.</summary>
38-
<remarks>To be added.</remarks>
38+
<remarks>
39+
<format type="text/markdown"><![CDATA[
40+
41+
## Remarks
42+
43+
The `XsdString` and `TypesWhenNeeded` settings are meant for high performance serialization between services built on the same version of a particular.NET implementation. These two values do not support [VTS (Version Tolerant Serialization)](~/docs/standard/serialization/version-tolerant-serialization.md) because they intentionally omit type information that VTS uses to skip or add optional fields and properties. You should not use the `XsdString` or `TypesWhenNeeded` type formats when serializing and deserializing types on a computer running a different version of the .NET implementation than the computer on which the type was serialized. Serializing and deserializing on computers running different versions of a .NET implementation causes the formatter to skip serialization of type information, thus making it impossible for the deserializer to skip optional fields if they are not present in certain types that may exist in the other version of the .NET implementation. If you must use `XsdString` or `TypesWhenNeeded` in such a scenario, you must provide custom serialization for types that have changed from one version to the other.
44+
45+
]]></format>
46+
</remarks>
3947
</Docs>
4048
<Members>
4149
<Member MemberName="TypesAlways">
@@ -135,14 +143,6 @@
135143
<MemberValue>2</MemberValue>
136144
<Docs>
137145
<summary>Indicates that strings can be given in the XSD format rather than SOAP. No string IDs are transmitted.</summary>
138-
<remarks>
139-
<format type="text/markdown"><![CDATA[
140-
141-
## Remarks
142-
The `XsdString` and `TypesWhenNeeded` settings are meant for high performance serialization between services built on the same version of the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)]. These two values do not support VTS (Version Tolerant Serialization) because they intentionally omit type information that VTS uses to skip or add optional fields and properties. You should not use the `XsdString` or `TypesWhenNeeded` type formats when serializing and deserializing types on a computer running a different version of the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)] than the computer on which the type was serialized. Serializing and deserializing on computers running different versions of the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)] causes the formatter to skip serialization of type information, thus making it impossible for the deserializer to skip optional fields if they are not present in certain types that may exist in the other version of the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)]. If you must use `XsdString` or `TypesWhenNeeded` in such a scenario, you must provide custom serialization for types that have changed from one version of the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)] to the other.
143-
144-
]]></format>
145-
</remarks>
146146
</Docs>
147147
</Member>
148148
</Members>

‎xml/System.Windows.Automation/ToggleState.xml

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<format type="text/markdown"><![CDATA[
2828
2929
## Remarks
30-
A control must cycle through its <xref:System.Windows.Automation.ToggleState> in this order: On, Off and if supported, Indeterminate.
30+
A control must cycle through its <xref:System.Windows.Automation.Provider.IToggleProvider.ToggleState?displayProperty=nameWithType> in this order: On, Off, and, if supported, Indeterminate.
3131
3232
]]></format>
3333
</remarks>
@@ -51,17 +51,7 @@
5151
</ReturnValue>
5252
<MemberValue>2</MemberValue>
5353
<Docs>
54-
<summary>The UI Automation element is in an indeterminate state.</summary>
55-
<remarks>
56-
<format type="text/markdown"><![CDATA[
57-
58-
## Remarks
59-
The Indeterminate property can be used to indicate whether the user has acted on a control. For example, a check box can appear checked and dimmed, indicating an indeterminate state.
60-
61-
Creating an indeterminate state is different from disabling the control. Consequently, a check box in the indeterminate state can still receive the focus. When the user clicks an indeterminate control the <xref:System.Windows.Automation.ToggleState.Indeterminate> cycles to its next value.
62-
63-
]]></format>
64-
</remarks>
54+
<summary>The UI Automation element is in an indeterminate state. <csee langword="Indeterminate" /> can be used to indicate whether the user has acted on a control. For example, a check box can appear checked and dimmed, indicating an indeterminate state. Creating an indeterminate state is different from disabling the control. Consequently, a check box in the indeterminate state can still receive the focus. When the user clicks an indeterminate control, the <see cref="P:System.Windows.Automation.Provider.IToggleProvider.ToggleState" /> cycles to its next value.</summary>
6555
</Docs>
6656
</Member>
6757
<Member MemberName="Off">
@@ -82,7 +72,7 @@
8272
</ReturnValue>
8373
<MemberValue>0</MemberValue>
8474
<Docs>
85-
<summary>The UI Automation element is not selected, checked, marked or otherwise activated.</summary>
75+
<summary>The UI Automation element is not selected, checked, marked, or otherwise activated.</summary>
8676
</Docs>
8777
</Member>
8878
<Member MemberName="On">
@@ -103,7 +93,7 @@
10393
</ReturnValue>
10494
<MemberValue>1</MemberValue>
10595
<Docs>
106-
<summary>The UI Automation element is selected, checked, marked or otherwise activated.</summary>
96+
<summary>The UI Automation element is selected, checked, marked, or otherwise activated.</summary>
10797
</Docs>
10898
</Member>
10999
</Members>

‎xml/System.Windows.Forms/MouseButtons.xml

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -156,15 +156,7 @@
156156
</ReturnValue>
157157
<MemberValue>8388608</MemberValue>
158158
<Docs>
159-
<summary>The first XButton was pressed.</summary>
160-
<remarks>
161-
<format type="text/markdown"><![CDATA[
162-
163-
## Remarks
164-
With Windows 2000, Microsoft is introducing support for the Microsoft IntelliMouse Explorer, which is a mouse with five buttons. The two new mouse buttons (XBUTTON1 and XBUTTON2) provide backward/forward navigation.
165-
166-
]]></format>
167-
</remarks>
159+
<summary>The first XButton (XBUTTON1) on Microsoft IntelliMouse Explorer was pressed.</summary>
168160
</Docs>
169161
</Member>
170162
<Member MemberName="XButton2">
@@ -186,15 +178,7 @@
186178
</ReturnValue>
187179
<MemberValue>16777216</MemberValue>
188180
<Docs>
189-
<summary>The second XButton was pressed.</summary>
190-
<remarks>
191-
<format type="text/markdown"><![CDATA[
192-
193-
## Remarks
194-
With Windows 2000, Microsoft is introducing support for the Microsoft IntelliMouse Explorer, which is a mouse with five buttons. The two new mouse buttons (XBUTTON1 and XBUTTON2) provide backward/forward navigation.
195-
196-
]]></format>
197-
</remarks>
181+
<summary>The second XButton (XBUTTON2) on Microsoft IntelliMouse Explorer was pressed.</summary>
198182
</Docs>
199183
</Member>
200184
</Members>

‎xml/System.Windows.Forms/TextFormatFlags.xml

Lines changed: 6 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
3030
3131
## Examples
32-
The following code example demonstrates how to use the <xref:System.Windows.Forms.TextFormatFlags.ExpandTabs> enumeration. To run this example, paste the following code into a Windows Form. Call `RenderText6` from the form's <xref:System.Windows.Forms.Control.Paint> event handler, passing `e` as <xref:System.Windows.Forms.PaintEventArgs>.
32+
The following example demonstrates how to use the <xref:System.Windows.Forms.TextFormatFlags.ExpandTabs> enumeration. To run this example, paste the following code into a Windows Form. Call `RenderText6` from the form's <xref:System.Windows.Forms.Control.Paint> event handler, passing `e` as <xref:System.Windows.Forms.PaintEventArgs>.
3333
3434
[!code-csharp[System.Windows.Forms.TextRendererExamples#7](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.TextRendererExamples/CS/Form1.cs#7)]
3535
[!code-vb[System.Windows.Forms.TextRendererExamples#7](~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.TextRendererExamples/VB/Form1.vb#7)]
@@ -183,17 +183,7 @@
183183
</ReturnValue>
184184
<MemberValue>1048576</MemberValue>
185185
<Docs>
186-
<summary>Applies to Windows 2000 and Windows XP only:</summary>
187-
<remarks>
188-
<format type="text/markdown"><![CDATA[
189-
190-
## Remarks
191-
Ignores the ampersand (&) prefix character in the text. The letter that follows will not be underlined, but other mnemonic-prefix characters are still processed. For example, an input string of "A&bc&&d" with HidePrefix applied would result in output of "Abc&d".
192-
193-
Compare with NoPrefix and PrefixOnly.
194-
195-
]]></format>
196-
</remarks>
186+
<summary>A legacy value that has no effect. It ignored the ampersand (&amp;) prefix character in the text, so that the letter that followed was not underlined, but other mnemonic-prefix characters were still processed.</summary>
197187
</Docs>
198188
</Member>
199189
<Member MemberName="HorizontalCenter">
@@ -340,15 +330,7 @@
340330
</ReturnValue>
341331
<MemberValue>524288</MemberValue>
342332
<Docs>
343-
<summary>Applies to Windows 98, Windows Me, Windows 2000, or Windows XP only:</summary>
344-
<remarks>
345-
<format type="text/markdown"><![CDATA[
346-
347-
## Remarks
348-
Prevents a line break at a double-wide character string, so that the line-breaking rule is equivalent to single-wide character strings. For example, NoFullWidthCharacterBreak increases the readability of icon labels in Korean windows. This value has no effect unless WordBreak is also specified.
349-
350-
]]></format>
351-
</remarks>
333+
<summary>A legacy value that has no effect. It prevents a line break at a double-wide character string, so that the line-breaking rule is equivalent to that for single-wide character strings.</summary>
352334
</Docs>
353335
</Member>
354336
<Member MemberName="NoPadding">
@@ -390,16 +372,8 @@
390372
</ReturnValue>
391373
<MemberValue>2048</MemberValue>
392374
<Docs>
393-
<summary>Turns off processing of prefix characters. Typically, the ampersand (&amp;) mnemonic-prefix character is interpreted as a directive to underscore the character that follows, and the double-ampersand (&amp;&amp;) mnemonic-prefix characters as a directive to print a single ampersand. By specifying <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" />, this processing is turned off. For example, an input string of "A&amp;bc&amp;&amp;d" with <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" /> applied would result in output of "A&amp;bc&amp;&amp;d".</summary>
394-
<remarks>
395-
<format type="text/markdown"><![CDATA[
396-
397-
## Remarks
398-
Compare with HidePrefix and PrefixOnly.
399-
400-
]]></format>
401-
</remarks>
402-
</Docs>
375+
<summary>Turns off processing of prefix characters. Typically, the ampersand (&amp;) mnemonic-prefix character is interpreted as a directive to underscore the character that follows, and the double-ampersand (&amp;&amp;) mnemonic-prefix characters as a directive to print a single ampersand. By specifying <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" />, this processing is turned off. For example, an input string of "A&amp;bc&amp;&amp;d" with <see cref="F:System.Windows.Forms.TextFormatFlags.NoPrefix" /> applied would result in output of "A&amp;bc&amp;&amp;d". Compare with <c>PrefixOnly</c>. </summary>
376+
</Docs>
403377
</Member>
404378
<Member MemberName="PathEllipsis">
405379
<MemberSignature Language="C#" Value="PathEllipsis" />
@@ -440,17 +414,7 @@
440414
</ReturnValue>
441415
<MemberValue>2097152</MemberValue>
442416
<Docs>
443-
<summary>Applies to Windows 2000 or Windows XP only:</summary>
444-
<remarks>
445-
<format type="text/markdown"><![CDATA[
446-
447-
## Remarks
448-
Draws only an underline at the position of the character following the ampersand (&) prefix character. Does not draw any other characters in the string. For example, an input string of "A&bc&&d" would result in output of " _ ".
449-
450-
Compare with HidePrefix and NoPrefix.
451-
452-
]]></format>
453-
</remarks>
417+
<summary>A legacy value that has no effect. It drew only an underline at the position of the character following the ampersand (&amp;) prefix character, and did not draw any other characters in the string.</summary>
454418
</Docs>
455419
</Member>
456420
<Member MemberName="PreserveGraphicsClipping">

‎xml/System.Windows/InheritanceBehavior.xml

Lines changed: 8 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,7 @@
1414
<BaseTypeName>System.Enum</BaseTypeName>
1515
</Base>
1616
<Docs>
17-
<summary>Indicates the current mode of lookup for both property value inheritance, a resource lookup, and a RelativeSource FindAncestor lookup.</summary>
18-
<remarks>
19-
<format type="text/markdown"><![CDATA[
20-
21-
## Remarks
22-
A RelativeSource FindAncestor lookup occurs when a binding uses a <xref:System.Windows.Data.RelativeSource> that has its <xref:System.Windows.Data.RelativeSource.Mode%2A> property set to the <xref:System.Windows.Data.RelativeSourceMode.FindAncestor?displayProperty=nameWithType> value.
23-
24-
]]></format>
25-
</remarks>
17+
<summary>Indicates the current mode of lookup for property value inheritance, resource lookup, and RelativeSource FindAncestor lookup. A RelativeSource FindAncestor lookup occurs when a binding uses a <see cref="T:System.Windows.Data.RelativeSource" /> that has its <see cref="P:System.Windows.Data.RelativeSource.Mode" /> property set to the <see cref="F:System.Windows.Data.RelativeSourceMode.FindAncestor" /> value.</summary>
2618
</Docs>
2719
<Members>
2820
<Member MemberName="Default">
@@ -43,15 +35,7 @@
4335
</ReturnValue>
4436
<MemberValue>0</MemberValue>
4537
<Docs>
46-
<summary>Property value inheritance lookup will query the current element and continue walking up the element tree to the page root.</summary>
47-
<remarks>
48-
<format type="text/markdown"><![CDATA[
49-
50-
## Remarks
51-
A resource lookup will query through the current element and further.
52-
53-
]]></format>
54-
</remarks>
38+
<summary>Property value inheritance lookup will query the current element and continue walking up the element tree to the page root. A resource lookup will query through the current element and further.</summary>
5539
</Docs>
5640
</Member>
5741
<Member MemberName="SkipAllNext">
@@ -72,15 +56,7 @@
7256
</ReturnValue>
7357
<MemberValue>6</MemberValue>
7458
<Docs>
75-
<summary>Property value inheritance lookup will query the current element but not any further.</summary>
76-
<remarks>
77-
<format type="text/markdown"><![CDATA[
78-
79-
## Remarks
80-
A resource lookup will query the current element but not any further.
81-
82-
]]></format>
83-
</remarks>
59+
<summary>Property value inheritance lookup or resource lookup will query the current element but not any further. A resource lookup will query the current element but not any further. </summary>
8460
</Docs>
8561
</Member>
8662
<Member MemberName="SkipAllNow">
@@ -101,15 +77,7 @@
10177
</ReturnValue>
10278
<MemberValue>5</MemberValue>
10379
<Docs>
104-
<summary>Property value inheritance lookup will not query the current element or any further.</summary>
105-
<remarks>
106-
<format type="text/markdown"><![CDATA[
107-
108-
## Remarks
109-
A resource lookup will not query the current element or any further. A RelativeSource FindAncestor lookup will not query the current element or any further.
110-
111-
]]></format>
112-
</remarks>
80+
<summary>Property value inheritance lookup, resource lookup, or RelativeSource FindAncestor lookup will not query the current element or any further.</summary>
11381
</Docs>
11482
</Member>
11583
<Member MemberName="SkipToAppNext">
@@ -130,15 +98,7 @@
13098
</ReturnValue>
13199
<MemberValue>2</MemberValue>
132100
<Docs>
133-
<summary>Property value inheritance lookup will query the current element but not any further.</summary>
134-
<remarks>
135-
<format type="text/markdown"><![CDATA[
136-
137-
## Remarks
138-
A resource lookup will query the current element and will then skip over to the application and theme dictionaries, rather than walking up the element tree toward the page root.
139-
140-
]]></format>
141-
</remarks>
101+
<summary>Property value inheritance lookup will query the current element but not any further. A resource lookup will query the current element and will then skip over to the application and theme dictionaries, rather than walking up the element tree toward the page root.</summary>
142102
</Docs>
143103
</Member>
144104
<Member MemberName="SkipToAppNow">
@@ -159,15 +119,7 @@
159119
</ReturnValue>
160120
<MemberValue>1</MemberValue>
161121
<Docs>
162-
<summary>Property value inheritance lookup will not query the current element or any further.</summary>
163-
<remarks>
164-
<format type="text/markdown"><![CDATA[
165-
166-
## Remarks
167-
A resource lookup will not query the current element but will skip over to the application and then the theme dictionaries, rather than walking up the element tree toward the page root. A RelativeSource FindAncestor lookup will not query the current element or any further.
168-
169-
]]></format>
170-
</remarks>
122+
<summary>Property value inheritance lookup will not query the current element or any further. A resource lookup will not query the current element but will skip over to the application and then the theme dictionaries, rather than walking up the element tree toward the page root. A RelativeSource FindAncestor lookup will not query the current element or any further.</summary>
171123
</Docs>
172124
</Member>
173125
<Member MemberName="SkipToThemeNext">
@@ -188,15 +140,7 @@
188140
</ReturnValue>
189141
<MemberValue>4</MemberValue>
190142
<Docs>
191-
<summary>Property value inheritance lookup will query the current element but not any further.</summary>
192-
<remarks>
193-
<format type="text/markdown"><![CDATA[
194-
195-
## Remarks
196-
A resource lookup will query the current element and will then skip over to the theme dictionaries, rather than walking up the element tree toward the page root, or checking application dictionaries.
197-
198-
]]></format>
199-
</remarks>
143+
<summary>Property value inheritance lookup will query the current element but not any further. A resource lookup will query the current element and will then skip over to the theme dictionaries, rather than walking up the element tree toward the page root, or checking application dictionaries</summary>
200144
</Docs>
201145
</Member>
202146
<Member MemberName="SkipToThemeNow">
@@ -217,15 +161,7 @@
217161
</ReturnValue>
218162
<MemberValue>3</MemberValue>
219163
<Docs>
220-
<summary>Property value inheritance lookup will not query the current element or any further.</summary>
221-
<remarks>
222-
<format type="text/markdown"><![CDATA[
223-
224-
## Remarks
225-
A resource lookup will not query the current element but will skip over to the theme dictionaries, rather than walking up the element tree toward the page root, or checking application dictionaries. A RelativeSource FindAncestor lookup will not query the current element or any further.
226-
227-
]]></format>
228-
</remarks>
164+
<summary>Property value inheritance lookup will not query the current element or any further. A resource lookup will not query the current element but will skip over to the theme dictionaries, rather than walking up the element tree toward the page root, or checking application dictionaries. A RelativeSource FindAncestor lookup will not query the current element or any further.</summary>
229165
</Docs>
230166
</Member>
231167
</Members>

0 commit comments

Comments
 (0)