Skip to content

Commit 7503fbb

Browse files
author
Ron Petrusha
authored
Restored enumeration member remarks, Part 8 (#2627)
* Moved enumeration member remarks * Corrected missed cref * fix indentantion * Update EventParameterType.xml * Update TtsEngineAction.xml
1 parent 24d96e4 commit 7503fbb

File tree

10 files changed

+60
-246
lines changed

10 files changed

+60
-246
lines changed

xml/System.ServiceModel.Configuration/AuthenticationMode.xml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
</Base>
1616
<Docs>
1717
<summary>Specifies the authentication setting used for message exchange.</summary>
18-
<remarks>To be added.</remarks>
1918
</Docs>
2019
<Members>
2120
<Member MemberName="AnonymousForCertificate">
@@ -36,15 +35,7 @@
3635
</ReturnValue>
3736
<MemberValue>0</MemberValue>
3837
<Docs>
39-
<summary>Specifies that the initiator is anonymous, and that the responder is authenticated.</summary>
40-
<remarks>
41-
<format type="text/markdown"><![CDATA[
42-
43-
## Remarks
44-
The certificate of the responder is available out-of-band to the initiator.
45-
46-
]]></format>
47-
</remarks>
38+
<summary>Specifies that the initiator is anonymous, and that the responder is authenticated. The certificate of the responder is available out-of-band to the initiator.</summary>
4839
</Docs>
4940
</Member>
5041
<Member MemberName="AnonymousForSslNegotiated">

xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,12 @@
1818
<remarks>
1919
<format type="text/markdown"><![CDATA[
2020
21-
## Remarks
22-
If the specified peer resolver is unavailable, a <xref:System.InvalidOperationException> will be thrown when an attempt to use the resolver is made.
23-
21+
## Remarks
22+
23+
If the specified peer resolver is unavailable, an <xref:System.InvalidOperationException> will be thrown when an attempt to use the resolver is made.
24+
25+
If `Auto` is specified, a custom resolver is used, if one is available. If one is unavailable, the PNRP peer resolver is used. A peer resolver is considered "available" if the <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Address%2A?displayProperty=nameWithType> and <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Binding%2A?displayProperty=nameWithType> properties are set on it.
26+
2427
]]></format>
2528
</remarks>
2629
</Docs>
@@ -44,14 +47,6 @@
4447
<MemberValue>0</MemberValue>
4548
<Docs>
4649
<summary>Automatically determines the type of resolver to use from the information set on the binding.</summary>
47-
<remarks>
48-
<format type="text/markdown"><![CDATA[
49-
50-
## Remarks
51-
If available, a custom resolver is used. If one is unavailable, the PNRP peer resolver is used. A peer resolver is considered "available" if the <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Address%2A> and <xref:System.ServiceModel.PeerResolvers.PeerCustomResolverSettings.Binding%2A> properties are set on it.
52-
53-
]]></format>
54-
</remarks>
5550
</Docs>
5651
</Member>
5752
<Member MemberName="Custom">

xml/System.ServiceModel.Security.Tokens/SecurityTokenInclusionMode.xml

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<format type="text/markdown"><![CDATA[
2121
2222
## Remarks
23-
Instances of this class are used as parameters in many of the methods of the <xref:System.ServiceModel.Security.Tokens.SecurityTokenParameters> class and in its derived classes when creating binding elements and certificates.
23+
`SecurityTokenInclusionMode` enumeration members are used as parameters in many methods of the <xref:System.ServiceModel.Security.Tokens.SecurityTokenParameters> class and in its derived classes when creating binding elements and certificates.
2424
2525
]]></format>
2626
</remarks>
@@ -45,7 +45,7 @@
4545
</ReturnValue>
4646
<MemberValue>3</MemberValue>
4747
<Docs>
48-
<summary>Token is always included in messages to the initiator and never to the recipient.</summary>
48+
<summary>The token is always included in messages to the initiator and never to the recipient.</summary>
4949
</Docs>
5050
</Member>
5151
<Member MemberName="AlwaysToRecipient">
@@ -67,7 +67,7 @@
6767
</ReturnValue>
6868
<MemberValue>0</MemberValue>
6969
<Docs>
70-
<summary>Token is always included in messages to the recipient and never to the initiator.</summary>
70+
<summary>The token is always included in messages to the recipient and never to the initiator.</summary>
7171
</Docs>
7272
</Member>
7373
<Member MemberName="Never">
@@ -111,15 +111,7 @@
111111
</ReturnValue>
112112
<MemberValue>2</MemberValue>
113113
<Docs>
114-
<summary>Token is included once.</summary>
115-
<remarks>
116-
<format type="text/markdown"><![CDATA[
117-
118-
## Remarks
119-
The token must be included in only one message sent from the initiator to the recipient. References to the token may use an internal reference mechanism. Subsequent related messages sent between the recipient and the initiator may refer to the token using an external reference mechanism.
120-
121-
]]></format>
122-
</remarks>
114+
<summary>The token is included once. The token must be included in only one message sent from the initiator to the recipient. References to the token may use an internal reference mechanism. Subsequent related messages sent between the recipient and the initiator may refer to the token using an external reference mechanism.</summary>
123115
</Docs>
124116
</Member>
125117
</Members>

xml/System.ServiceModel/AddressFilterMode.xml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<format type="text/markdown"><![CDATA[
2121
2222
## Remarks
23-
The value of the <xref:System.ServiceModel.AddressFilterMode> enumeration is set on the <xref:System.ServiceModel.ServiceBehaviorAttribute.AddressFilterMode%2A> property.
23+
The value of the `AddressFilterMode` enumeration is set on the <xref:System.ServiceModel.ServiceBehaviorAttribute.AddressFilterMode%2A?displayProperty=nameWithType> property.
2424
2525
The longest prefix match criterion specified by Prefix requires that the destination address be matched by the largest number of leading address bits in the filter. The default value is Exact.
2626
@@ -53,15 +53,7 @@
5353
</ReturnValue>
5454
<MemberValue>2</MemberValue>
5555
<Docs>
56-
<summary>Indicates a filter that matches on any address of an incoming message.</summary>
57-
<remarks>
58-
<format type="text/markdown"><![CDATA[
59-
60-
## Remarks
61-
Using this value turns off the WCF address filter check. Any message, no matter what its WS-Addressing:To identity is accepted.
62-
63-
]]></format>
64-
</remarks>
56+
<summary>Indicates a filter that matches on any address of an incoming message. Using this value turns off the WCF address filter check. Any message, no matter what its WS-Addressing:To identity, is accepted.</summary>
6557
</Docs>
6658
</Member>
6759
<Member MemberName="Exact">

xml/System.ServiceModel/InstanceContextMode.xml

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
<format type="text/markdown"><![CDATA[
2121
2222
## Remarks
23-
The <xref:System.ServiceModel.InstanceContext?displayProperty=nameWithType> manages the association between the channel and the user-defined service objects. Use the <xref:System.ServiceModel.InstanceContextMode> enumeration with the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> property to specify the lifetime of the <xref:System.ServiceModel.InstanceContext> object. Windows Communication Foundation (WCF) can create a new <xref:System.ServiceModel.InstanceContext> object for every call, every session or specify that the <xref:System.ServiceModel.InstanceContext> object is bound to a single service object. For a working example, see the [Instancing](~/docs/framework/wcf/samples/instancing.md).
24-
25-
The Single value specifies that a single <xref:System.ServiceModel.InstanceContextMode.Single> object should be used for the lifetime of the service.
26-
27-
> [!NOTE]
28-
> If the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A> value is set to Single the result is that your service can only process one message at a time unless you also set the <xref:System.ServiceModel.ServiceBehaviorAttribute.ConcurrencyMode%2A> value to <xref:System.ServiceModel.ConcurrencyMode.Multiple>.
29-
30-
23+
24+
The <xref:System.ServiceModel.InstanceContext?displayProperty=nameWithType> class manages the association between the channel and the user-defined service objects. Use the `InstanceContextMode` enumeration with the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> property to specify the lifetime of the <xref:System.ServiceModel.InstanceContext> object. Windows Communication Foundation (WCF) can create a new <xref:System.ServiceModel.InstanceContext> object for every call, every session, or specify that the <xref:System.ServiceModel.InstanceContext> object is bound to a single service object. For a working example, see [Instancing](~/docs/framework/wcf/samples/instancing.md).
3125
26+
The `Single` value specifies that a single <xref:System.ServiceModel.InstanceContext> object should be used for the lifetime of the service. Several caveats are associated with the `Single` value:
27+
28+
- If the <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> value is set to `Single`, your service can only process one message at a time unless you also set the <xref:System.ServiceModel.ServiceBehaviorAttribute.ConcurrencyMode%2A?displayProperty=nameWithtype> value to <xref:System.ServiceModel.ConcurrencyMode.Multiple?displayProperty=nameWithType>.
29+
30+
- For singleton lifetime behavior (for example, if the host application calls the <xref:System.ServiceModel.ServiceHost.%23ctor%2A?displayProperty=nameWithType> constructor and passes an object to use as the service), the service class must set <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A?displayProperty=nameWithType> to `Single`, or an exception is thrown when the service host is opened.
31+
3232
## Examples
3333
The following code illustrates how to set the <xref:System.ServiceModel.InstanceContextMode> for a service class:
3434
@@ -105,17 +105,7 @@
105105
<MemberValue>2</MemberValue>
106106
<Docs>
107107
<summary>Only one <see cref="T:System.ServiceModel.InstanceContext" /> object is used for all incoming calls and is not recycled subsequent to the calls. If a service object does not exist, one is created.</summary>
108-
<remarks>
109-
<format type="text/markdown"><![CDATA[
110-
111-
## Remarks
112-
113-
> [!NOTE]
114-
> For singleton lifetime behavior (for example, if the host application calls the <xref:System.ServiceModel.ServiceHost.%23ctor%2A> constructor and passes an object to use as the service), the service class must set <xref:System.ServiceModel.ServiceBehaviorAttribute.InstanceContextMode%2A> to Single, or an exception is thrown when the service host is opened.
115-
116-
]]></format>
117-
</remarks>
118108
</Docs>
119109
</Member>
120110
</Members>
121-
</Type>
111+
</Type>

xml/System.ServiceModel/ReceiveErrorHandling.xml

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515
<BaseTypeName>System.Enum</BaseTypeName>
1616
</Base>
1717
<Docs>
18-
<summary>An enumeration that specifies handling for a poison message.</summary>
18+
<summary>Specifies handling for poison messages.</summary>
1919
<remarks>
2020
<format type="text/markdown"><![CDATA[
2121
2222
## Remarks
23-
A poison message is a message that fails repeated attempts to deliver to the application. This is applicable only when using a Message Queuing (MSMQ)-based binding. The default value is `Fault`, which faults the listener and therefore the ServiceHost. In the case where the service was to fault because of a poison message, a <xref:System.ServiceModel.MsmqPoisonMessageException> is thrown. The exception contains the `LookupId` of the MSMQ message that can be used to move the message out of the way using System.Messaging API. Certain values of the <xref:System.ServiceModel.ReceiveErrorHandling> enumeration such as `Reject` and `Move` are only available on [!INCLUDE[wv](~/includes/wv-md.md)]. You control poison message handling by setting the <xref:System.ServiceModel.Channels.MsmqBindingElementBase.ReceiveErrorHandling%2A> property to one of the values of this enumeration.
23+
A *poison message* is a message that fails repeated attempts to deliver to the application. This is applicable only when using a Message Queuing (MSMQ)-based binding. The default value is `Fault`, which faults the listener and therefore the ServiceHost. In the case where the service was to fault because of a poison message, a <xref:System.ServiceModel.MsmqPoisonMessageException> is thrown. The exception contains the `LookupId` of the MSMQ message that can be used to move the message out of the way using System.Messaging API. Certain values of the <xref:System.ServiceModel.ReceiveErrorHandling> enumeration such as `Reject` and `Move` are only available on [!INCLUDE[wv](~/includes/wv-md.md)]. You control poison message handling by setting the <xref:System.ServiceModel.Channels.MsmqBindingElementBase.ReceiveErrorHandling%2A> property to one of the values of this enumeration.
2424
2525
2626
@@ -55,14 +55,6 @@
5555
<MemberValue>1</MemberValue>
5656
<Docs>
5757
<summary>This option drops the poison message. The message never gets delivered to the application. If the message's TTL had already expired at this point, then the message may appear in the sender's Dead Letter Queue. If not, the message does not appear anywhere. This option indicates that the user does not really care if the message is lost.</summary>
58-
<remarks>
59-
<format type="text/markdown"><![CDATA[
60-
61-
## Remarks
62-
Applicable platforms: [!INCLUDE[wxp](~/includes/wxp-md.md)], [!INCLUDE[ws2003](~/includes/ws2003-md.md)], and [!INCLUDE[wv](~/includes/wv-md.md)].
63-
64-
]]></format>
65-
</remarks>
6658
</Docs>
6759
</Member>
6860
<Member MemberName="Fault">
@@ -85,14 +77,6 @@
8577
<MemberValue>0</MemberValue>
8678
<Docs>
8779
<summary>This option sends a fault to the listener that caused the ServiceHost to fault. The message must be removed from the application queue by some external mechanism before the application can continue to process messages from the queue.</summary>
88-
<remarks>
89-
<format type="text/markdown"><![CDATA[
90-
91-
## Remarks
92-
Applicable platforms: Windows XP, Windows Server 2003, and Windows Vista.
93-
94-
]]></format>
95-
</remarks>
9680
</Docs>
9781
</Member>
9882
<Member MemberName="Move">
@@ -115,14 +99,6 @@
11599
<MemberValue>3</MemberValue>
116100
<Docs>
117101
<summary>This moves the poison message to a Poison Message Queue for later processing by a poison message handling application.</summary>
118-
<remarks>
119-
<format type="text/markdown"><![CDATA[
120-
121-
## Remarks
122-
Applicable platforms: [!INCLUDE[wv](~/includes/wv-md.md)] only.
123-
124-
]]></format>
125-
</remarks>
126102
</Docs>
127103
</Member>
128104
<Member MemberName="Reject">
@@ -145,14 +121,6 @@
145121
<MemberValue>2</MemberValue>
146122
<Docs>
147123
<summary>This instructs MSMQ to send a negative acknowledgement back to the sending queue manager that the message cannot be received by the application. The message is placed in the sending queue manager's Dead Letter Queue.</summary>
148-
<remarks>
149-
<format type="text/markdown"><![CDATA[
150-
151-
## Remarks
152-
Applicable platforms: [!INCLUDE[wv](~/includes/wv-md.md)] only.
153-
154-
]]></format>
155-
</remarks>
156124
</Docs>
157125
</Member>
158126
</Members>

xml/System.ServiceProcess/PowerBroadcastStatus.xml

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
<format type="text/markdown"><![CDATA[
2626
2727
## Remarks
28-
<xref:System.ServiceProcess.PowerBroadcastStatus> is used by the <xref:System.ServiceProcess.ServiceBase> class to indicate a change in the system's power status. You can design your application to react to any power status change.
28+
29+
`PowerBroadcastStatus` is used by the <xref:System.ServiceProcess.ServiceBase> class to indicate a change in the system's power status. You can design your application to react to any power status change.
2930
3031
]]></format>
3132
</remarks>
@@ -192,17 +193,7 @@
192193
</ReturnValue>
193194
<MemberValue>18</MemberValue>
194195
<Docs>
195-
<summary>The computer has woken up automatically to handle an event.</summary>
196-
<remarks>
197-
<format type="text/markdown"><![CDATA[
198-
199-
## Remarks
200-
201-
> [!NOTE]
202-
> If the system detects any user activity after broadcasting `ResumeAutomatic`, it will broadcast a `ResumeSuspend` event to let applications know they can resume full interaction with the user.
203-
204-
]]></format>
205-
</remarks>
196+
<summary>The computer has woken up automatically to handle an event. If the system detects any user activity after broadcasting <see langword="ResumeAutomatic" />, it broadcasts a <see langword="ResumeSuspend" /> event to let applications know they can resume full interaction with the user.</summary>
206197
</Docs>
207198
</Member>
208199
<Member MemberName="ResumeCritical">
@@ -229,17 +220,7 @@
229220
</ReturnValue>
230221
<MemberValue>6</MemberValue>
231222
<Docs>
232-
<summary>The system has resumed operation after a critical suspension caused by a failing battery.</summary>
233-
<remarks>
234-
<format type="text/markdown"><![CDATA[
235-
236-
## Remarks
237-
238-
> [!NOTE]
239-
> Because a critical suspension occurs without prior notification, resources and data previously available may not be present when the application receives this event. The application should attempt to restore its state to the best of its ability.
240-
241-
]]></format>
242-
</remarks>
223+
<summary>The system has resumed operation after a critical suspension caused by a failing battery. Because a critical suspension occurs without prior notification, resources and data previously available may not be present when the application receives this event. The application should attempt to restore its state to the best of its ability.</summary>
243224
</Docs>
244225
</Member>
245226
<Member MemberName="ResumeSuspend">

0 commit comments

Comments
 (0)