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.

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
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Batch 5 part 2
  • Loading branch information
benrr101 committed Sep 16, 2024
commit 18437ccc66ab10d9f6e67e77ee3298687a5e7e0a
9 changes: 1 addition & 8 deletions doc/snippets/Microsoft.Data.SqlClient/SQLDebugging.xml
Original file line number Diff line number Diff line change
@@ -1,21 +1,14 @@

<docs>
<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>
179 changes: 102 additions & 77 deletions doc/snippets/Microsoft.Data.SqlClient/SqlDataReader.xml

Large diffs are not rendered by default.

161 changes: 86 additions & 75 deletions doc/snippets/Microsoft.Data.SqlClient/SqlDependency.xml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@

<docs>
<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">
Expand All @@ -22,9 +18,6 @@
<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>
Expand All @@ -45,9 +38,6 @@
<returns>
The information required by SQL Server to execute attestation protocol identified by EnclaveAttestationProtocols.
</returns>
<remarks>
To be added.
</remarks>
</GetInput>
<Protocol>
<summary>
Expand All @@ -56,9 +46,6 @@
<value>
The enclave attestation protocol identifier.
</value>
<remarks>
To be added.
</remarks>
</Protocol>
</members>
</docs>
19 changes: 3 additions & 16 deletions doc/snippets/Microsoft.Data.SqlClient/SqlEnclaveSession.xml
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@

<docs>
<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">
Expand All @@ -19,11 +15,8 @@
<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>
<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>
Expand All @@ -32,9 +25,6 @@
<returns>
The symmetric key.
</returns>
<remarks>
To be added.
</remarks>
</GetSessionKey>
<SessionId>
<summary>
Expand All @@ -43,9 +33,6 @@
<value>
The session ID.
</value>
<remarks>
To be added.
</remarks>
</SessionId>
</members>
</docs>
760 changes: 543 additions & 217 deletions doc/snippets/Microsoft.Data.SqlClient/SqlError.xml

Large diffs are not rendered by default.

Loading