Skip to content

Commit 583c474

Browse files
authored
Remove .NET Framework remarks (System.Data*) (#12634)
1 parent f590494 commit 583c474

48 files changed

Lines changed: 229 additions & 438 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

xml/System.Data.Common/DBDataPermission.xml

Lines changed: 9 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -247,14 +247,7 @@
247247
<param name="allowBlankPassword">
248248
<see langword="true" /> to indicate that a blank password is allowed; otherwise, <see langword="false" />.</param>
249249
<summary>Initializes a new instance of the <see langword="DBDataPermission" /> class with the specified <see cref="T:System.Security.Permissions.PermissionState" /> value, and a value indicating whether a blank password is allowed.</summary>
250-
<remarks>
251-
<format type="text/markdown"><![CDATA[
252-
253-
## Remarks
254-
The <xref:System.Security.Permissions.PermissionState> enumeration takes precedence over the <xref:System.Data.Common.DBDataPermission.AllowBlankPassword> property. Therefore, if you set <xref:System.Data.Common.DBDataPermission.AllowBlankPassword*> to `false`, you must also set <xref:System.Security.Permissions.PermissionState> to `None` to prevent a user from making a connection using a blank password.
255-
256-
]]></format>
257-
</remarks>
250+
<remarks>To be added.</remarks>
258251
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
259252
</Docs>
260253
</Member>
@@ -298,22 +291,7 @@
298291
<param name="restrictions">String that identifies connection string parameters that are allowed or disallowed.</param>
299292
<param name="behavior">One of the <see cref="T:System.Data.KeyRestrictionBehavior" /> properties.</param>
300293
<summary>Adds access for the specified connection string to the existing state of the <see langword="DBDataPermission" />.</summary>
301-
<remarks>
302-
<format type="text/markdown"><![CDATA[
303-
304-
## Remarks
305-
This method can be useful when implementing:
306-
307-
- A .NET framework data provider.
308-
309-
- An API that must assert for data access permission.
310-
311-
- An administrative tool or installation program that must modify security policy.
312-
313-
- When more than one rule is specified, the more restrictive rule is selected.
314-
315-
]]></format>
316-
</remarks>
294+
<remarks>To be added.</remarks>
317295
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
318296
</Docs>
319297
</Member>
@@ -351,14 +329,7 @@
351329
<summary>Gets a value indicating whether a blank password is allowed.</summary>
352330
<value>
353331
<see langword="true" /> if a blank password is allowed, otherwise, <see langword="false" />.</value>
354-
<remarks>
355-
<format type="text/markdown"><![CDATA[
356-
357-
## Remarks
358-
The <xref:System.Security.Permissions.PermissionState> enumeration takes precedence over the <xref:System.Data.Common.DBDataPermission.AllowBlankPassword> property. Therefore, if you set <xref:System.Data.Common.DBDataPermission.AllowBlankPassword*> to `false`, you must also set <xref:System.Security.Permissions.PermissionState> to `None` to prevent a user from making a connection using a blank password.
359-
360-
]]></format>
361-
</remarks>
332+
<remarks>To be added.</remarks>
362333
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
363334
</Docs>
364335
</Member>
@@ -433,14 +404,7 @@
433404
<Docs>
434405
<summary>Creates and returns an identical copy of the current permission object.</summary>
435406
<returns>A copy of the current permission object.</returns>
436-
<remarks>
437-
<format type="text/markdown"><![CDATA[
438-
439-
## Remarks
440-
A copy of a permission object represents the same access to resources as the original permission object.
441-
442-
]]></format>
443-
</remarks>
407+
<remarks>To be added.</remarks>
444408
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
445409
</Docs>
446410
</Member>
@@ -518,14 +482,7 @@
518482
<Docs>
519483
<param name="securityElement">The XML encoding to use to reconstruct the security object.</param>
520484
<summary>Reconstructs a security object with a specified state from an XML encoding.</summary>
521-
<remarks>
522-
<format type="text/markdown"><![CDATA[
523-
524-
## Remarks
525-
Custom code that extends security objects needs to implement the `ToXml` and `FromXml` methods to make the objects security encodable.
526-
527-
]]></format>
528-
</remarks>
485+
<remarks>To be added.</remarks>
529486
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
530487
</Docs>
531488
</Member>
@@ -566,14 +523,7 @@
566523
<param name="target">A permission object to intersect with the current permission object. It must be of the same type as the current permission object.</param>
567524
<summary>Returns a new permission object representing the intersection of the current permission object and the specified permission object.</summary>
568525
<returns>A new permission object that represents the intersection of the current permission object and the specified permission object. This new permission object is a null reference (<see langword="Nothing" /> in Visual Basic) if the intersection is empty.</returns>
569-
<remarks>
570-
<format type="text/markdown"><![CDATA[
571-
572-
## Remarks
573-
The intersection of two permissions is a permission that describes the set of operations they both describe. Only a demand that passes both original permissions will pass the intersection.
574-
575-
]]></format>
576-
</remarks>
526+
<remarks>To be added.</remarks>
577527
<exception cref="T:System.ArgumentException">The <paramref name="target" /> parameter is not a null reference (<see langword="Nothing" /> in Visual Basic) and is not an instance of the same class as the current permission object.</exception>
578528
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
579529
</Docs>
@@ -616,14 +566,7 @@
616566
<summary>Returns a value indicating whether the current permission object is a subset of the specified permission object.</summary>
617567
<returns>
618568
<see langword="true" /> if the current permission object is a subset of the specified permission object, otherwise <see langword="false" />.</returns>
619-
<remarks>
620-
<format type="text/markdown"><![CDATA[
621-
622-
## Remarks
623-
The current permission object is a subset of the specified permission object if the current permission object specifies a set of operations that is wholly contained by the specified permission object. For example, a permission that represents access to C:\example.txt is a subset of a permission that represents access to C:\\. If this method returns `true`, the current permission object represents no more access to the protected resource than does the specified permission object.
624-
625-
]]></format>
626-
</remarks>
569+
<remarks>To be added.</remarks>
627570
<exception cref="T:System.ArgumentException">The <paramref name="target" /> parameter is an object that is not of the same type as the current permission object.</exception>
628571
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
629572
</Docs>
@@ -704,14 +647,7 @@
704647
<Docs>
705648
<summary>Creates an XML encoding of the security object and its current state.</summary>
706649
<returns>An XML encoding of the security object, including any state information.</returns>
707-
<remarks>
708-
<format type="text/markdown"><![CDATA[
709-
710-
## Remarks
711-
Custom code that extends security objects must implement the <xref:System.Data.Common.DBDataPermission.ToXml*> and <xref:System.Data.Common.DBDataPermission.FromXml*> methods to make the objects security encodable.
712-
713-
]]></format>
714-
</remarks>
650+
<remarks>To be added.</remarks>
715651
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
716652
</Docs>
717653
</Member>
@@ -752,14 +688,7 @@
752688
<param name="target">A permission object to combine with the current permission object. It must be of the same type as the current permission object.</param>
753689
<summary>Returns a new permission object that is the union of the current and specified permission objects.</summary>
754690
<returns>A new permission object that represents the union of the current permission object and the specified permission object.</returns>
755-
<remarks>
756-
<format type="text/markdown"><![CDATA[
757-
758-
## Remarks
759-
The result of a call to <xref:System.Data.Common.DBDataPermission.Union*> is a permission that represents all the operations permitted by both the current permission object and the specified permission object. Any demand that passes either permission passes their union.
760-
761-
]]></format>
762-
</remarks>
691+
<remarks>To be added.</remarks>
763692
<exception cref="T:System.ArgumentException">The <paramref name="target" /> object is not the same type as the current permission object.</exception>
764693
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
765694
</Docs>

xml/System.Data.Common/DBDataPermissionAttribute.xml

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -164,14 +164,7 @@
164164
<Docs>
165165
<summary>Gets or sets a permitted connection string.</summary>
166166
<value>A permitted connection string.</value>
167-
<remarks>
168-
<format type="text/markdown"><![CDATA[
169-
170-
## Remarks
171-
Multiple connection strings may be identified. You may also provide additional connection string restrictions using **KeyRestrictions**.
172-
173-
]]></format>
174-
</remarks>
167+
<remarks>To be added.</remarks>
175168
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
176169
</Docs>
177170
</Member>
@@ -245,18 +238,7 @@
245238
<Docs>
246239
<summary>Gets or sets connection string parameters that are allowed or disallowed.</summary>
247240
<value>One or more connection string parameters that are allowed or disallowed.</value>
248-
<remarks>
249-
<format type="text/markdown"><![CDATA[
250-
251-
## Remarks
252-
Connection string parameters are identified in the form *\<parameter name>*=. Multiple parameters can be specified, delimited using a semicolon (;). The connection string parameters listed may be identified as either the only additional parameters allowed or additional parameters that are not allowed using the <xref:System.Data.Common.DBDataPermissionAttribute.KeyRestrictionBehavior> property.
253-
254-
If no key restrictions are specified, and the <xref:System.Data.Common.DBDataPermissionAttribute.KeyRestrictionBehavior> property is set to `AllowOnly`, no additional connection string parameters are allowed.
255-
256-
If no key restrictions are specified, and the <xref:System.Data.Common.DBDataPermissionAttribute.KeyRestrictionBehavior> property is set to `PreventUsage`, additional connection string parameters are allowed. If more than one rule is set for the same connection string, the more restrictive rule is selected during the permission check.
257-
258-
]]></format>
259-
</remarks>
241+
<remarks>To be added.</remarks>
260242
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
261243
</Docs>
262244
</Member>

xml/System.Data.Common/DataAdapter.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@
182182
<format type="text/markdown"><![CDATA[
183183
184184
## Remarks
185-
This overload of the <xref:System.Data.Common.DataAdapter> constructor is designed for use by a .NET Framework data provider when implementing a similar constructor for use in a clone implementation.
185+
This overload of the <xref:System.Data.Common.DataAdapter> constructor is designed for use by a .NET data provider when implementing a similar constructor for use in a clone implementation.
186186
187187
]]></format>
188188
</remarks>
@@ -625,7 +625,7 @@
625625
You can use the <xref:System.Data.Common.DataAdapter.Fill*> method multiple times on the same <xref:System.Data.DataTable>. If a primary key exists, incoming rows are merged with matching rows that already exist. If no primary key exists, incoming rows are appended to the <xref:System.Data.DataTable>.
626626
627627
> [!NOTE]
628-
> When handling batch SQL statements that return multiple results, the implementation of <xref:System.Data.Common.DbDataAdapter.FillSchema*> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <xref:System.Data.Common.DbDataAdapter.Fill*> with the <xref:System.Data.MissingSchemaAction> set to `AddWithKey`.
628+
> When handling batch SQL statements that return multiple results, the implementation of <xref:System.Data.Common.DbDataAdapter.FillSchema*> for the .NET Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <xref:System.Data.Common.DbDataAdapter.Fill*> with the <xref:System.Data.MissingSchemaAction> set to `AddWithKey`.
629629
630630
]]></format>
631631
</remarks>
@@ -1023,7 +1023,7 @@ If a unique clustered index is defined on a column or columns in a SQL Server ta
10231023
<xref:System.Data.Common.DataAdapter.FillSchema*> does not return any rows. Use the <xref:System.Data.Common.DataAdapter.Fill*> method to add rows to a <xref:System.Data.DataTable>.
10241024
10251025
> [!NOTE]
1026-
> When handling batch SQL statements that return multiple results, the implementation of <xref:System.Data.Common.DbDataAdapter.FillSchema*> for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <xref:System.Data.Common.DbDataAdapter.Fill*> with the <xref:System.Data.MissingSchemaAction> set to `AddWithKey`.
1026+
> When handling batch SQL statements that return multiple results, the implementation of <xref:System.Data.Common.DbDataAdapter.FillSchema*> for the .NET Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use <xref:System.Data.Common.DbDataAdapter.Fill*> with the <xref:System.Data.MissingSchemaAction> set to `AddWithKey`.
10271027
10281028
]]></format>
10291029
</remarks>
@@ -1852,7 +1852,7 @@ If a unique clustered index is defined on a column or columns in a SQL Server ta
18521852
18531853
It should be noted that these statements are not performed as a batch process; each row is updated individually. An application can call the <xref:System.Data.DataSet.GetChanges*> method in situations where you must control the sequence of statement types (for example, INSERT before UPDATE). For more information, see [Updating Data Sources with DataAdapters](/dotnet/framework/data/adonet/updating-data-sources-with-dataadapters).
18541854
1855-
If INSERT, UPDATE, or DELETE statements have not been specified, the <xref:System.Data.Common.DataAdapter.Update*> method generates an exception. However, you can create a <xref:System.Data.SqlClient.SqlCommandBuilder> or <xref:System.Data.OleDb.OleDbCommandBuilder> object to automatically generate SQL statements for single-table updates if you set the `SelectCommand` property of a .NET Framework data provider. Then, any additional SQL statements that you do not set are generated by the **CommandBuilder**. This generation logic requires key column information to be present in the <xref:System.Data.DataSet>. For more information see [Generating Commands with CommandBuilders](/dotnet/framework/data/adonet/generating-commands-with-commandbuilders).
1855+
If INSERT, UPDATE, or DELETE statements have not been specified, the <xref:System.Data.Common.DataAdapter.Update*> method generates an exception. However, you can create a <xref:System.Data.SqlClient.SqlCommandBuilder> or <xref:System.Data.OleDb.OleDbCommandBuilder> object to automatically generate SQL statements for single-table updates if you set the `SelectCommand` property of a .NET data provider. Then, any additional SQL statements that you do not set are generated by the **CommandBuilder**. This generation logic requires key column information to be present in the <xref:System.Data.DataSet>. For more information see [Generating Commands with CommandBuilders](/dotnet/framework/data/adonet/generating-commands-with-commandbuilders).
18561856
18571857
The <xref:System.Data.Common.DataAdapter.Update*> method retrieves rows from the table listed in the first mapping before performing an update. The <xref:System.Data.Common.DataAdapter.Update*> then refreshes the row using the value of the <xref:System.Data.IDbCommand.UpdatedRowSource> property. Any additional rows returned are ignored.
18581858

