Skip to content

Commit

Permalink
Manual Copy Paste of DBBatch version replacements
Browse files Browse the repository at this point in the history 
Copy manual DB Batch (parent Class Documentation)
  • Loading branch information
@H-Yeo
H-Yeo committed Feb 13, 2024
1 parent c7fd5f1 commit 1cc876e
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 24 deletions.
122 changes: 109 additions & 13 deletions doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
<docs>
<members name="SqlBatchCommandCollection">
<SqlBatchCommandCollection>
<summary>A collection of instances of
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />, contained within a
<summary>
A collection of instances of
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />, contained within a
<see cref="T:Microsoft.Data.SqlClient.SqlBatch" />.
</summary>
<remarks>
Expand All @@ -14,9 +15,11 @@
</remarks>
</SqlBatchCommandCollection>
<Add1>
<summary>Add a
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> to the end of the
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
<summary>
Add a
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> to the end of the
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
</summary>
<value></value>
<remarks>
<format type="text/markdown">
Expand All @@ -25,10 +28,21 @@
</format>
</remarks>
</Add1>
<Add2>
<param name="item">
The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.
</param>
<summary>
Adds the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object to the <see cref="T:System.Data.Common.DbBatchCommandCollection" />.
</summary>
<remarks>To be added.</remarks>
</Add2>
<Contains1>
<summary>Determines whether a
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> is in the
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
<summary>
Determines whether a
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> is in the
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
</summary>
<value></value>
<remarks>
<format type="text/markdown">
Expand All @@ -37,8 +51,22 @@
</format>
</remarks>
</Contains1>
<Contains2>
<param name="item">
The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1" />.
</param>
<summary>
Indicates whether a <see cref="T:System.Data.Common.DbBatchCommand" /> is contained in the collection.
</summary>
<returns>
<see langword="true" /> if the <see cref="T:System.Data.Common.DbBatchCommand" /> is in the collection; otherwise <see langword="false" />.
</returns>
<remarks>To be added.</remarks>
</Contains2>
<CopyTo1>
<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>
<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>
<value></value>
<remarks>
<format type="text/markdown">
Expand All @@ -47,8 +75,22 @@
</format>
</remarks>
</CopyTo1>
<CopyTo2>
<param name="array">
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.
</param>
<param name="arrayIndex">
The zero-based index in <paramref name="array" /> at which copying begins.
</param>
<summary>
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.
</summary>
<remarks>To be added.</remarks>
</CopyTo2>
<IndexOf1>
<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>
<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>
<returns>
Returns the zero-based index of the first occurence within the entire <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
</returns>
Expand All @@ -59,8 +101,22 @@
</format>
</remarks>
</IndexOf1>
<indexOf2>
<param name="item">
The object to locate in the <see cref="T:System.Collections.Generic.IList`1" />.
</param>
<summary>
Returns the index of the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object.
</summary>
<returns>
The index of the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object.
</returns>
<remarks>To be added.</remarks>
</indexOf2>
<Insert1>
<summary>Inserts an item into the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> at the specified index.</summary>
<summary>
Inserts an item into the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> at the specified index.
</summary>
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
<remarks>
<format type="text/markdown">
Expand All @@ -69,18 +125,45 @@
</format>
</remarks>
</Insert1>
<insert2>
<param name="index">
The index at which to insert the <see cref="T:System.Data.Common.DbBatchCommand" /> object.
</param>
<param name="item">
The object to insert into the <see cref="T:System.Collections.Generic.IList`1" />.
</param>
<summary>
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.
</summary>
<remarks>To be added.</remarks>
</insert2>
<Remove1>
<summary>Removes the first occurence of the specific item from the
<summary>
Removes the first occurence of the specific item from the
<see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />.
</summary>
<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>
<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>
<remarks>
<format type="text/markdown">
<![CDATA[
]]>
</format>
</remarks>
</Remove1>
<Remove2>
<param name="item">
The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1" />.
</param>
<summary>
Removes the specified <see cref="T:System.Data.Common.DbBatchCommand" /> object from the collection.
</summary>
<returns>
<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" />.
</returns>
<remarks>To be added.</remarks>
</Remove2>
<this1>
<summary>Gets or Sets the element at the specified index.</summary>
<returns>The element at the specified index.</returns>
Expand All @@ -103,5 +186,18 @@
</format>
</remarks>
</this2>
<GetBatchCommand>
<summary>To be added.</summary>
</GetBatchCommand>
<SetBatchCommand>
<param name="index">
The index where the <see cref="T:System.Data.Common.DbBatchCommand" /> object is located.
</param>
<param name="batchCommand">To be added.</param>
<summary>
Sets the <see cref="T:System.Data.Common.DbBatchCommand" /> object at the specified index to a new value.
</summary>
<remarks>To be added.</remarks>
</SetBatchCommand>
</members>
</docs>
6 changes: 3 additions & 3 deletions src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.Batch.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public class SqlBatchCommandCollection : System.Data.Common.DbBatchCommandCollec
public override System.Collections.Generic.IEnumerator<System.Data.Common.DbBatchCommand> GetEnumerator() => throw null;
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add1/*'/>
public void Add(Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Add(System.Data.Common.DbBatchCommand)"/>
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add2/*'/>
public override void Add(System.Data.Common.DbBatchCommand item) => throw null;
/// <inheritdoc />
public override void Clear() => throw null;
Expand All @@ -94,11 +94,11 @@ public class SqlBatchCommandCollection : System.Data.Common.DbBatchCommandCollec
public override bool Contains(System.Data.Common.DbBatchCommand item) => throw null;
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo1/*'/>
public void CopyTo(Microsoft.Data.SqlClient.SqlBatchCommand[] array, int arrayIndex) => throw null;
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.CopyTo(System.Data.Common.DbBatchCommand[], int)"/>
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo2/*'/>
public override void CopyTo(System.Data.Common.DbBatchCommand[] array, int arrayIndex) => throw null;
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf1/*'/>
public int IndexOf(Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.IndexOf(System.Data.Common.DbBatchCommand)"/>
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf2/*'/>
public override int IndexOf(System.Data.Common.DbBatchCommand item) => throw null;
/// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert1/*'/>
public void Insert(int index, Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;
Expand Down
16 changes: 8 additions & 8 deletions src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBatchCommandCollection.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,33 +26,33 @@ internal SqlBatchCommandCollection(List<SqlBatchCommand> batchCommands)
public override IEnumerator<DbBatchCommand> GetEnumerator() => _list.GetEnumerator();
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add1/*'/>
public void Add(SqlBatchCommand item) => _list.Add(item);
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Add(DbBatchCommand)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add2/*'/>
public override void Add(DbBatchCommand item) => Add((SqlBatchCommand)item);
/// <inheritdoc />
public override void Clear() => _list.Clear();
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains1/*'/>
public bool Contains(SqlBatchCommand item) => _list.Contains(item);
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Contains(DbBatchCommand)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains2/*'/>
public override bool Contains(DbBatchCommand item) => Contains((SqlBatchCommand)item);
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo1/*'/>
public void CopyTo(SqlBatchCommand[] array, int arrayIndex) => _list.CopyTo(array, arrayIndex);
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.CopyTo(DbBatchCommand[], int)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo2/*'/>
public override void CopyTo(DbBatchCommand[] array, int arrayIndex)
{
SqlBatchCommand[] target = (SqlBatchCommand[])array;
CopyTo(target, arrayIndex);
}
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf1/*'/>
public int IndexOf(SqlBatchCommand item) => _list.IndexOf(item);
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.IndexOf(DbBatchCommand)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf2/*'/>
public override int IndexOf(DbBatchCommand item) => IndexOf((SqlBatchCommand)item);
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert1/*'/>
public void Insert(int index, SqlBatchCommand item) => _list.Insert(index, item);
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Insert(int, DbBatchCommand)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert2/*'/>
public override void Insert(int index, DbBatchCommand item) => Insert(index, (SqlBatchCommand)item);
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove1/*'/>
public bool Remove(SqlBatchCommand item) => _list.Remove(item);
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Remove(DbBatchCommand)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove2/*'/>
public override bool Remove(DbBatchCommand item) => Remove((SqlBatchCommand)item);
/// <inheritdoc />
public override void RemoveAt(int index) => _list.RemoveAt(index);
Expand All @@ -68,9 +68,9 @@ SqlBatchCommand IList<SqlBatchCommand>.this[int index]
get => _list[index];
set => _list[index] = value;
}
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.GetBatchCommand(int)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/GetBatchCommand/*'/>
protected override DbBatchCommand GetBatchCommand(int index) => _list[index];
/// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.SetBatchCommand(int, DbBatchCommand)"/>
/// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/SetBatchCommand/*'/>
protected override void SetBatchCommand(int index, DbBatchCommand batchCommand)
=> _list[index] = (SqlBatchCommand)batchCommand;
}
Expand Down

0 comments on commit 1cc876e

Please sign in to comment.