-
Notifications
You must be signed in to change notification settings - Fork 292
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
XML Documentation Fixes - Batch 3 (#2851)
* Batch 3 * Fixing issue from last PR * Making sure everything is ready for PR (left off at sqlcommand.xml) * Finishing up work for batch 3 * PR comments
- Loading branch information
Showing
14 changed files
with
5,135 additions
and
3,700 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
127 changes: 82 additions & 45 deletions
127
doc/snippets/Microsoft.Data.SqlClient/SqlClientLogger.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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
148
doc/snippets/Microsoft.Data.SqlClient/SqlClientMetaDataCollectionNames.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> |
Oops, something went wrong.