From ee49143c284a718ea71e8f8c8f8b0d693abec1b7 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Fri, 21 Jun 2019 15:38:43 -0700 Subject: [PATCH 1/5] Moved enumeration member remarks --- .../AuthenticationMode.xml | 11 +-- .../PeerResolverMode.xml | 17 ++-- .../SecurityTokenInclusionMode.xml | 16 +--- xml/System.ServiceModel/AddressFilterMode.xml | 12 +-- .../InstanceContextMode.xml | 26 ++--- .../ReceiveErrorHandling.xml | 36 +------ .../PowerBroadcastStatus.xml | 27 +----- .../EventParameterType.xml | 37 ++------ .../TtsEngineAction.xml | 95 +++---------------- .../SynthesisTextFormat.xml | 15 ++- 10 files changed, 53 insertions(+), 239 deletions(-) diff --git a/xml/System.ServiceModel.Configuration/AuthenticationMode.xml b/xml/System.ServiceModel.Configuration/AuthenticationMode.xml index 5cefdd05039..01eda674024 100644 --- a/xml/System.ServiceModel.Configuration/AuthenticationMode.xml +++ b/xml/System.ServiceModel.Configuration/AuthenticationMode.xml @@ -15,7 +15,6 @@ Specifies the authentication setting used for message exchange. - To be added. @@ -36,15 +35,7 @@ 0 - Specifies that the initiator is anonymous, and that the responder is authenticated. - - - + 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. diff --git a/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml b/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml index 9f2adfba13f..53fc59d7411 100644 --- a/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml +++ b/xml/System.ServiceModel.PeerResolvers/PeerResolverMode.xml @@ -18,9 +18,12 @@ will be thrown when an attempt to use the resolver is made. - +## Remarks + +If the specified peer resolver is unavailable, an will be thrown when an attempt to use the resolver is made. + +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 and properties are set on it. + ]]> @@ -44,14 +47,6 @@ 0 Automatically determines the type of resolver to use from the information set on the binding. - - and properties are set on it. - - ]]> - diff --git a/xml/System.ServiceModel.Security.Tokens/SecurityTokenInclusionMode.xml b/xml/System.ServiceModel.Security.Tokens/SecurityTokenInclusionMode.xml index 5395495b3e9..5a3cb22466f 100644 --- a/xml/System.ServiceModel.Security.Tokens/SecurityTokenInclusionMode.xml +++ b/xml/System.ServiceModel.Security.Tokens/SecurityTokenInclusionMode.xml @@ -20,7 +20,7 @@ class and in its derived classes when creating binding elements and certificates. +`SecurityTokenInclusionMode` enumeration members are used as parameters in many methods of the class and in its derived classes when creating binding elements and certificates. ]]> @@ -45,7 +45,7 @@ 3 - Token is always included in messages to the initiator and never to the recipient. + The token is always included in messages to the initiator and never to the recipient. @@ -67,7 +67,7 @@ 0 - Token is always included in messages to the recipient and never to the initiator. + The token is always included in messages to the recipient and never to the initiator. @@ -111,15 +111,7 @@ 2 - Token is included once. - - - + 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. diff --git a/xml/System.ServiceModel/AddressFilterMode.xml b/xml/System.ServiceModel/AddressFilterMode.xml index a40b4e1a2dd..2213cf17fad 100644 --- a/xml/System.ServiceModel/AddressFilterMode.xml +++ b/xml/System.ServiceModel/AddressFilterMode.xml @@ -20,7 +20,7 @@ enumeration is set on the property. + The value of the `AddressFilterMode` enumeration is set on the property. 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. @@ -53,15 +53,7 @@ 2 - Indicates a filter that matches on any address of an incoming message. - - - + 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. diff --git a/xml/System.ServiceModel/InstanceContextMode.xml b/xml/System.ServiceModel/InstanceContextMode.xml index 3063d7f1dd8..4d5813a023d 100644 --- a/xml/System.ServiceModel/InstanceContextMode.xml +++ b/xml/System.ServiceModel/InstanceContextMode.xml @@ -20,15 +20,15 @@ manages the association between the channel and the user-defined service objects. Use the enumeration with the property to specify the lifetime of the object. Windows Communication Foundation (WCF) can create a new object for every call, every session or specify that the object is bound to a single service object. For a working example, see the [Instancing](~/docs/framework/wcf/samples/instancing.md). - - The Single value specifies that a single object should be used for the lifetime of the service. - -> [!NOTE] -> If the value is set to Single the result is that your service can only process one message at a time unless you also set the value to . - - + +The class manages the association between the channel and the user-defined service objects. Use the `InstanceContextMode` enumeration with the property to specify the lifetime of the object. Windows Communication Foundation (WCF) can create a new object for every call, every session, or specify that the object is bound to a single service object. For a working example, see [Instancing](~/docs/framework/wcf/samples/instancing.md). +The `Single` value specifies that a single object should be used for the lifetime of the service. Several caveats are associated with the `Single` value: + + - If the value is set to `Single`, your service can only process one message at a time unless you also set the value to . + +- For singleton lifetime behavior (for example, if the host application calls the constructor and passes an object to use as the service), the service class must set to `Single`, or an exception is thrown when the service host is opened. + ## Examples The following code illustrates how to set the for a service class: @@ -105,16 +105,6 @@ 2 Only one 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. - - [!NOTE] -> For singleton lifetime behavior (for example, if the host application calls the constructor and passes an object to use as the service), the service class must set to Single, or an exception is thrown when the service host is opened. - - ]]> - diff --git a/xml/System.ServiceModel/ReceiveErrorHandling.xml b/xml/System.ServiceModel/ReceiveErrorHandling.xml index 5702107b009..5ccd5ad0891 100644 --- a/xml/System.ServiceModel/ReceiveErrorHandling.xml +++ b/xml/System.ServiceModel/ReceiveErrorHandling.xml @@ -15,12 +15,12 @@ System.Enum - An enumeration that specifies handling for a poison message. + Specifies handling for poison messages. 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 enumeration such as `Reject` and `Move` are only available on [!INCLUDE[wv](~/includes/wv-md.md)]. You control poison message handling by setting the property to one of the values of this enumeration. + 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 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 enumeration such as `Reject` and `Move` are only available on [!INCLUDE[wv](~/includes/wv-md.md)]. You control poison message handling by setting the property to one of the values of this enumeration. @@ -55,14 +55,6 @@ 1 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. - - - @@ -85,14 +77,6 @@ 0 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. - - - @@ -115,14 +99,6 @@ 3 This moves the poison message to a Poison Message Queue for later processing by a poison message handling application. - - - @@ -145,14 +121,6 @@ 2 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. - - - diff --git a/xml/System.ServiceProcess/PowerBroadcastStatus.xml b/xml/System.ServiceProcess/PowerBroadcastStatus.xml index 691ce994b1d..d63994e8322 100644 --- a/xml/System.ServiceProcess/PowerBroadcastStatus.xml +++ b/xml/System.ServiceProcess/PowerBroadcastStatus.xml @@ -25,7 +25,8 @@ is used by the class to indicate a change in the system's power status. You can design your application to react to any power status change. + +`PowerBroadcastStatus` is used by the class to indicate a change in the system's power status. You can design your application to react to any power status change. ]]> @@ -192,17 +193,7 @@ 18 - The computer has woken up automatically to handle an event. - - [!NOTE] -> 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. - - ]]> - + The computer has woken up automatically to handle an event. If the system detects any user activity after broadcasting , it broadcasts a event to let applications know they can resume full interaction with the user. @@ -229,17 +220,7 @@ 6 - The system has resumed operation after a critical suspension caused by a failing battery. - - [!NOTE] -> 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. - - ]]> - + 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. diff --git a/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml b/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml index dd6cdbf043c..a1a75d7a497 100644 --- a/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml +++ b/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml @@ -18,14 +18,16 @@ is used when constructing a object. An instance of passed as the `parameterType` argument to the constructor for specifies how the `param2` argument of the constructor (which must be a `System.IntPtr`) is interpreted. +## Remarks + +The `EventParameterType` enumeration is used when constructing a object. An `EventParameterType` enumeration member passed as the `parameterType` argument to the constructor for specifies how the `param2` argument of the constructor (which must be an ) is interpreted. - The choice of is dictated by the type of event being requested, as specified by a member of . +The choice of `EventParameterType` is dictated by the type of event being requested, as specified by a member of . - For detailed information on how use , see documentation for +For detailed information on how use `EventParameterType`, see the documentation for - +> [!NOTE] +> Currently, instances of a managed synthetic speech engines written using the members of the namespace cannot change resources after construction. ## Examples The example below is part of a custom speech synthesis implementation inheriting from , and using the use of , , , and . @@ -184,20 +186,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 1 - Indicates that the argument to the is a - - ); `param1` may take on any value. - -> [!NOTE] -> Currently instances of a managed synthetic speech engines, written using the members of the name space, cannot change resources after construction - - ]]> - + Indicates that the argument to the is an created using that references a Windows Desktop Speech Technology token, which is a Windows Desktop Speech Technology object representing a resource, such as a voice (). may take on any value. @@ -218,15 +207,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 0 - Indicates that the argument to the is undefined. - - is , a progress meter event can be generated `param1` should be an integer containing the length of the current word, and `param2` a `System.IntPtr` referencing an integer containing the offset of the current word. - - ]]> - + Indicates that the argument to the is undefined. Generally, and are then ignored. However, if is , a progress meter event can be generated. should be an integer containing the length of the current word, and an referencing an integer containing the offset of the current word. diff --git a/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml b/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml index c1be0d6fd9a..5f9902e0b61 100644 --- a/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml +++ b/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml @@ -18,8 +18,9 @@ represents requests for servicing a . The actions correspond closely to elements in the SSML specification and are implemented on the text returned by the property on a . +## Remarks + +`TtsEngineAction` represents requests for servicing a . The actions correspond closely to elements in the SSML specification and are implemented on the text returned by the property on a . The value associated with a is returned by the property. @@ -114,15 +115,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 3 - Indicates that is to be used as the contents of a bookmark. - - ` XML tag in the SSML specification. - - ]]> - + Indicates that is to be used as the contents of a bookmark. It corresponds to the <mark> XML tag in the SSML specification. @@ -143,17 +136,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 7 - Indicates that no action has been determined from SSML input. - - is an unknown XML tag not part of the SSML standard. - - This input that may be interpreted or ignored by at the discretion of a synthesis engine. - - ]]> - + Indicates that no action has been determined from SSML input. This input that may be interpreted or ignored by at the discretion of a synthesis engine. The associated is an unknown XML tag not part of the SSML standard. @@ -174,17 +157,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 2 - Requests that input text be interpreted as phonemes. - - member of the object returned by the property on instances. - - Corresponds to the `` XML tag in the SSML specification. - - ]]> - + Requests that input text be interpreted as phonemes. Exact pronunciation is specified by the member of the object returned by the property on instances. It corresponds to the <Phoneme> XML tag in the SSML specification. @@ -205,17 +178,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 1 - Indicates that a contains no text to be rendered as speech. - - member of the he object returned by the property on instances. - - Corresponds to the `` XML tag in the SSML specification. - - ]]> - + Indicates that a contains no text to be rendered as speech. Duration of the silence is specified by the property of the the object returned by the property on instances. It corresponds to the <Silence> XML tag in the SSML specification. @@ -236,17 +199,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 0 - Requests that the associated should be processed and spoken. - - for a , - - Corresponds to the `` XML tag in the SSML specification - - ]]> - + Requests that the associated should be processed and spoken. This is the default value for a . It corresponds to the <speak> XML tag in the SSML specification. @@ -267,17 +220,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 4 - Indicates that text values provided by a through its property are to be synthesize as individual characters. - - - + Indicates that text values provided by a through its property are to be synthesize as individual characters. This rendering includes punctuation, other than white space, as well as alphanumeric text. For example, the associated text fragment "word!" should be synthesized into "w o r d exclamation point". @@ -298,15 +241,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 6 - Indicates state of paragraph. - - ` XML tag in the SSML specification - - ]]> - + Indicates state of paragraph. It corresponds to the <p> XML tag in the SSML specification. @@ -327,15 +262,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 5 - Indicates start of sentence. - - ` XML tag in the SSML specification - - ]]> - + Indicates start of sentence. It corresponds to the <s> XML tag in the SSML specification. diff --git a/xml/System.Speech.Synthesis/SynthesisTextFormat.xml b/xml/System.Speech.Synthesis/SynthesisTextFormat.xml index a905d6e3566..e7a7e83be3e 100644 --- a/xml/System.Speech.Synthesis/SynthesisTextFormat.xml +++ b/xml/System.Speech.Synthesis/SynthesisTextFormat.xml @@ -19,7 +19,12 @@ constructor uses to indicate the format of the text that its `textToSpeak` parameter contains. + +The constructor uses to indicate the format of the text that its `textToSpeak` parameter contains. + +## Examples + + See for an example. ]]> @@ -45,14 +50,6 @@ 1 Indicates that the text format is SSML. - - for an example. - - ]]> - From d8b9b8c31242085f70cdca4c14b3304f70cdb306 Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Mon, 24 Jun 2019 08:41:14 -0700 Subject: [PATCH 2/5] Corrected missed cref --- xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml b/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml index a1a75d7a497..55668897f28 100644 --- a/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml +++ b/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml @@ -186,7 +186,7 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si 1 - Indicates that the argument to the is an created using that references a Windows Desktop Speech Technology token, which is a Windows Desktop Speech Technology object representing a resource, such as a voice (). may take on any value. + Indicates that the argument to the is an created using that references a Windows Desktop Speech Technology token, which is a Windows Desktop Speech Technology object representing a resource, such as a voice (). may take on any value. From f8adc2ee387365d2c915be66285a81fa9f6b7b60 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Thu, 25 Jul 2019 18:31:03 -0700 Subject: [PATCH 3/5] fix indentantion --- xml/System.ServiceModel/InstanceContextMode.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.ServiceModel/InstanceContextMode.xml b/xml/System.ServiceModel/InstanceContextMode.xml index 4d5813a023d..65fdb187854 100644 --- a/xml/System.ServiceModel/InstanceContextMode.xml +++ b/xml/System.ServiceModel/InstanceContextMode.xml @@ -25,7 +25,7 @@ The clas The `Single` value specifies that a single object should be used for the lifetime of the service. Several caveats are associated with the `Single` value: - - If the value is set to `Single`, your service can only process one message at a time unless you also set the value to . +- If the value is set to `Single`, your service can only process one message at a time unless you also set the value to . - For singleton lifetime behavior (for example, if the host application calls the constructor and passes an object to use as the service), the service class must set to `Single`, or an exception is thrown when the service host is opened. @@ -108,4 +108,4 @@ The `Single` value specifies that a single - \ No newline at end of file + From 5c348ce21a86803ff328e9be6b048c00f6678aa9 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Thu, 25 Jul 2019 18:34:22 -0700 Subject: [PATCH 4/5] Update EventParameterType.xml --- .../EventParameterType.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml b/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml index 55668897f28..6718779ab36 100644 --- a/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml +++ b/xml/System.Speech.Synthesis.TtsEngine/EventParameterType.xml @@ -30,7 +30,7 @@ For detailed information on how use `EventParameterType`, see the documentation > Currently, instances of a managed synthetic speech engines written using the members of the namespace cannot change resources after construction. ## Examples - The example below is part of a custom speech synthesis implementation inheriting from , and using the use of , , , and . + The following example is part of a custom speech synthesis implementation inheriting from , and using the use of , , , and . The implementation of @@ -46,7 +46,7 @@ For detailed information on how use `EventParameterType`, see the documentation 3. A speech rendering engine is then called with the modified array. -``` +```csharp private const int WordBoundaryFlag = 1 << (int)TtsEventId.WordBoundary; private readonly char[] spaces = new char[] { ' ', '\t', '\r', '\n' }; internal struct UsVsUk @@ -211,4 +211,4 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si - \ No newline at end of file + From 36d11ac9975bd5673994433dd730207a967eb147 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Thu, 25 Jul 2019 18:35:48 -0700 Subject: [PATCH 5/5] Update TtsEngineAction.xml --- xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml b/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml index 5f9902e0b61..abacd3bfbe6 100644 --- a/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml +++ b/xml/System.Speech.Synthesis.TtsEngine/TtsEngineAction.xml @@ -29,7 +29,7 @@ ## Examples - The example below is part of a custom speech synthesis implementation inheriting from , and using the use of , , and + The following example is part of a custom speech synthesis implementation inheriting from , and using the use of , , and The implementation of @@ -43,7 +43,7 @@ 3. A speech rendering engine is then called with the modified array. -``` +```csharp private const int WordBoundaryFlag = 1 << (int)TtsEventId.WordBoundary; private readonly char[] spaces = new char[] { ' ', '\t', '\r', '\n' }; internal struct UsVsUk @@ -266,4 +266,4 @@ override public void Speak (TextFragment [] frags, IntPtr wfx, ITtsEngineSite si - \ No newline at end of file +