Skip to content

Commit 725ea62

Browse files
cheenamalhotraThraka
authored andcommitted
Add documentations for System.Data.SqlDataReader (#3237)
* Add documentations for System.Data.SqlDataReader * Fix minor error * Fix for warnings * Apply suggestions from code review Co-Authored-By: Maira Wenzel <[email protected]> * Fix documentation for DbDataReader and SqlDataReader classes * Fix docs
1 parent 7745c94 commit 725ea62

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

xml/System.Data.Common/DbDataReader.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@
308308
<Docs>
309309
<param name="disposing">
310310
<see langword="true" /> to release managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
311-
<summary>Releases the managed resources used by the <see cref="T:System.Data.Common.DbDataReader" /> and optionally releases the unmanaged resources.</summary>
311+
<summary>Releases the unmanaged resources used by the <see cref="T:System.Data.Common.DbDataReader" /> and optionally releases the managed resources.</summary>
312312
<remarks>
313313
<format type="text/markdown"><![CDATA[
314314

xml/System.Data.SqlClient/SqlDataReader.xml

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -246,17 +246,18 @@
246246
<Parameter Name="disposing" Type="System.Boolean" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
247247
</Parameters>
248248
<Docs>
249-
<param name="disposing">
250-
<see langword="true" /> to release managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
251-
<summary>Releases the managed resources used by the <see cref="T:System.Data.SqlClient.SqlDataReader" /> and optionally releases the unmanaged resources.</summary>
249+
<param name="disposing"><see langword="true" /> to release managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
250+
<summary>Releases the unmanaged resources used by the <see cref="T:System.Data.SqlClient.SqlDataReader" /> and optionally releases the managed resources.</summary>
252251
<remarks>
253252
<format type="text/markdown"><![CDATA[
254-
253+
255254
## Remarks
256-
This method calls <xref:System.Data.SqlClient.SqlDataReader.Close%2A>.
257255
258-
]]></format>
256+
This method calls <xref:System.Data.Common.DbDataReader.Dispose%2A>.
257+
258+
]]></format>
259259
</remarks>
260+
<related type="Article" href="~/docs/framework/data/adonet/ado-net-overview.md">ADO.NET Overview</related>
260261
</Docs>
261262
</Member>
262263
<Member MemberName="FieldCount">
@@ -664,9 +665,17 @@
664665
</ReturnValue>
665666
<Parameters />
666667
<Docs>
667-
<summary>Gets the column schema (<see cref="T:System.Data.Common.DbColumn" /> collection).</summary>
668-
<returns>The column schema (<see cref="T:System.Data.Common.DbColumn" /> collection).</returns>
669-
<remarks>To be added.</remarks>
668+
<summary>Gets the read-only column schema collection.</summary>
669+
<returns>The read-only column schema collection.</returns>
670+
<remarks>
671+
<format type="text/markdown"><![CDATA[
672+
673+
## Remarks
674+
675+
This method is an implementation of <xref:System.Data.Common.IDbColumnSchemaGenerator.GetColumnSchema?displayProperty=nameWithType> method, which enables the use of the <xref:System.Data.Common.IDbColumnSchemaGenerator> interface to populate the <xref:System.Data.Common.DbColumn> schema metadata without using a <xref:System.Data.DataTable>.
676+
677+
]]></format>
678+
</remarks>
670679
</Docs>
671680
</Member>
672681
<Member MemberName="GetData">

0 commit comments

Comments
 (0)