Skip to content

Commit 1cc876e

Browse files
H-YeoH-Yeo
committed
Manual Copy Paste of DBBatch version replacements
Copy manual DB Batch (parent Class Documentation)
1 parent c7fd5f1 commit 1cc876e

File tree

3 files changed

+120
-24
lines changed

3 files changed

+120
-24
lines changed

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

Lines changed: 109 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
<docs>
33
<members name="SqlBatchCommandCollection">
44
<SqlBatchCommandCollection>
5-
<summary>A collection of instances of
6-
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />, contained within a
5+
<summary>
6+
A collection of instances of
7+
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />, contained within a
78
<see cref="T:Microsoft.Data.SqlClient.SqlBatch" />.
89
</summary>
910
<remarks>
@@ -14,9 +15,11 @@
1415
</remarks>
1516
</SqlBatchCommandCollection>
1617
<Add1>
17-
<summary>Add a
18-
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> to the end of the
19-
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
18+
<summary>
19+
Add a
20+
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> to the end of the
21+
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
22+
</summary>
2023
<value></value>
2124
<remarks>
2225
<format type="text/markdown">
@@ -25,10 +28,21 @@
2528
</format>
2629
</remarks>
2730
</Add1>
31+
<Add2>
32+
<param name="item">
33+
The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.
34+
</param>
35+
<summary>
36+
Adds the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object to the <see cref="T:System.Data.Common.DbBatchCommandCollection" />.
37+
</summary>
38+
<remarks>To be added.</remarks>
39+
</Add2>
2840
<Contains1>
29-
<summary>Determines whether a
30-
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> is in the
31-
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
41+
<summary>
42+
Determines whether a
43+
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> is in the
44+
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
45+
</summary>
3246
<value></value>
3347
<remarks>
3448
<format type="text/markdown">
@@ -37,8 +51,22 @@
3751
</format>
3852
</remarks>
3953
</Contains1>
54+
<Contains2>
55+
<param name="item">
56+
The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1" />.
57+
</param>
58+
<summary>
59+
Indicates whether a <see cref="T:System.Data.Common.DbBatchCommand" /> is contained in the collection.
60+
</summary>
61+
<returns>
62+
<see langword="true" /> if the <see cref="T:System.Data.Common.DbBatchCommand" /> is in the collection; otherwise <see langword="false" />.
63+
</returns>
64+
<remarks>To be added.</remarks>
65+
</Contains2>
4066
<CopyTo1>
41-
<summary>Copies the entire <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> to a one dimensional array, starting at the target index of the target array.</summary>
67+
<summary>
68+
Copies the entire <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> to a one dimensional array, starting at the target index of the target array.
69+
</summary>
4270
<value></value>
4371
<remarks>
4472
<format type="text/markdown">
@@ -47,8 +75,22 @@
4775
</format>
4876
</remarks>
4977
</CopyTo1>
78+
<CopyTo2>
79+
<param name="array">
80+
The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from <see cref="T:System.Collections.Generic.ICollection`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.
81+
</param>
82+
<param name="arrayIndex">
83+
The zero-based index in <paramref name="array" /> at which copying begins.
84+
</param>
85+
<summary>
86+
Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.
87+
</summary>
88+
<remarks>To be added.</remarks>
89+
</CopyTo2>
5090
<IndexOf1>
51-
<summary>Searches for the specified <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> within the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> and returns the zero-based index of the first occurence within the entire <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
91+
<summary>
92+
Searches for the specified <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> within the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> and returns the zero-based index of the first occurence within the entire <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
93+
</summary>
5294
<returns>
5395
Returns the zero-based index of the first occurence within the entire <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
5496
</returns>
@@ -59,8 +101,22 @@
59101
</format>
60102
</remarks>
61103
</IndexOf1>
104+
<indexOf2>
105+
<param name="item">
106+
The object to locate in the <see cref="T:System.Collections.Generic.IList`1" />.
107+
</param>
108+
<summary>
109+
Returns the index of the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object.
110+
</summary>
111+
<returns>
112+
The index of the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object.
113+
</returns>
114+
<remarks>To be added.</remarks>
115+
</indexOf2>
62116
<Insert1>
63-
<summary>Inserts an item into the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> at the specified index.</summary>
117+
<summary>
118+
Inserts an item into the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> at the specified index.
119+
</summary>
64120
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
65121
<remarks>
66122
<format type="text/markdown">
@@ -69,18 +125,45 @@
69125
</format>
70126
</remarks>
71127
</Insert1>
128+
<insert2>
129+
<param name="index">
130+
The index at which to insert the <see cref="T:System.Data.Common.DbBatchCommand" /> object.
131+
</param>
132+
<param name="item">
133+
The object to insert into the <see cref="T:System.Collections.Generic.IList`1" />.
134+
</param>
135+
<summary>
136+
Inserts the specified index of the <see cref="T:System.Data.Common.DbBatchCommand" /> object with the specified name into the collection at the specified index.
137+
</summary>
138+
<remarks>To be added.</remarks>
139+
</insert2>
72140
<Remove1>
73-
<summary>Removes the first occurence of the specific item from the
141+
<summary>
142+
Removes the first occurence of the specific item from the
74143
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />.
75144
</summary>
76-
<returns>Returns <see langword="true" /> if an item is successfully removed. Returns false if an item could not be removed or no item was not found.</returns>
145+
<returns>
146+
Returns <see langword="true" /> if an item is successfully removed. Returns false if an item could not be removed or no item was not found.
147+
</returns>
77148
<remarks>
78149
<format type="text/markdown">
79150
<![CDATA[
80151
]]>
81152
</format>
82153
</remarks>
83154
</Remove1>
155+
<Remove2>
156+
<param name="item">
157+
The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.
158+
</param>
159+
<summary>
160+
Removes the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object from the collection.
161+
</summary>
162+
<returns>
163+
<see langword="true" /> if <paramref name="item" /> was successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> was not found in the <see cref="T:System.Data.Common.DbBatchCommandCollection" />.
164+
</returns>
165+
<remarks>To be added.</remarks>
166+
</Remove2>
84167
<this1>
85168
<summary>Gets or Sets the element at the specified index.</summary>
86169
<returns>The element at the specified index.</returns>
@@ -103,5 +186,18 @@
103186
</format>
104187
</remarks>
105188
</this2>
189+
<GetBatchCommand>
190+
<summary>To be added.</summary>
191+
</GetBatchCommand>
192+
<SetBatchCommand>
193+
<param name="index">
194+
The index where the <see cref="T:System.Data.Common.DbBatchCommand" /> object is located.
195+
</param>
196+
<param name="batchCommand">To be added.</param>
197+
<summary>
198+
Sets the <see cref="T:System.Data.Common.DbBatchCommand" /> object at the specified index to a new value.
199+
</summary>
200+
<remarks>To be added.</remarks>
201+
</SetBatchCommand>
106202
</members>
107203
</docs>

