Explicit Declaration for SQLBatch and SQLBatchCommandCollection

For InheritDoc, Explicit declaration of where the reference is located.
DavoudEshtehari · Feb 7, 2024 · eed5b4b · eed5b4b
1 parent 5d2cfd7
commit eed5b4b
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 65 deletions.
diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlBatch.xml
@@ -53,7 +53,7 @@ The following example creates a <xref:Microsoft.Data.SqlClient.SqlConnection> an
       </remarks>
     </ctor2>
     <Timeout>
-      <inheritdoc cref="P:Microsoft.Data.SqlClient.SqlBatch.Timeout"/>
+      <inheritdoc cref="P:System.Data.Common.DbBatch.Timeout"/>
     </Timeout>
     <Connection>
       <summary>
@@ -110,30 +110,25 @@ The following example creates a <xref:Microsoft.Data.SqlClient.SqlConnection> an
       <inheritdoc cref="M:Microsoft.Data.SqlClient.SqlBatch.ExecuteNonQuery"/>       
     </ExecuteNonQuery>
     <ExecuteNonQueryAsync>
-      <summary>
-        Test1 ExecuteNonQueryAsync Comment
-      </summary>
-      <remarks>
-        <format type="text/markdown"></format>
-      </remarks>
+      <inheritdoc cref="M:System.Data.Common.DbBatch.ExecuteNonQueryAsync"/>
     </ExecuteNonQueryAsync>
     <ExecuteScalar>
-      <inheritdoc cref="P:Microsoft.Data.SqlClient.SqlBatch.ExecuteScalar"/>       
+      <inheritdoc cref="M:Microsoft.Data.SqlClient.SqlBatch.ExecuteScalar"/>       
     </ExecuteScalar>
     <ExecuteScalarAsync>
-      <inheritdoc cref="M:Microsoft.Data.SqlClient.SqlBatch.ExecuteScalarAsync"/>       
+      <inheritdoc cref="M:System.Data.Common.DbBatch.ExecuteScalarAsync"/>       
     </ExecuteScalarAsync>
     <Prepare>
-      <inheritdoc cref="P:System.Data.Common.DbBatch.Prepare"/>       
+      <inheritdoc cref="M:System.Data.Common.DbBatch.Prepare"/>       
     </Prepare>
     <PrepareAsync>
-      <inheritdoc cref="M:Microsoft.Data.SqlClient.SqlBatch.PrepareAsync"/>       
+      <inheritdoc cref="M:System.Data.Common.DbBatch.PrepareAsync"/>       
     </PrepareAsync>
     <ExecuteDbDataReader>
-      <inheritdoc cref="M:Microsoft.Data.SqlClient.SqlBatch.ExecuteDbDataReader"/>       
+      <inheritdoc cref="M:System.Data.Common.DbBatch.ExecuteDbDataReader"/>       
     </ExecuteDbDataReader>
     <ExecuteDbDataReaderAsync>
-      <inheritdoc cref="M:Microsoft.Data.SqlClient.SqlBatch.ExecuteDbDataReaderAsync"/>       
+      <inheritdoc cref="M:System.Data.Common.DbBatch.ExecuteDbDataReaderAsync"/>       
     </ExecuteDbDataReaderAsync>        
     <Commands>
       <summary>

diff --git a/doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml b/doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml
@@ -2,36 +2,51 @@
 <docs>
   <members name="SqlBatchCommandCollection">
     <SqlBatchCommandCollection>
-      <summary>A collection of instances of <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />, contained within a <see cref="T:Microsoft.Data.SqlClient.SqlBatch" />.
-    </summary>
+      <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>
         <format type="text/markdown">
           <![CDATA[
 ]]>
         </format>
       </remarks>
     </SqlBatchCommandCollection>
-    <Add>
-      <summary>Add a <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> to the end of the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
+    <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 
+        <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
       <value></value>
       <remarks>
         <format type="text/markdown">
           <![CDATA[
 ]]>
         </format>
       </remarks>
