Skip to content

Commit 68a5be4

Browse files
benrr101benrr101
authoredSep 16, 2024
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
1 parent 321080e commit 68a5be4

14 files changed

+5135
-3700
lines changed
 

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<docs>
1+
<docs>
22
<members name="SqlBatchCommandCollection">
33
<SqlBatchCommandCollection>
44
<summary>
@@ -95,7 +95,7 @@
9595
</Remove1>
9696
<Remove2>
9797
<param name="item">
98-
The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" /> .
98+
The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.
9999
</param>
100100
<summary>
101101
Removes the specified <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> object from the collection.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<docs>
1+
<docs>
22
<members name="SqlClientDiagnostic">
33
<SqlClientDiagnostic>
44
<summary>Class that provides strongly-typed collection of key-value pairs for SqlClient diagnostic objects.</summary>

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

+82-45
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,84 @@
11
<docs>
2-
<members name="SqlClientLogger">
3-
<SqlClientLogger>
4-
<summary>Represents a SQL client logger.</summary>
5-
<remarks>To be added.</remarks>
6-
</SqlClientLogger>
7-
<ctor>
8-
<summary>Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlClientLogger" /> class.</summary>
9-
<remarks>To be added.</remarks>
10-
</ctor>
11-
<IsLoggingEnabled>
12-
<summary>Gets a value that indicates whether bid tracing is enabled.</summary>
13-
<value>
14-
<see langword="true" /> if bid tracing is enabled; otherwise, <see langword="false" />.</value>
15-
<remarks>To be added.</remarks>
16-
</IsLoggingEnabled>
17-
<LogAssert>
18-
<param name="value"><see langword="false" /> to log the message; otherwise, <see langword="true" />.</param>
19-
<param name="type">The type to be logged.</param>
20-
<param name="method">The logging method.</param>
21-
<param name="message">The message to be logged.</param>
22-
<summary>Logs the specified message if <paramref name="value" /> is <see langword="false" />.</summary>
23-
<returns><see langword="true" /> if the message is not logged; otherwise, <see langword="false" />.</returns>
24-
<remarks>To be added.</remarks>
25-
</LogAssert>
26-
<LogError>
27-
<param name="type">The type to be logged.</param>
28-
<param name="method">The logging method.</param>
29-
<param name="message">The message to be logged.</param>
30-
<summary>Logs an error through a specified method of the current instance type.</summary>
31-
<remarks>To be added.</remarks>
32-
</LogError>
33-
<LogInfo>
34-
<param name="type">The type to be logged.</param>
35-
<param name="method">The logging method.</param>
36-
<param name="message">The message to be logged.</param>
37-
<summary>Logs information through a specified method of the current instance type.</summary>
38-
<remarks>To be added.</remarks>
39-
</LogInfo>
40-
<LogWarning>
41-
<param name="type">The type to be logged.</param>
42-
<param name="method">The logging method.</param>
43-
<param name="message">The message to be logged.</param>
44-
<summary>Logs warning through a specified method of the current instance type.</summary>
45-
</LogWarning>
46-
</members>
2+
<members name="SqlClientLogger">
3+
<SqlClientLogger>
4+
<summary>
5+
Represents a SQL client logger.
6+
</summary>
7+
</SqlClientLogger>
8+
<ctor>
9+
<summary>
10+
Initializes a new instance of the <see cref="T:Microsoft.Data.SqlClient.SqlClientLogger" /> class.
11+
</summary>
12+
</ctor>
13+
<IsLoggingEnabled>
14+
<summary>
15+
Gets a value that indicates whether bid tracing is enabled.
16+
</summary>
17+
<value>
18+
<see langword="true" /> if bid tracing is enabled; otherwise, <see langword="false" />.
19+
</value>
20+
</IsLoggingEnabled>
21+
<LogAssert>
22+
<param name="value">
23+
<see langword="false" /> to log the message; otherwise, <see langword="true" />.
24+
</param>
25+
<param name="type">
26+
The type to be logged.
27+
</param>
28+
<param name="method">
29+
The logging method.
30+
</param>
31+
<param name="message">
32+
The message to be logged.
33+
</param>
34+
<summary>
35+
Logs the specified message if <paramref name="value" /> is <see langword="false" />.
36+
</summary>
37+
<returns>
38+
<see langword="true" /> if the message is not logged; otherwise, <see langword="false" />.
39+
</returns>
40+
</LogAssert>
41+
<LogError>
42+
<param name="type">
43+
The type to be logged.
44+
</param>
45+
<param name="method">
46+
The logging method.
47+
</param>
48+
<param name="message">
49+
The message to be logged.
50+
</param>
51+
<summary>
52+
Logs an error through a specified method of the current instance type.
53+
</summary>
54+
</LogError>
55+
<LogInfo>
56+
<param name="type">
57+
The type to be logged.
58+
</param>
59+
<param name="method">
60+
The logging method.
61+
</param>
62+
<param name="message">
63+
The message to be logged.
64+
</param>
65+
<summary>
66+
Logs information through a specified method of the current instance type.
67+
</summary>
68+
</LogInfo>
69+
<LogWarning>
70+
<param name="type">
71+
The type to be logged.
72+
</param>
73+
<param name="method">
74+
The logging method.
75+
</param>
76+
<param name="message">
77+
The message to be logged.
78+
</param>
79+
<summary>
80+
Logs warning through a specified method of the current instance type.
81+
</summary>
82+
</LogWarning>
83+
</members>
4784
</docs>

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

