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 3 #2851

Merged
merged 5 commits into from
Sep 16, 2024
Merged

XML Documentation Fixes - Batch 3 #2851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e9d19f6
Batch 3
benrr101 Sep 5, 2024
48ae86d
Fixing issue from last PR
benrr101 Sep 10, 2024
63deb98
Making sure everything is ready for PR (left off at sqlcommand.xml)
benrr101 Sep 11, 2024
43e8bb8
Finishing up work for batch 3
benrr101 Sep 11, 2024
c2e86f8
PR comments
benrr101 Sep 13, 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
4 changes: 2 additions & 2 deletions doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<docs>
<docs>
<members name="SqlBatchCommandCollection">
<SqlBatchCommandCollection>
<summary>
Expand Down Expand Up @@ -95,7 +95,7 @@
</Remove1>
<Remove2>
<param name="item">
The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" /> .
The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.
</param>
<summary>
Removes the specified <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> object from the collection.
Expand Down
2 changes: 1 addition & 1 deletion doc/snippets/Microsoft.Data.SqlClient/SqlClientDiagnostic.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<docs>
<docs>
<members name="SqlClientDiagnostic">
<SqlClientDiagnostic>
<summary>Class that provides strongly-typed collection of key-value pairs for SqlClient diagnostic objects.</summary>
Expand Down
127 changes: 82 additions & 45 deletions doc/snippets/Microsoft.Data.SqlClient/SqlClientLogger.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,84 @@
<docs>
<members name="SqlClientLogger">
<SqlClientLogger>
<summary>Represents a SQL client logger.</summary>
<remarks>To be added.</remarks>
</SqlClientLogger>
<ctor>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlClientLogger" /> class.</summary>
<remarks>To be added.</remarks>
</ctor>
<IsLoggingEnabled>
<summary>Gets a value that indicates whether bid tracing is enabled.</summary>
<value>
<see langword="true" /> if bid tracing is enabled; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</IsLoggingEnabled>
<LogAssert>
<param name="value"><see langword="false" /> to log the message; otherwise, <see langword="true" />.</param>
<param name="type">The type to be logged.</param>
<param name="method">The logging method.</param>
<param name="message">The message to be logged.</param>
<summary>Logs the specified message if <paramref name="value" /> is <see langword="false" />.</summary>
<returns><see langword="true" /> if the message is not logged; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</LogAssert>
<LogError>
<param name="type">The type to be logged.</param>
<param name="method">The logging method.</param>
<param name="message">The message to be logged.</param>
<summary>Logs an error through a specified method of the current instance type.</summary>
<remarks>To be added.</remarks>
</LogError>
<LogInfo>
<param name="type">The type to be logged.</param>
<param name="method">The logging method.</param>
<param name="message">The message to be logged.</param>
<summary>Logs information through a specified method of the current instance type.</summary>
<remarks>To be added.</remarks>
</LogInfo>
<LogWarning>
<param name="type">The type to be logged.</param>
<param name="method">The logging method.</param>
<param name="message">The message to be logged.</param>
<summary>Logs warning through a specified method of the current instance type.</summary>
</LogWarning>
</members>
<members name="SqlClientLogger">
<SqlClientLogger>
<summary>
Represents a SQL client logger.
</summary>
</SqlClientLogger>
<ctor>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlClientLogger" /> class.
</summary>
</ctor>
<IsLoggingEnabled>
<summary>
Gets a value that indicates whether bid tracing is enabled.
</summary>
<value>
<see langword="true" /> if bid tracing is enabled; otherwise, <see langword="false" />.
</value>
</IsLoggingEnabled>
<LogAssert>
<param name="value">
<see langword="false" /> to log the message; otherwise, <see langword="true" />.
</param>
<param name="type">
The type to be logged.
</param>
<param name="method">
The logging method.
</param>
<param name="message">
The message to be logged.
</param>
<summary>
Logs the specified message if <paramref name="value" /> is <see langword="false" />.
</summary>
<returns>
<see langword="true" /> if the message is not logged; otherwise, <see langword="false" />.
</returns>
</LogAssert>
<LogError>
<param name="type">
The type to be logged.
</param>
<param name="method">
The logging method.
</param>
<param name="message">
The message to be logged.
</param>
<summary>
Logs an error through a specified method of the current instance type.
</summary>
</LogError>
<LogInfo>
<param name="type">
The type to be logged.
</param>
<param name="method">
The logging method.
</param>
<param name="message">
The message to be logged.
</param>
<summary>
Logs information through a specified method of the current instance type.
</summary>
</LogInfo>
<LogWarning>
<param name="type">
The type to be logged.
</param>
<param name="method">
The logging method.
</param>
<param name="message">
The message to be logged.
</param>
<summary>
Logs warning through a specified method of the current instance type.
</summary>
</LogWarning>
</members>
</docs>
148 changes: 82 additions & 66 deletions doc/snippets/Microsoft.Data.SqlClient/SqlClientMetaDataCollectionNames.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,68 +1,84 @@
<docs>
<members name="SqlClientMetaDataCollectionNames">
<SqlClientMetaDataCollectionNames>
<summary>Provides a list of constants for use with the **GetSchema** method to retrieve metadata collections.</summary>
<remarks>To be added.</remarks>
</SqlClientMetaDataCollectionNames>
<Columns>
<summary>A constant for use with the **GetSchema** method that represents the **Columns** collection.</summary>
<remarks>To be added.</remarks>
</Columns>
<Databases>
<summary>A constant for use with the **GetSchema** method that represents the **Databases** collection.</summary>
<remarks>To be added.</remarks>
</Databases>
<ForeignKeys>
<summary>A constant for use with the **GetSchema** method that represents the **ForeignKeys** collection.</summary>
<remarks>To be added.</remarks>
</ForeignKeys>
<IndexColumns>
<summary>A constant for use with the **GetSchema** method that represents the **IndexColumns** collection.</summary>
<remarks>To be added.</remarks>
</IndexColumns>
<Indexes>
<summary>A constant for use with the **GetSchema** method that represents the **Indexes** collection.</summary>
<remarks>To be added.</remarks>
</Indexes>
<ProcedureParameters>
<summary>A constant for use with the **GetSchema** method that represents the **ProcedureParameters** collection.</summary>
<remarks>To be added.</remarks>
</ProcedureParameters>
<Procedures>
<summary>A constant for use with the **GetSchema** method that represents the **Procedures** collection.</summary>
<remarks>To be added.</remarks>
</Procedures>
<Tables>
<summary>A constant for use with the **GetSchema** method that represents the **Tables** collection.</summary>
<remarks>To be added.</remarks>
</Tables>
<UserDefinedTypes>
<summary>A constant for use with the **GetSchema** method that represents the **UserDefinedTypes** collection.</summary>
<remarks>To be added.</remarks>
</UserDefinedTypes>
<Users>
<summary>A constant for use with the **GetSchema** method that represents the **Users** collection.</summary>
<remarks>To be added.</remarks>
</Users>
<ViewColumns>
<summary>A constant for use with the **GetSchema** method that represents the **ViewColumns** collection.</summary>
<remarks>To be added.</remarks>
</ViewColumns>
<Views>
<summary>A constant for use with the **GetSchema** method that represents the **Views** collection.</summary>
<remarks>To be added.</remarks>
</Views>
<AllColumns>
<summary>A constant for use with the **GetSchema** method that represents the **AllColumns** collection.</summary>
<remarks>To be added.</remarks>
</AllColumns>
<ColumnSetColumns>
<summary>A constant for use with the **GetSchema** method that represents the **ColumnSetColumns** collection.</summary>
<remarks>To be added.</remarks>
</ColumnSetColumns>
<StructuredTypeMembers>
<summary>A constant for use with the **GetSchema** method that represents the **StructuredTypeMembers** collection.</summary>
<remarks>To be added.</remarks>
</StructuredTypeMembers>
</members>
<members name="SqlClientMetaDataCollectionNames">
<SqlClientMetaDataCollectionNames>
<summary>
Provides a list of constants for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method to retrieve metadata collections.
</summary>
</SqlClientMetaDataCollectionNames>
<Columns>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Columns</b> collection.
</summary>
</Columns>
<Databases>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Databases</b> collection.
</summary>
</Databases>
<ForeignKeys>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ForeignKeys</b> collection.
</summary>
</ForeignKeys>
<IndexColumns>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>IndexColumns</b> collection.
</summary>
</IndexColumns>
<Indexes>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Indexes</b> collection.
</summary>
</Indexes>
<ProcedureParameters>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ProcedureParameters</b> collection.
</summary>
</ProcedureParameters>
<Procedures>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Procedures</b> collection.
</summary>
</Procedures>
<Tables>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Tables</b> collection.
</summary>
</Tables>
<UserDefinedTypes>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>UserDefinedTypes</b> collection.
</summary>
</UserDefinedTypes>
<Users>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Users</b> collection.
</summary>
</Users>
<ViewColumns>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ViewColumns</b> collection.
</summary>
</ViewColumns>
<Views>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Views</b> collection.
</summary>
</Views>
<AllColumns>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>AllColumns</b> collection.
</summary>
</AllColumns>
<ColumnSetColumns>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ColumnSetColumns</b> collection.
</summary>
</ColumnSetColumns>
<StructuredTypeMembers>
<summary>
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>StructuredTypeMembers</b> collection.
</summary>
</StructuredTypeMembers>
</members>
</docs>
Loading
Loading