Skip to content

Commit 464bd95

Browse files
authored
standardize exception wording (dotnet#7630)
1 parent 5d1b21f commit 464bd95

File tree

4 files changed

+95
-90
lines changed

4 files changed

+95
-90
lines changed

xml/System.DirectoryServices.Protocols/DsmlSoapConnection.xml

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
</Base>
1616
<Interfaces />
1717
<Docs>
18-
<summary>The <see cref="T:System.DirectoryServices.Protocols.DsmlSoapConnection" /> class is an abstract class that cannot be instantiated. It enables stateless and stateful protocols to be handled similarly by providing session-oriented features.</summary>
18+
<summary>An abstract class that cannot be instantiated. It enables stateless and stateful protocols to be handled similarly by providing session-oriented features.</summary>
1919
<remarks>To be added.</remarks>
2020
</Docs>
2121
<Members>
@@ -33,7 +33,7 @@
3333
</AssemblyInfo>
3434
<Parameters />
3535
<Docs>
36-
<summary>The <see cref="M:System.DirectoryServices.Protocols.DsmlSoapConnection.#ctor" /> constructor initializes a new instance of a <see cref="T:System.DirectoryServices.Protocols.DsmlSoapConnection" /> class.</summary>
36+
<summary>Initializes a new instance of a <see cref="T:System.DirectoryServices.Protocols.DsmlSoapConnection" /> class.</summary>
3737
<remarks>To be added.</remarks>
3838
</Docs>
3939
</Member>
@@ -55,7 +55,7 @@
5555
</ReturnValue>
5656
<Parameters />
5757
<Docs>
58-
<summary>The <see cref="M:System.DirectoryServices.Protocols.DsmlSoapConnection.BeginSession" /> method instructs the DSML server to start a new session.</summary>
58+
<summary>Instructs the DSML server to start a new session.</summary>
5959
<remarks>
6060
<format type="text/markdown"><![CDATA[
6161
@@ -64,9 +64,9 @@
6464
6565
]]></format>
6666
</remarks>
67-
<exception cref="T:System.InvalidOperationException">Thrown when a session is already open on the connection.</exception>
68-
<exception cref="T:System.DirectoryServices.Protocols.DsmlInvalidDocumentException">Thrown when the XML returned from the Server in response to the BeginSession is not well-formed.</exception>
69-
<exception cref="T:System.Net.WebException">Thrown when there is a communications failure with the DSML server.</exception>
67+
<exception cref="T:System.InvalidOperationException">A session is already open on the connection.</exception>
68+
<exception cref="T:System.DirectoryServices.Protocols.DsmlInvalidDocumentException">The XML returned from the Server in response to the BeginSession is not well-formed.</exception>
69+
<exception cref="T:System.Net.WebException">There is a communications failure with the DSML server.</exception>
7070
</Docs>
7171
</Member>
7272
<Member MemberName="EndSession">
@@ -87,21 +87,19 @@
8787
</ReturnValue>
8888
<Parameters />
8989
<Docs>
90-
<summary>The <see cref="M:System.DirectoryServices.Protocols.DsmlSoapConnection.EndSession" /> method ends the session with the DSML server and clears the <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId" /> property.</summary>
90+
<summary>Ends the session with the DSML server and clears the <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId" /> property.</summary>
9191
<remarks>
9292
<format type="text/markdown"><![CDATA[
9393
9494
## Remarks
9595
The method will block while waiting for a response from the DSML server and will timeout according to the <xref:System.DirectoryServices.Protocols.DirectoryConnection.Timeout%2A> property.
9696
97-
If the DSML server terminates the session, a <xref:System.Net.WebException>
98-
99-
is thrown. If <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId%2A> is still valid after the exception is thrown, the request never reached the server and the connection is still considered valid.
97+
If the DSML server terminates the session, a <xref:System.Net.WebException> is thrown. If <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId%2A> is still valid after the exception is thrown, the request never reached the server and the connection is still considered valid.
10098
10199
]]></format>
102100
</remarks>
103-
<exception cref="T:System.Net.WebException">Thrown when a communications failure occurs with the DSML server.</exception>
104-
<exception cref="T:System.InvalidOperationException">Thrown when there is no open session.</exception>
101+
<exception cref="T:System.Net.WebException">A communications failure occurred with the DSML server.</exception>
102+
<exception cref="T:System.InvalidOperationException">There is no open session.</exception>
105103
</Docs>
106104
</Member>
107105
<Member MemberName="SessionId">
@@ -121,16 +119,9 @@
121119
<ReturnType>System.String</ReturnType>
122120
</ReturnValue>
123121
<Docs>
124-
<summary>The <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SessionId" /> property contains the active session ID.</summary>
125-
<value>The active session ID.</value>
126-
<remarks>
127-
<format type="text/markdown"><![CDATA[
128-
129-
## Remarks
130-
A null value signifies no active session.
131-
132-
]]></format>
133-
</remarks>
122+
<summary>Gets the active session ID.</summary>
123+
<value>The active session ID, or <see langword="null" /> if there is no active session.</value>
124+
<remarks>To be added.</remarks>
134125
</Docs>
135126
</Member>
136127
<Member MemberName="SoapRequestHeader">
@@ -150,15 +141,17 @@
150141
<ReturnType>System.Xml.XmlNode</ReturnType>
151142
</ReturnValue>
152143
<Docs>
153-
<summary>The <see cref="P:System.DirectoryServices.Protocols.DsmlSoapConnection.SoapRequestHeader" /> property contains the SOAP Header attached to outgoing requests.</summary>
144+
<summary>Gets or sets the SOAP Header attached to outgoing requests.</summary>
154145
<value>The SOAP Header attached to outgoing requests.</value>
155146
<remarks>
156147
<format type="text/markdown"><![CDATA[
157148
158-
## Remarks
159-
The API uses <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.BeginSession%2A> and <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.EndSession%2A> to track the lifetime of a session.
149+
## Remarks
150+
151+
The API uses <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.BeginSession%2A> and <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.EndSession%2A> to track the lifetime of a session.
160152
161-
**Caution** Attaching an EndSession header to the <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SoapRequestHeader%2A> causes the API to become inconsistent with the connection and should be avoided.
153+
> [!CAUTION]
154+
> Attaching an `EndSession` header to the <xref:System.DirectoryServices.Protocols.DsmlSoapConnection.SoapRequestHeader%2A> causes the API to become inconsistent with the connection and should be avoided.
162155
163156
]]></format>
164157
</remarks>

0 commit comments

Comments
 (0)