+82-66
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,84 @@
11
<docs>
2-
<members name="SqlClientMetaDataCollectionNames">
3-
<SqlClientMetaDataCollectionNames>
4-
<summary>Provides a list of constants for use with the **GetSchema** method to retrieve metadata collections.</summary>
5-
<remarks>To be added.</remarks>
6-
</SqlClientMetaDataCollectionNames>
7-
<Columns>
8-
<summary>A constant for use with the **GetSchema** method that represents the **Columns** collection.</summary>
9-
<remarks>To be added.</remarks>
10-
</Columns>
11-
<Databases>
12-
<summary>A constant for use with the **GetSchema** method that represents the **Databases** collection.</summary>
13-
<remarks>To be added.</remarks>
14-
</Databases>
15-
<ForeignKeys>
16-
<summary>A constant for use with the **GetSchema** method that represents the **ForeignKeys** collection.</summary>
17-
<remarks>To be added.</remarks>
18-
</ForeignKeys>
19-
<IndexColumns>
20-
<summary>A constant for use with the **GetSchema** method that represents the **IndexColumns** collection.</summary>
21-
<remarks>To be added.</remarks>
22-
</IndexColumns>
23-
<Indexes>
24-
<summary>A constant for use with the **GetSchema** method that represents the **Indexes** collection.</summary>
25-
<remarks>To be added.</remarks>
26-
</Indexes>
27-
<ProcedureParameters>
28-
<summary>A constant for use with the **GetSchema** method that represents the **ProcedureParameters** collection.</summary>
29-
<remarks>To be added.</remarks>
30-
</ProcedureParameters>
31-
<Procedures>
32-
<summary>A constant for use with the **GetSchema** method that represents the **Procedures** collection.</summary>
33-
<remarks>To be added.</remarks>
34-
</Procedures>
35-
<Tables>
36-
<summary>A constant for use with the **GetSchema** method that represents the **Tables** collection.</summary>
37-
<remarks>To be added.</remarks>
38-
</Tables>
39-
<UserDefinedTypes>
40-
<summary>A constant for use with the **GetSchema** method that represents the **UserDefinedTypes** collection.</summary>
41-
<remarks>To be added.</remarks>
42-
</UserDefinedTypes>
43-
<Users>
44-
<summary>A constant for use with the **GetSchema** method that represents the **Users** collection.</summary>
45-
<remarks>To be added.</remarks>
46-
</Users>
47-
<ViewColumns>
48-
<summary>A constant for use with the **GetSchema** method that represents the **ViewColumns** collection.</summary>
49-
<remarks>To be added.</remarks>
50-
</ViewColumns>
51-
<Views>
52-
<summary>A constant for use with the **GetSchema** method that represents the **Views** collection.</summary>
53-
<remarks>To be added.</remarks>
54-
</Views>
55-
<AllColumns>
56-
<summary>A constant for use with the **GetSchema** method that represents the **AllColumns** collection.</summary>
57-
<remarks>To be added.</remarks>
58-
</AllColumns>
59-
<ColumnSetColumns>
60-
<summary>A constant for use with the **GetSchema** method that represents the **ColumnSetColumns** collection.</summary>
61-
<remarks>To be added.</remarks>
62-
</ColumnSetColumns>
63-
<StructuredTypeMembers>
64-
<summary>A constant for use with the **GetSchema** method that represents the **StructuredTypeMembers** collection.</summary>
65-
<remarks>To be added.</remarks>
66-
</StructuredTypeMembers>
67-
</members>
2+
<members name="SqlClientMetaDataCollectionNames">
3+
<SqlClientMetaDataCollectionNames>
4+
<summary>
5+
Provides a list of constants for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method to retrieve metadata collections.
6+
</summary>
7+
</SqlClientMetaDataCollectionNames>
8+
<Columns>
9+
<summary>
10+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Columns</b> collection.
11+
</summary>
12+
</Columns>
13+
<Databases>
14+
<summary>
15+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Databases</b> collection.
16+
</summary>
17+
</Databases>
18+
<ForeignKeys>
19+
<summary>
20+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ForeignKeys</b> collection.
21+
</summary>
22+
</ForeignKeys>
23+
<IndexColumns>
24+
<summary>
25+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>IndexColumns</b> collection.
26+
</summary>
27+
</IndexColumns>
28+
<Indexes>
29+
<summary>
30+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Indexes</b> collection.
31+
</summary>
32+
</Indexes>
33+
<ProcedureParameters>
34+
<summary>
35+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ProcedureParameters</b> collection.
36+
</summary>
37+
</ProcedureParameters>
38+
<Procedures>
39+
<summary>
40+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Procedures</b> collection.
41+
</summary>
42+
</Procedures>
43+
<Tables>
44+
<summary>
45+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Tables</b> collection.
46+
</summary>
47+
</Tables>
48+
<UserDefinedTypes>
49+
<summary>
50+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>UserDefinedTypes</b> collection.
51+
</summary>
52+
</UserDefinedTypes>
53+
<Users>
54+
<summary>
55+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Users</b> collection.
56+
</summary>
57+
</Users>
58+
<ViewColumns>
59+
<summary>
60+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ViewColumns</b> collection.
61+
</summary>
62+
</ViewColumns>
63+
<Views>
64+
<summary>
65+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>Views</b> collection.
66+
</summary>
67+
</Views>
68+
<AllColumns>
69+
<summary>
70+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>AllColumns</b> collection.
71+
</summary>
72+
</AllColumns>
73+
<ColumnSetColumns>
74+
<summary>
75+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>ColumnSetColumns</b> collection.
76+
</summary>
77+
</ColumnSetColumns>
78+
<StructuredTypeMembers>
79+
<summary>
80+
A constant for use with the <see cref="M:Microsoft.Data.SqlClient.SqlConnection.GetSchema(System.String)" /> method that represents the <b>StructuredTypeMembers</b> collection.
81+
</summary>
82+
</StructuredTypeMembers>
83+
</members>
6884
</docs>

0 commit comments

Comments
 (0)