Skip to content

Commit db60afc

Browse files
author
David Engel
authored
System.Data 1.x undocumented APIs (dotnet#4233)
* dotnet#3910 - System.Data 1.x undocumented APIs * Revert remarks Fixing dispose doc error * Fix copy paste error * Adding Exception info
1 parent 99b4b98 commit db60afc

File tree

6 files changed

+98
-50
lines changed

6 files changed

+98
-50
lines changed

‎xml/System.Data.Common/DbCommand.xml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -632,7 +632,7 @@
632632
</ReturnValue>
633633
<Parameters />
634634
<Docs>
635-
<summary>To be added.</summary>
635+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
636636
<remarks>To be added.</remarks>
637637
</Docs>
638638
</Member>
@@ -662,8 +662,9 @@
662662
<Parameter Name="disposing" Type="System.Boolean" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1" />
663663
</Parameters>
664664
<Docs>
665-
<param name="disposing">To be added.</param>
666-
<summary>To be added.</summary>
665+
<param name="disposing">
666+
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
667+
<summary>Releases the unmanaged resources used by the <see cref="T:System.Data.Common.DbCommand" /> and optionally releases the managed resources.</summary>
667668
<remarks>To be added.</remarks>
668669
</Docs>
669670
</Member>

‎xml/System.Data.Common/DbConnection.xml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -948,7 +948,7 @@
948948
</ReturnValue>
949949
<Parameters />
950950
<Docs>
951-
<summary>To be added.</summary>
951+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
952952
<remarks>To be added.</remarks>
953953
</Docs>
954954
</Member>
@@ -978,8 +978,9 @@
978978
<Parameter Name="disposing" Type="System.Boolean" Index="0" FrameworkAlternate="dotnet-uwp-10.0;netcore-1.0;netcore-1.1" />
979979
</Parameters>
980980
<Docs>
981-
<param name="disposing">To be added.</param>
982-
<summary>To be added.</summary>
981+
<param name="disposing">
982+
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
983+
<summary>Releases the unmanaged resources used by the <see cref="T:System.Data.Common.DbConnection" /> and optionally releases the managed resources.</summary>
983984
<remarks>To be added.</remarks>
984985
</Docs>
985986
</Member>

‎xml/System.Data.Common/DbConnectionStringBuilder.xml‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1580,8 +1580,9 @@ jet oledb:system database=system.mdw
15801580
<ReturnType>System.Boolean</ReturnType>
15811581
</ReturnValue>
15821582
<Docs>
1583-
<summary>To be added.</summary>
1584-
<value>To be added.</value>
1583+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IDictionary" /> object has a fixed size.</summary>
1584+
<value>
1585+
<see langword="true" /> if the <see cref="T:System.Collections.IDictionary" /> object has a fixed size; otherwise, <see langword="false" />.</value>
15851586
<remarks>To be added.</remarks>
15861587
</Docs>
15871588
</Member>
@@ -1611,8 +1612,9 @@ jet oledb:system database=system.mdw
16111612
<ReturnType>System.Boolean</ReturnType>
16121613
</ReturnValue>
16131614
<Docs>
1614-
<summary>To be added.</summary>
1615-
<value>To be added.</value>
1615+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IDictionary" /> is read-only.</summary>
1616+
<value>
1617+
<see langword="true" /> if the <see cref="T:System.Collections.IDictionary" /> is read-only; otherwise, <see langword="false" />.</value>
16161618
<remarks>To be added.</remarks>
16171619
</Docs>
16181620
</Member>

‎xml/System.Data.Common/DbParameter.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -698,9 +698,10 @@ FieldName = @OriginalFieldName
698698
<ReturnType>System.Data.DataRowVersion</ReturnType>
699699
</ReturnValue>
700700
<Docs>
701-
<summary>To be added.</summary>
702-
<value>To be added.</value>
701+
<summary>Gets or sets the <see cref="T:System.Data.DataRowVersion" /> to use when loading <see cref="T:System.Data.IDataParameter.Value" />.</summary>
702+
<value>One of the <see cref="T:System.Data.DataRowVersion" /> values. The default is <see langword="Current" />.</value>
703703
<remarks>To be added.</remarks>
704+
<exception cref="T:System.ArgumentException">The property was not set to one of the <see cref="T:System.Data.DataRowVersion" /> values.</exception>
704705
</Docs>
705706
</Member>
706707
<Member MemberName="System.Data.IDbDataParameter.Precision">

‎xml/System.Data.Common/DbParameterCollection.xml‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1293,8 +1293,9 @@
12931293
<ReturnType>System.Boolean</ReturnType>
12941294
</ReturnValue>
12951295
<Docs>
1296-
<summary>To be added.</summary>
1297-
<value>To be added.</value>
1296+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
1297+
<value>
1298+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
12981299
<remarks>To be added.</remarks>
12991300
</Docs>
13001301
</Member>
@@ -1324,8 +1325,9 @@
13241325
<ReturnType>System.Boolean</ReturnType>
13251326
</ReturnValue>
13261327
<Docs>
1327-
<summary>To be added.</summary>
1328-
<value>To be added.</value>
1328+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IList" /> has a fixed size.</summary>
1329+
<value>
1330+
<see langword="true" /> if the <see cref="T:System.Collections.IList" /> has a fixed size; otherwise, <see langword="false" />.</value>
13291331
<remarks>To be added.</remarks>
13301332
</Docs>
13311333
</Member>
@@ -1355,8 +1357,9 @@
13551357
<ReturnType>System.Boolean</ReturnType>
13561358
</ReturnValue>
13571359
<Docs>
1358-
<summary>To be added.</summary>
1359-
<value>To be added.</value>
1360+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IList" /> is read-only.</summary>
1361+
<value>
1362+
<see langword="true" /> if the <see cref="T:System.Collections.IList" /> is read-only; otherwise, <see langword="false" />.</value>
13601363
<remarks>To be added.</remarks>
13611364
</Docs>
13621365
</Member>

‎xml/System.Data.SqlClient/SqlBulkCopyColumnMappingCollection.xml‎

Lines changed: 72 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -564,8 +564,8 @@
564564
<ReturnType>System.Int32</ReturnType>
565565
</ReturnValue>
566566
<Docs>
567-
<summary>To be added.</summary>
568-
<value>To be added.</value>
567+
<summary>Gets the number of elements contained in the <see cref="T:System.Data.SqlClient.SqlBulkCopyColumnMappingCollection" />.</summary>
568+
<value>The number of elements contained in the <see cref="T:System.Data.SqlClient.SqlBulkCopyColumnMappingCollection" />.</value>
569569
<remarks>To be added.</remarks>
570570
</Docs>
571571
</Member>
@@ -596,8 +596,8 @@
596596
</ReturnValue>
597597
<Parameters />
598598
<Docs>
599-
<summary>To be added.</summary>
600-
<returns>To be added.</returns>
599+
<summary>Returns an enumerator that iterates through a collection.</summary>
600+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
601601
<remarks>To be added.</remarks>
602602
</Docs>
603603
</Member>
@@ -892,10 +892,24 @@
892892
<Parameter Name="index" Type="System.Int32" Index="1" FrameworkAlternate="netcore-1.0;netcore-1.1" />
893893
</Parameters>
894894
<Docs>
895-
<param name="array">To be added.</param>
896-
<param name="index">To be added.</param>
897-
<summary>To be added.</summary>
895+
<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.ICollection" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
896+
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
897+
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
898898
<remarks>To be added.</remarks>
899+
<exception cref="T:System.ArgumentNullException">
900+
<paramref name="array" /> is <see langword="null" />.</exception>
901+
<exception cref="T:System.ArgumentOutOfRangeException">
902+
<paramref name="index" /> is less than zero.</exception>
903+
<exception cref="T:System.ArgumentException">
904+
<paramref name="array" /> is multidimensional.
905+
906+
-or-
907+
908+
The number of elements in the source <see cref="T:System.Collections.ICollection" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.
909+
910+
-or-
911+
912+
The type of the source <see cref="T:System.Collections.ICollection" /> cannot be cast automatically to the type of the destination <paramref name="array" />.</exception>
899913
</Docs>
900914
</Member>
901915
<Member MemberName="System.Collections.ICollection.IsSynchronized">
@@ -924,8 +938,9 @@
924938
<ReturnType>System.Boolean</ReturnType>
925939
</ReturnValue>
926940
<Docs>
927-
<summary>To be added.</summary>
928-
<value>To be added.</value>
941+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
942+
<value>
943+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
929944
<remarks>To be added.</remarks>
930945
</Docs>
931946
</Member>
@@ -955,8 +970,8 @@
955970
<ReturnType>System.Object</ReturnType>
956971
</ReturnValue>
957972
<Docs>
958-
<summary>To be added.</summary>
959-
<value>To be added.</value>
973+
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
974+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
960975
<remarks>To be added.</remarks>
961976
</Docs>
962977
</Member>
@@ -989,10 +1004,15 @@
9891004
<Parameter Name="value" Type="System.Object" Index="0" FrameworkAlternate="netcore-1.0;netcore-1.1" />
9901005
</Parameters>
9911006
<Docs>
992-
<param name="value">To be added.</param>
993-
<summary>To be added.</summary>
994-
<returns>To be added.</returns>
1007+
<param name="value">The object to add to the <see cref="T:System.Collections.IList" />.</param>
1008+
<summary>Adds an item to the <see cref="T:System.Collections.IList" />.</summary>
1009+
<returns>The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.</returns>
9951010
<remarks>To be added.</remarks>
1011+
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.IList" /> is read-only.
1012+
1013+
-or-
1014+
1015+
The <see cref="T:System.Collections.IList" /> has a fixed size.</exception>
9961016
</Docs>
9971017
</Member>
9981018
<Member MemberName="System.Collections.IList.Contains">
@@ -1024,9 +1044,10 @@
10241044
<Parameter Name="value" Type="System.Object" Index="0" FrameworkAlternate="netcore-1.0;netcore-1.1" />
10251045
</Parameters>
10261046
<Docs>
1027-
<param name="value">To be added.</param>
1028-
<summary>To be added.</summary>
1029-
<returns>To be added.</returns>
1047+
<param name="value">The object to locate in the <see cref="T:System.Collections.IList" />.</param>
1048+
<summary>Determines whether the <see cref="T:System.Collections.IList" /> contains a specific value.</summary>
1049+
<returns>
1050+
<see langword="true" /> if the <see cref="T:System.Object" /> is found in the <see cref="T:System.Collections.IList" />; otherwise, <see langword="false" />.</returns>
10301051
<remarks>To be added.</remarks>
10311052
</Docs>
10321053
</Member>
@@ -1059,9 +1080,9 @@
10591080
<Parameter Name="value" Type="System.Object" Index="0" FrameworkAlternate="netcore-1.0;netcore-1.1" />
10601081
</Parameters>
10611082
<Docs>
1062-
<param name="value">To be added.</param>
1063-
<summary>To be added.</summary>
1064-
<returns>To be added.</returns>
1083+
<param name="value">The object to locate in the <see cref="T:System.Collections.IList" />.</param>
1084+
<summary>Determines the index of a specific item in the <see cref="T:System.Collections.IList" />.</summary>
1085+
<returns>The index of <paramref name="value" /> if found in the list; otherwise, -1.</returns>
10651086
<remarks>To be added.</remarks>
10661087
</Docs>
10671088
</Member>
@@ -1095,10 +1116,19 @@
10951116
<Parameter Name="value" Type="System.Object" Index="1" FrameworkAlternate="netcore-1.0;netcore-1.1" />
10961117
</Parameters>
10971118
<Docs>
1098-
<param name="index">To be added.</param>
1099-
<param name="value">To be added.</param>
1100-
<summary>To be added.</summary>
1119+
<param name="index">The zero-based index at which <paramref name="value" /> should be inserted.</param>
1120+
<param name="value">The object to insert into the <see cref="T:System.Collections.IList" />.</param>
1121+
<summary>Inserts an item to the <see cref="T:System.Collections.IList" /> at the specified index.</summary>
11011122
<remarks>To be added.</remarks>
1123+
<exception cref="T:System.ArgumentOutOfRangeException">
1124+
<paramref name="index" /> is not a valid index in the <see cref="T:System.Collections.IList" />.</exception>
1125+
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.IList" /> is read-only.
1126+
1127+
-or-
1128+
1129+
The <see cref="T:System.Collections.IList" /> has a fixed size.</exception>
1130+
<exception cref="T:System.NullReferenceException">
1131+
<paramref name="value" /> is null reference in the <see cref="T:System.Collections.IList" />.</exception>
11021132
</Docs>
11031133
</Member>
11041134
<Member MemberName="System.Collections.IList.IsFixedSize">
@@ -1127,8 +1157,9 @@
11271157
<ReturnType>System.Boolean</ReturnType>
11281158
</ReturnValue>
11291159
<Docs>
1130-
<summary>To be added.</summary>
1131-
<value>To be added.</value>
1160+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IList" /> has a fixed size.</summary>
1161+
<value>
1162+
<see langword="true" /> if the <see cref="T:System.Collections.IList" /> has a fixed size; otherwise, <see langword="false" />.</value>
11321163
<remarks>To be added.</remarks>
11331164
</Docs>
11341165
</Member>
@@ -1158,8 +1189,9 @@
11581189
<ReturnType>System.Boolean</ReturnType>
11591190
</ReturnValue>
11601191
<Docs>
1161-
<summary>To be added.</summary>
1162-
<value>To be added.</value>
1192+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.IList" /> is read-only.</summary>
1193+
<value>
1194+
<see langword="true" /> if the <see cref="T:System.Collections.IList" /> is read-only; otherwise, <see langword="false" />.</value>
11631195
<remarks>To be added.</remarks>
11641196
</Docs>
11651197
</Member>
@@ -1192,10 +1224,13 @@
11921224
<Parameter Name="index" Type="System.Int32" Index="0" FrameworkAlternate="netcore-1.0;netcore-1.1" />
11931225
</Parameters>
11941226
<Docs>
1195-
<param name="index">To be added.</param>
1196-
<summary>To be added.</summary>
1197-
<value>To be added.</value>
1227+
<param name="index">The zero-based index of the element to get or set.</param>
1228+
<summary>Gets or sets the element at the specified index.</summary>
1229+
<value>The element at the specified index.</value>
11981230
<remarks>To be added.</remarks>
1231+
<exception cref="T:System.ArgumentOutOfRangeException">
1232+
<paramref name="index" /> is not a valid index in the <see cref="T:System.Collections.IList" />.</exception>
1233+
<exception cref="T:System.NotSupportedException">The property is set and the <see cref="T:System.Collections.IList" /> is read-only.</exception>
11991234
</Docs>
12001235
</Member>
12011236
<Member MemberName="System.Collections.IList.Remove">
@@ -1227,9 +1262,14 @@
12271262
<Parameter Name="value" Type="System.Object" Index="0" FrameworkAlternate="netcore-1.0;netcore-1.1" />
12281263
</Parameters>
12291264
<Docs>
1230-
<param name="value">To be added.</param>
1231-
<summary>To be added.</summary>
1265+
<param name="value">The object to remove from the <see cref="T:System.Collections.IList" />.</param>
1266+
<summary>Removes the first occurrence of a specific object from the <see cref="T:System.Collections.IList" />.</summary>
12321267
<remarks>To be added.</remarks>
1268+
<exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.IList" /> is read-only.
1269+
1270+
-or-
1271+
1272+
The <see cref="T:System.Collections.IList" /> has a fixed size.</exception>
12331273
</Docs>
12341274
</Member>
12351275
</Members>

0 commit comments

Comments
 (0)