-    </Add>
-    <Contains>
-      <summary>Determines whether a <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" /> is in the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
+    </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 
+        <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.</summary>
       <value></value>
       <remarks>
         <format type="text/markdown">
           <![CDATA[
 ]]>
         </format>
       </remarks>
-    </Contains>
-    <CopyTo>
+    </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>
       <remarks>
@@ -40,8 +55,11 @@
 ]]>
         </format>
       </remarks>
-    </CopyTo>
-    <IndexOf>
+    </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>
         Returns the zero-based index of the first occurence within the entire <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommandCollection" />.
@@ -52,8 +70,11 @@
 ]]>
         </format>
       </remarks>
-    </IndexOf>
-    <Insert>
+    </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>
       <remarks>
@@ -62,17 +83,25 @@
 ]]>
         </format>
       </remarks>
-    </Insert>
-    <Remove>
-      <summary>Removes the first occurence of the specific item from the <see cref="T:Microsoft.Data.SqlClient.SqlBatchCommand" />.</summary>
+    </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" />.
+      </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>
       <remarks>
         <format type="text/markdown">
           <![CDATA[
 ]]>
         </format>
       </remarks>
-    </Remove>
+    </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>
@@ -95,5 +124,11 @@
         </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
@@ -72,53 +72,51 @@ public partial class SqlBatchCommand : System.Data.Common.DbBatchCommand
         /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommand.xml' path='docs/members[@name="SqlBatchCommand"]/DbParameterCollection/*'/>
         protected override System.Data.Common.DbParameterCollection DbParameterCollection => throw null;
     }
-    /// <inheritdoc cref="System.Data.Common.DbBatchCommandCollection"/>
     /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/SqlBatchCommandCollection/*'/>
     public class SqlBatchCommandCollection : System.Data.Common.DbBatchCommandCollection, System.Collections.Generic.IList<SqlBatchCommand>
     {
         /// <inheritdoc />
         public override int Count => throw null;
         /// <inheritdoc />
         public override bool IsReadOnly => throw null;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/GetEnumerator/*'/>
         System.Collections.Generic.IEnumerator<Microsoft.Data.SqlClient.SqlBatchCommand> System.Collections.Generic.IEnumerable<Microsoft.Data.SqlClient.SqlBatchCommand>.GetEnumerator() => throw null;
-        /// <inheritdoc />
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/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"]/Add/*'/>
+        /// <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 />
+        /// <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;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains/*'/>
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains1/*'/>
         public bool Contains(Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;
-        /// <inheritdoc />
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Contains2/*'/>
         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"]/CopyTo/*'/>
+        /// <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 />
+        /// <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"]/IndexOf/*'/>
+        /// <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 />
+        /// <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"]/Insert/*'/>
+        /// <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;
-        /// <inheritdoc />
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Insert2/*'/>
         public override void Insert(int index, System.Data.Common.DbBatchCommand item) => throw null;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove/*'/>
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove1/*'/>
         public bool Remove(Microsoft.Data.SqlClient.SqlBatchCommand item) => throw null;
-        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove/*'/>
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/Remove2/*'/>
         public override bool Remove(System.Data.Common.DbBatchCommand item) => throw null;
         /// <inheritdoc />
         public override void RemoveAt(int index) => throw null;
         Microsoft.Data.SqlClient.SqlBatchCommand System.Collections.Generic.IList<SqlBatchCommand>.this[int index] { get => throw null; set { } }
         /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/this/*'/>
         public new Microsoft.Data.SqlClient.SqlBatchCommand this[int index] { get => throw null; set { } }
         System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() => throw null;
-        /// <inheritdoc />
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/GetBatchCommand/*'/>
         protected override System.Data.Common.DbBatchCommand GetBatchCommand(int index) => throw null;
-        /// <inheritdoc />
+        /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlBatchCommandCollection.xml' path='docs/members[@name="SqlBatchCommandCollection"]/SetBatchCommand/*'/>
         protected override void SetBatchCommand(int index, System.Data.Common.DbBatchCommand batchCommand) => throw null;
     }
     /// <include file='../../../doc/snippets/Microsoft.Data.SqlClient/SqlException.xml' path='docs/members[@name="SqlException"]/SqlException/*'/>