xml/System.Data.Common/DbCommand.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2175,7 +2175,7 @@
21752175
</ReturnValue>
21762176
<Docs>
21772177
<summary>Gets or sets the <see cref="P:System.Data.Common.DbCommand.DbTransaction" /> within which this <see cref="T:System.Data.Common.DbCommand" /> object executes.</summary>
2178-
<value>The transaction within which a <see langword="Command" /> object of a .NET Framework data provider executes. The default value is a null reference (<see langword="Nothing" /> in Visual Basic).</value>
2178+
<value>The transaction within which a <see langword="Command" /> object of a .NET data provider executes. The default value is a null reference (<see langword="Nothing" /> in Visual Basic).</value>
21792179
<remarks>
21802180
<format type="text/markdown"><![CDATA[
21812181
@@ -2244,7 +2244,7 @@
22442244
</ReturnValue>
22452245
<Docs>
22462246
<summary>Gets or sets the <see cref="T:System.Data.Common.DbTransaction" /> within which this <see cref="T:System.Data.Common.DbCommand" /> object executes.</summary>
2247-
<value>The transaction within which a command object of a .NET Framework data provider executes. The default value is a null reference (<see langword="Nothing" /> in Visual Basic).</value>
2247+
<value>The transaction within which a command object of a .NET data provider executes. The default value is a null reference (<see langword="Nothing" /> in Visual Basic).</value>
22482248
<remarks>To be added.</remarks>
22492249
<related type="Article" href="/dotnet/framework/data/adonet/ado-net-overview">ADO.NET Overview</related>
22502250
</Docs>

0 commit comments

Comments
 (0)