Skip to content

Commit cb11317

Browse files
benrr101benrr101
authored
XML Documentation Fixes - Batch 5 (#2864)
* Batch 5 part 1 * Batch 5 part 2 * Finishing up changes to batch 5 * PR Comments
1 parent bc08543 commit cb11317

13 files changed

Lines changed: 7473 additions & 3900 deletions

File tree

‎doc/snippets/Microsoft.Data.SqlClient/SQLDebugging.xml‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
1-
<docs>
2-
<members name="SQLDebugging">
3-
<SQLDebugging>
4-
<summary>
5-
Included to support debugging applications. Not intended for direct use.
6-
</summary>
7-
<remarks>To be added.</remarks>
8-
</SQLDebugging>
9-
<ctor>
10-
<summary>
11-
Initiates instance of <see cref="T:Microsoft.Data.SqlClient.SQLDebugging"/> class object. Not intended for direct use.
12-
</summary>
13-
<remarks>To be added.</remarks>
14-
</ctor>
15-
</members>
1+
<docs>
2+
<members name="SQLDebugging">
3+
<SQLDebugging>
4+
<summary>
5+
Included to support debugging applications. Not intended for direct use.
6+
</summary>
7+
</SQLDebugging>
8+
<ctor>
9+
<summary>
10+
Initiates instance of <see cref="T:Microsoft.Data.SqlClient.SQLDebugging" /> class object. Not intended for direct use.
11+
</summary>
12+
</ctor>
13+
</members>
1614
</docs>

‎doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml‎

Lines changed: 1920 additions & 1128 deletions
Large diffs are not rendered by default.

‎doc/snippets/Microsoft.Data.SqlClient/SqlDataAdapter.xml‎

Lines changed: 1372 additions & 499 deletions
Large diffs are not rendered by default.

‎doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml‎

Lines changed: 1932 additions & 1231 deletions
Large diffs are not rendered by default.

‎doc/snippets/Microsoft.Data.SqlClient/SqlDependency.xml‎

Lines changed: 304 additions & 256 deletions
Large diffs are not rendered by default.

‎doc/snippets/Microsoft.Data.SqlClient/SqlEnclaveAttestationParameters.xml‎

Lines changed: 47 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,48 @@
1-
<?xml version="1.0"?>
2-
<docs>
3-
<members name="SqlEnclaveAttestationParameters">
4-
<SqlEnclaveAttestationParameters>
5-
<summary>Encapsulates the information SqlClient sends to SQL Server to initiate the process of attesting and creating a secure session with the enclave, SQL Server uses for computations on columns protected using Always Encrypted.</summary>
6-
<remarks>To be added.</remarks>
7-
</SqlEnclaveAttestationParameters>
8-
<ctor>
9-
<param name="protocol">The enclave attestation protocol.</param>
10-
<param name="input">The input of the enclave attestation protocol.</param>
11-
<param name="clientDiffieHellmanKey">A Diffie-Hellman algorithm that encapsulates a client-side key pair.</param>
12-
<summary>Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveAttestationParameters" /> class.</summary>
13-
<remarks>To be added.</remarks>
14-
<exception cref="T:System.ArgumentNullException">
15-
<paramref name="clientDiffieHellmanKey" /> is <see langword="null" />.</exception>
16-
</ctor>
17-
<ClientDiffieHellmanKey>
18-
<summary>Gets a Diffie-Hellman algorithm that encapsulates a key pair that SqlClient uses to establish a secure session with the enclave.</summary>
19-
<value>The Diffie-Hellman algorithm.</value>
20-
<remarks>To be added.</remarks>
21-
</ClientDiffieHellmanKey>
22-
<GetInput>
23-
<summary>Gets the information used to initiate the process of attesting the enclave. The format and the content of this information is specific to the attestation protocol.</summary>
24-
<returns>The information required by SQL Server to execute attestation protocol identified by EnclaveAttestationProtocols.</returns>
25-
<remarks>To be added.</remarks>
26-
</GetInput>
27-
<Protocol>
28-
<summary>Gets the enclave attestation protocol identifier.</summary>
29-
<value>The enclave attestation protocol identifier.</value>
30-
<remarks>To be added.</remarks>
31-
</Protocol>
32-
</members>
1+
<docs>
2+
<members name="SqlEnclaveAttestationParameters">
3+
<SqlEnclaveAttestationParameters>
4+
<summary>
5+
Encapsulates the information SqlClient sends to SQL Server to initiate the process of attesting and creating a secure session with the enclave, SQL Server uses for computations on columns protected using Always Encrypted.
6+
</summary>
7+
</SqlEnclaveAttestationParameters>
8+
<ctor>
9+
<param name="protocol">
10+
The enclave attestation protocol.
11+
</param>
12+
<param name="input">
13+
The input of the enclave attestation protocol.
14+
</param>
15+
<param name="clientDiffieHellmanKey">
16+
A Diffie-Hellman algorithm that encapsulates a client-side key pair.
17+
</param>
18+
<summary>
19+
Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveAttestationParameters" /> class.
20+
</summary>
21+
<exception cref="T:System.ArgumentNullException"><paramref name="clientDiffieHellmanKey" /> is <see langword="null" />.</exception>
22+
</ctor>
23+
<ClientDiffieHellmanKey>
24+
<summary>
25+
Gets a Diffie-Hellman algorithm that encapsulates a key pair that SqlClient uses to establish a secure session with the enclave.
26+
</summary>
27+
<value>
28+
The Diffie-Hellman algorithm.
29+
</value>
30+
</ClientDiffieHellmanKey>
31+
<GetInput>
32+
<summary>
33+
Gets the information used to initiate the process of attesting the enclave. The format and the content of this information is specific to the attestation protocol.
34+
</summary>
35+
<returns>
36+
The information required by SQL Server to execute attestation protocol identified by EnclaveAttestationProtocols.
37+
</returns>
38+
</GetInput>
39+
<Protocol>
40+
<summary>
41+
Gets the enclave attestation protocol identifier.
42+
</summary>
43+
<value>
44+
The enclave attestation protocol identifier.
45+
</value>
46+
</Protocol>
47+
</members>
3348
</docs>

‎doc/snippets/Microsoft.Data.SqlClient/SqlEnclaveSession.xml‎

Lines changed: 37 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,38 @@
1-
<?xml version="1.0"?>
2-
<docs>
3-
<members name="SqlEnclaveSession">
4-
<SqlEnclaveSession>
5-
<summary>Encapsulates the state of a secure session between SqlClient and an enclave inside SQL Server, which can be used for computations on encrypted columns protected with Always Encrypted.</summary>
6-
<remarks>To be added.</remarks>
7-
</SqlEnclaveSession>
8-
<ctor>
9-
<param name="sessionKey">The symmetric key used to encrypt all the information sent using the session.</param>
10-
<param name="sessionId">The session ID.</param>
11-
<summary>Instantiates a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveSession" /> class.</summary>
12-
<remarks>To be added.</remarks>
13-
<exception cref="T:System.ArgumentNullException">
14-
<paramref name="sessionKey" /> is <see langword="null" />.</exception>
15-
<exception cref="T:System.ArgumentException">
16-
<paramref name="sessionKey" /> has zero length.</exception>
17-
</ctor>
18-
<GetSessionKey>
19-
<summary>Gets the symmetric key that SqlClient uses to encrypt all the information it sends to the enclave using the session.</summary>
20-
<returns>The symmetric key.</returns>
21-
<remarks>To be added.</remarks>
22-
</GetSessionKey>
23-
<SessionId>
24-
<summary>Gets the session ID.</summary>
25-
<value>The session ID.</value>
26-
<remarks>To be added.</remarks>
27-
</SessionId>
28-
</members>
1+
<docs>
2+
<members name="SqlEnclaveSession">
3+
<SqlEnclaveSession>
4+
<summary>
5+
Encapsulates the state of a secure session between SqlClient and an enclave inside SQL Server, which can be used for computations on encrypted columns protected with Always Encrypted.
6+
</summary>
7+
</SqlEnclaveSession>
8+
<ctor>
9+
<param name="sessionKey">
10+
The symmetric key used to encrypt all the information sent using the session.
11+
</param>
12+
<param name="sessionId">
13+
The session ID.
14+
</param>
15+
<summary>
16+
Instantiates a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveSession" /> class.
17+
</summary>
18+
<exception cref="T:System.ArgumentNullException"><paramref name="sessionKey" /> is <see langword="null" />.</exception>
19+
<exception cref="T:System.ArgumentException"><paramref name="sessionKey" /> has zero length.</exception>
20+
</ctor>
21+
<GetSessionKey>
22+
<summary>
23+
Gets the symmetric key that SqlClient uses to encrypt all the information it sends to the enclave using the session.
24+
</summary>
25+
<returns>
26+
The symmetric key.
27+
</returns>
28+
</GetSessionKey>
29+
<SessionId>
30+
<summary>
31+
Gets the session ID.
32+
</summary>
33+
<value>
34+
The session ID.
35+
</value>
36+
</SessionId>
37+
</members>
2938
</docs>

0 commit comments

Comments
 (0)