‎src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.Batch.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public class SqlBatchCommandCollection : System.Data.Common.DbBatchCommandCollec
8484
public override System.Collections.Generic.IEnumerator<System.Data.Common.DbBatchCommand> GetEnumerator() => throw null;
8585
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add1/*'/>
8686
public void Add(Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;
87-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Add(System.Data.Common.DbBatchCommand)"/>
87+
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add2/*'/>
8888
public override void Add(System.Data.Common.DbBatchCommand item) => throw null;
8989
/// <inheritdoc />
9090
public override void Clear() => throw null;
@@ -94,11 +94,11 @@ public class SqlBatchCommandCollection : System.Data.Common.DbBatchCommandCollec
9494
public override bool Contains(System.Data.Common.DbBatchCommand item) => throw null;
9595
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo1/*'/>
9696
public void CopyTo(Microsoft.Data.SqlClient.SqlBatchCommand[] array, int arrayIndex) => throw null;
97-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.CopyTo(System.Data.Common.DbBatchCommand[], int)"/>
97+
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo2/*'/>
9898
public override void CopyTo(System.Data.Common.DbBatchCommand[] array, int arrayIndex) => throw null;
9999
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf1/*'/>
100100
public int IndexOf(Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;
101-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.IndexOf(System.Data.Common.DbBatchCommand)"/>
101+
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf2/*'/>
102102
public override int IndexOf(System.Data.Common.DbBatchCommand item) => throw null;
103103
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert1/*'/>
104104
public void Insert(int index, Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;

‎src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBatchCommandCollection.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,33 +26,33 @@ internal SqlBatchCommandCollection(List<SqlBatchCommand> batchCommands)
2626
public override IEnumerator<DbBatchCommand> GetEnumerator() => _list.GetEnumerator();
2727
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add1/*'/>
2828
public void Add(SqlBatchCommand item) => _list.Add(item);
29-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Add(DbBatchCommand)"/>
29+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add2/*'/>
3030
public override void Add(DbBatchCommand item) => Add((SqlBatchCommand)item);
3131
/// <inheritdoc />
3232
public override void Clear() => _list.Clear();
3333
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains1/*'/>
3434
public bool Contains(SqlBatchCommand item) => _list.Contains(item);
35-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Contains(DbBatchCommand)"/>
35+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains2/*'/>
3636
public override bool Contains(DbBatchCommand item) => Contains((SqlBatchCommand)item);
3737
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo1/*'/>
3838
public void CopyTo(SqlBatchCommand[] array, int arrayIndex) => _list.CopyTo(array, arrayIndex);
39-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.CopyTo(DbBatchCommand[], int)"/>
39+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo2/*'/>
4040
public override void CopyTo(DbBatchCommand[] array, int arrayIndex)
4141
{
4242
SqlBatchCommand[] target = (SqlBatchCommand[])array;
4343
CopyTo(target, arrayIndex);
4444
}
4545
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf1/*'/>
4646
public int IndexOf(SqlBatchCommand item) => _list.IndexOf(item);
47-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.IndexOf(DbBatchCommand)"/>
47+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf2/*'/>
4848
public override int IndexOf(DbBatchCommand item) => IndexOf((SqlBatchCommand)item);
4949
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert1/*'/>
5050
public void Insert(int index, SqlBatchCommand item) => _list.Insert(index, item);
51-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Insert(int, DbBatchCommand)"/>
51+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert2/*'/>
5252
public override void Insert(int index, DbBatchCommand item) => Insert(index, (SqlBatchCommand)item);
5353
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove1/*'/>
5454
public bool Remove(SqlBatchCommand item) => _list.Remove(item);
55-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Remove(DbBatchCommand)"/>
55+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove2/*'/>
5656
public override bool Remove(DbBatchCommand item) => Remove((SqlBatchCommand)item);
5757
/// <inheritdoc />
5858
public override void RemoveAt(int index) => _list.RemoveAt(index);
@@ -68,9 +68,9 @@ SqlBatchCommand IList<SqlBatchCommand>.this[int index]
6868
get => _list[index];
6969
set => _list[index] = value;
7070
}
71-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.GetBatchCommand(int)"/>
71+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/GetBatchCommand/*'/>
7272
protected override DbBatchCommand GetBatchCommand(int index) => _list[index];
73-
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.SetBatchCommand(int, DbBatchCommand)"/>
73+
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/SetBatchCommand/*'/>
7474
protected override void SetBatchCommand(int index, DbBatchCommand batchCommand)
7575
=> _list[index] = (SqlBatchCommand)batchCommand;
7676
}

0 commit comments

Comments
 (0)