SQLBatchCommandCollection Changes

Update to InheritDoc for SQLBatchCommandCollection
DavoudEshtehari · Feb 8, 2024 · 0e8e54a · 0e8e54a
1 parent a894493
commit 0e8e54a
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 41 deletions.
diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml
@@ -13,9 +13,6 @@
         </format>
       </remarks>
     </SqlBatchCommandCollection>
-    <GetEnumerator>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.GetEnumerator"/>
-    </GetEnumerator>
     <Add1>
       <summary>Add a 
         <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> to the end of the 
@@ -28,9 +25,6 @@
         </format>
       </remarks>
     </Add1>
-    <Add2>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.Add"/>
-    </Add2>
     <Contains1>
       <summary>Determines whether a 
         <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> is in the 
@@ -43,9 +37,6 @@
         </format>
       </remarks>
     </Contains1>
-    <Contains2>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.Contains"/>
-    </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>
       <value></value>
@@ -56,9 +47,6 @@
         </format>
       </remarks>
     </CopyTo1>
-    <CopyTo2>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.CopyTo"/>
-    </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>
       <returns>
@@ -71,9 +59,6 @@
         </format>
       </remarks>
     </IndexOf1>
-    <IndexOf2>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.IndexOf"/>
-    </IndexOf2>
     <Insert1>
       <summary>Inserts an item into the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" /> at the specified index.</summary>
       <exception cref="T:System.ArgumentOutOfRangeException"></exception>
@@ -84,9 +69,6 @@
         </format>
       </remarks>
     </Insert1>
-    <Insert2>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.Insert"/>
-    </Insert2>
     <Remove1>
       <summary>Removes the first occurence of the specific item from the 
         <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />.
@@ -99,9 +81,6 @@
         </format>
       </remarks>
     </Remove1>
-    <Remove2>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.Remove"/>
-    </Remove2>
     <this1>
       <summary>Gets or Sets the element at the specified index.</summary>
       <returns>The element at the specified index.</returns>
@@ -124,11 +103,5 @@
         </format>
       </remarks>
     </this2>
-    <GetBatchCommand>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.GetBatchCommand"/>      
-    </GetBatchCommand>
-    <SetBatchCommand>
-      <inheritdoc cref="M:System.Data.Common.DbBatchCommandCollection.SetBatchCommand"/>      
-    </SetBatchCommand>
   </members>
 </docs>
diff --git a/src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.Batch.cs b/src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.Batch.cs
@@ -80,11 +80,11 @@ public class SqlBatchCommandCollection : System.Data.Common.DbBatchCommandCollec
         /// <inheritdoc />
         public override bool IsReadOnly => throw null;
         System.Collections.Generic.IEnumerator<Microsoft.Data.SqlClient.SqlBatchCommand> System.Collections.Generic.IEnumerable<Microsoft.Data.SqlClient.SqlBatchCommand>.GetEnumerator() => throw null;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/GetEnumerator/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.GetEnumerator"/>
         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;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Add(System.Data.Common.DbBatchCommand)"/>
         public override void Add(System.Data.Common.DbBatchCommand item) => throw null;
         /// <inheritdoc />
         public override void Clear() => throw null;
@@ -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;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.CopyTo(System.Data.Common.DbBatchCommand[], int)"/>
         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;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.IndexOf(System.Data.Common.DbBatchCommand)"/>
         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;

diff --git a/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBatchCommandCollection.cs b/src/Microsoft.Data.SqlClient/src/Microsoft/Data/SqlClient/SqlBatchCommandCollection.cs
@@ -5,7 +5,6 @@
 
 using System.Collections.Generic;
 using System.Data.Common;
-using Microsoft.Data.Common;
 
 namespace Microsoft.Data.SqlClient
 {
@@ -23,37 +22,37 @@ internal SqlBatchCommandCollection(List<SqlBatchCommand> batchCommands)
         /// <inheritdoc />
         public override bool IsReadOnly => false;
         IEnumerator<SqlBatchCommand> IEnumerable<SqlBatchCommand>.GetEnumerator() => _list.GetEnumerator();
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/GetEnumerator/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.GetEnumerator"/>
         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);
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Add2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Add(DbBatchCommand)"/>
         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);
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Contains(DbBatchCommand)"/>
         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);
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/CopyTo2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.CopyTo(DbBatchCommand[], int)"/>
         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);
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/IndexOf2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.IndexOf(DbBatchCommand)"/>
         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);
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Insert(int, DbBatchCommand)"/>
         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);
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove2/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.Remove(DbBatchCommand)"/>
         public override bool Remove(DbBatchCommand item) => Remove((SqlBatchCommand)item);
         /// <inheritdoc />
         public override void RemoveAt(int index) => _list.RemoveAt(index);
@@ -69,9 +68,9 @@ public override void CopyTo(DbBatchCommand[] array, int arrayIndex)
             get => _list[index];
             set => _list[index] = value;
         }
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/GetBatchCommand/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.GetBatchCommand(int)"/>
         protected override DbBatchCommand GetBatchCommand(int index) => _list[index];
-        /// <include file='../../../../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/SetBatchCommand/*'/>
+        /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection.SetBatchCommand(int, DbBatchCommand)"/>
         protected override void SetBatchCommand(int index, DbBatchCommand batchCommand)
             => _list[index] = (SqlBatchCommand)batchCommand;
     }