Skip to content

Commit b3b9c85

Browse files
authored
Automatically port some comments from System.Data (#3968)
* Automatically port some comments from System.Data * Suggestions by David-Engel
1 parent 5eee564 commit b3b9c85

File tree

6 files changed

+323
-36
lines changed

6 files changed

+323
-36
lines changed

xml/System.Data.SqlClient/SqlBulkCopy.xml

Lines changed: 23 additions & 15 deletions
Large diffs are not rendered by default.

xml/System.Data.SqlClient/SqlConnection.xml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -887,7 +887,7 @@ End Module
887887
<param name="connectionString">The connection string that contains enough information to connect to a server. The connection string should not use any of the following connection string keywords: <see langword="Integrated Security = true" />, <see langword="UserId" />, or <see langword="Password" />; or <see langword="ContextConnection = true" />.</param>
888888
<param name="credential">A <see cref="T:System.Data.SqlClient.SqlCredential" /> object.</param>
889889
<param name="newPassword">The new password.<paramref name="newPassword" /> must be read only. The password must also comply with any password security policy set on the server (for example, minimum length and requirements for specific characters).</param>
890-
<param name="newSecurePassword">To be added.</param>
890+
<param name="newSecurePassword">The new password. <paramref name="newSecurePassword" /> must be read only. The password must also comply with any password security policy set on the server (for example, minimum length and requirements for specific characters).</param>
891891
<summary>Changes the SQL Server password for the user indicated in the <see cref="T:System.Data.SqlClient.SqlCredential" /> object.</summary>
892892
<remarks>To be added.</remarks>
893893
<exception cref="T:System.ArgumentException">The connection string contains any combination of <see langword="UserId" />, <see langword="Password" />, or <see langword="Integrated Security=true" />.
@@ -2657,7 +2657,19 @@ class Program {
26572657
<Docs>
26582658
<param name="customProviders">The custom providers</param>
26592659
<summary>Registers the column encryption key store providers.</summary>
2660-
<remarks>To be added.</remarks>
2660+
<remarks>
2661+
<format type="text/markdown"><![CDATA[
2662+
2663+
## Example
2664+
2665+
```csharp
2666+
Dictionary<string, SqlColumnEncryptionKeyStoreProvider> customKeyStoreProviders = new Dictionary<string, SqlColumnEncryptionKeyStoreProvider>();
2667+
MySqlClientHSMProvider myProvider = new MySqlClientHSMProvider();
2668+
customKeyStoreProviders.Add(@"HSM Provider", myProvider);
2669+
SqlConnection.RegisterColumnEncryptionKeyStoreProviders(customKeyStoreProviders)
2670+
```
2671+
]]></format>
2672+
</remarks>
26612673
</Docs>
26622674
</Member>
26632675
<Member MemberName="ResetStatistics">

xml/System.Data.SqlClient/SqlDataReader.xml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1092,7 +1092,17 @@ This method is an implementation of <xref:System.Data.Common.IDbColumnSchemaGene
10921092
<param name="i">The zero-based column ordinal.</param>
10931093
<summary>Gets the <see cref="T:System.Type" /> that is the data type of the object.</summary>
10941094
<returns>The <see cref="T:System.Type" /> that is the data type of the object. If the type does not exist on the client, in the case of a User-Defined Type (UDT) returned from the database, **GetFieldType** returns null.</returns>
1095-
<remarks>To be added.</remarks>
1095+
<remarks>
1096+
<format type="text/markdown"><![CDATA[
1097+
1098+
## Remarks
1099+
1100+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Data.SqlClient.SqlDataReader> instance is cast to an <xref:System.Data.IDataRecord> interface.
1101+
1102+
This information can be used to increase performance by indicating the strongly-typed accessor to call. (for example, using `GetInt32` is roughly ten times faster than using `GetValue`.)
1103+
1104+
]]></format>
1105+
</remarks>
10961106
<related type="Article" href="~/docs/framework/data/adonet/dataadapters-and-datareaders.md">DataAdapters and DataReaders (ADO.NET)</related>
10971107
<related type="Article" href="~/docs/framework/data/adonet/sql/index.md">SQL Server and ADO.NET</related>
10981108
<related type="Article" href="~/docs/framework/data/adonet/ado-net-overview.md">ADO.NET Overview</related>

0 commit comments

Comments
 (0)