Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XML Documentation Fixes - Batch 5 #2864

Merged
merged 4 commits into from
Sep 20, 2024
Merged

XML Documentation Fixes - Batch 5 #2864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fb009b1
Batch 5 part 1
benrr101 Sep 10, 2024
18437cc
Batch 5 part 2
benrr101 Sep 10, 2024
cd26c0f
Finishing up changes to batch 5
benrr101 Sep 12, 2024
a1c66d7
PR Comments
benrr101 Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions doc/snippets/Microsoft.Data.SqlClient/SQLDebugging.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
<docs>
<members name="SQLDebugging">
<SQLDebugging>
<summary>
Included to support debugging applications. Not intended for direct use.
</summary>
<remarks>To be added.</remarks>
</SQLDebugging>
<ctor>
<summary>
Initiates instance of <see cref="T:Microsoft.Data.SqlClient.SQLDebugging"/> class object. Not intended for direct use.
</summary>
<remarks>To be added.</remarks>
</ctor>
</members>
<docs>
<members name="SQLDebugging">
<SQLDebugging>
<summary>
Included to support debugging applications. Not intended for direct use.
</summary>
</SQLDebugging>
<ctor>
<summary>
Initiates instance of <see cref="T:Microsoft.Data.SqlClient.SQLDebugging" /> class object. Not intended for direct use.
</summary>
</ctor>
</members>
</docs>
3,048 changes: 1,920 additions & 1,128 deletions doc/snippets/Microsoft.Data.SqlClient/SqlConnectionStringBuilder.xml
View file
Open in desktop

Large diffs are not rendered by default.

1,871 changes: 1,372 additions & 499 deletions doc/snippets/Microsoft.Data.SqlClient/SqlDataAdapter.xml
View file
Open in desktop

Large diffs are not rendered by default.

3,163 changes: 1,932 additions & 1,231 deletions doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml
View file
Open in desktop

Large diffs are not rendered by default.

560 changes: 304 additions & 256 deletions doc/snippets/Microsoft.Data.SqlClient/SqlDependency.xml
View file
Open in desktop

Large diffs are not rendered by default.

79 changes: 47 additions & 32 deletions doc/snippets/Microsoft.Data.SqlClient/SqlEnclaveAttestationParameters.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,48 @@
<?xml version="1.0"?>
<docs>
<members name="SqlEnclaveAttestationParameters">
<SqlEnclaveAttestationParameters>
<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>
<remarks>To be added.</remarks>
</SqlEnclaveAttestationParameters>
<ctor>
<param name="protocol">The enclave attestation protocol.</param>
<param name="input">The input of the enclave attestation protocol.</param>
<param name="clientDiffieHellmanKey">A Diffie-Hellman algorithm that encapsulates a client-side key pair.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveAttestationParameters" /> class.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="clientDiffieHellmanKey" /> is <see langword="null" />.</exception>
</ctor>
<ClientDiffieHellmanKey>
<summary>Gets a Diffie-Hellman algorithm that encapsulates a key pair that SqlClient uses to establish a secure session with the enclave.</summary>
<value>The Diffie-Hellman algorithm.</value>
<remarks>To be added.</remarks>
</ClientDiffieHellmanKey>
<GetInput>
<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>
<returns>The information required by SQL Server to execute attestation protocol identified by EnclaveAttestationProtocols.</returns>
<remarks>To be added.</remarks>
</GetInput>
<Protocol>
<summary>Gets the enclave attestation protocol identifier.</summary>
<value>The enclave attestation protocol identifier.</value>
<remarks>To be added.</remarks>
</Protocol>
</members>
<docs>
<members name="SqlEnclaveAttestationParameters">
<SqlEnclaveAttestationParameters>
<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>
</SqlEnclaveAttestationParameters>
<ctor>
<param name="protocol">
The enclave attestation protocol.
</param>
<param name="input">
The input of the enclave attestation protocol.
</param>
<param name="clientDiffieHellmanKey">
A Diffie-Hellman algorithm that encapsulates a client-side key pair.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveAttestationParameters" /> class.
</summary>
<exception cref="T:System.ArgumentNullException"><paramref name="clientDiffieHellmanKey" /> is <see langword="null" />.</exception>
</ctor>
<ClientDiffieHellmanKey>
<summary>
Gets a Diffie-Hellman algorithm that encapsulates a key pair that SqlClient uses to establish a secure session with the enclave.
</summary>
<value>
The Diffie-Hellman algorithm.
</value>
</ClientDiffieHellmanKey>
<GetInput>
<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>
<returns>
The information required by SQL Server to execute attestation protocol identified by EnclaveAttestationProtocols.
</returns>
</GetInput>
<Protocol>
<summary>
Gets the enclave attestation protocol identifier.
</summary>
<value>
The enclave attestation protocol identifier.
</value>
</Protocol>
</members>
</docs>
65 changes: 37 additions & 28 deletions doc/snippets/Microsoft.Data.SqlClient/SqlEnclaveSession.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,38 @@
<?xml version="1.0"?>
<docs>
<members name="SqlEnclaveSession">
<SqlEnclaveSession>
<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>
<remarks>To be added.</remarks>
</SqlEnclaveSession>
<ctor>
<param name="sessionKey">The symmetric key used to encrypt all the information sent using the session.</param>
<param name="sessionId">The session ID.</param>
<summary>Instantiates a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveSession" /> class.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="sessionKey" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="sessionKey" /> has zero length.</exception>
</ctor>
<GetSessionKey>
<summary>Gets the symmetric key that SqlClient uses to encrypt all the information it sends to the enclave using the session.</summary>
<returns>The symmetric key.</returns>
<remarks>To be added.</remarks>
</GetSessionKey>
<SessionId>
<summary>Gets the session ID.</summary>
<value>The session ID.</value>
<remarks>To be added.</remarks>
</SessionId>
</members>
<docs>
<members name="SqlEnclaveSession">
<SqlEnclaveSession>
<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>
</SqlEnclaveSession>
<ctor>
<param name="sessionKey">
The symmetric key used to encrypt all the information sent using the session.
</param>
<param name="sessionId">
The session ID.
</param>
<summary>
Instantiates a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlEnclaveSession" /> class.
</summary>
<exception cref="T:System.ArgumentNullException"><paramref name="sessionKey" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException"><paramref name="sessionKey" /> has zero length.</exception>
</ctor>
<GetSessionKey>
<summary>
Gets the symmetric key that SqlClient uses to encrypt all the information it sends to the enclave using the session.
</summary>
<returns>
The symmetric key.
</returns>
</GetSessionKey>
<SessionId>
<summary>
Gets the session ID.
</summary>
<value>
The session ID.
</value>
</SessionId>
</members>
</docs>
Loading