Skip to content

Commit e4d0d15

Browse files
carlossanlopmairaw
authored andcommitted
Automatically port System.Data triple slash comments (#2674)
* Automatically port System.Data triple slash comments * suggestions by mairaw Co-Authored-By: Maira Wenzel <[email protected]> * Suggestions by mairaw. * suggestions by divega and mairaw * suggestion by divega * remove 2nd sentence in CreateChildView exceptions * Update DataRowView.xml
1 parent 67552e6 commit e4d0d15

File tree

4 files changed

+27
-18
lines changed

4 files changed

+27
-18
lines changed

xml/System.Data/ConstraintCollection.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -955,8 +955,8 @@
955955
<ReturnType>System.Collections.ArrayList</ReturnType>
956956
</ReturnValue>
957957
<Docs>
958-
<summary>To be added.</summary>
959-
<value>To be added.</value>
958+
<summary>Gets the items of the collection as a list.</summary>
959+
<value>The items of the collection as a list.</value>
960960
<remarks>To be added.</remarks>
961961
</Docs>
962962
</Member>
@@ -985,8 +985,8 @@
985985
<Parameter Name="ccevent" Type="System.ComponentModel.CollectionChangeEventArgs" Index="0" FrameworkAlternate="netframework-1.1" />
986986
</Parameters>
987987
<Docs>
988-
<param name="ccevent">To be added.</param>
989-
<summary>To be added.</summary>
988+
<param name="ccevent">The event data.</param>
989+
<summary>Raises the <see cref="E:System.Data.ConstraintCollection.CollectionChanged" /> event.</summary>
990990
<remarks>To be added.</remarks>
991991
</Docs>
992992
</Member>
@@ -1174,4 +1174,4 @@
11741174
</Docs>
11751175
</Member>
11761176
</Members>
1177-
</Type>
1177+
</Type>

xml/System.Data/DataColumnCollection.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -950,8 +950,8 @@ Another column's expression depends on this column. </exception>
950950
<ReturnType>System.Collections.ArrayList</ReturnType>
951951
</ReturnValue>
952952
<Docs>
953-
<summary>To be added.</summary>
954-
<value>To be added.</value>
953+
<summary>Gets the items of the collection as a list.</summary>
954+
<value>The items of the collection as a list.</value>
955955
<remarks>To be added.</remarks>
956956
</Docs>
957957
</Member>
@@ -980,8 +980,8 @@ Another column's expression depends on this column. </exception>
980980
<Parameter Name="ccevent" Type="System.ComponentModel.CollectionChangeEventArgs" Index="0" FrameworkAlternate="netframework-1.1" />
981981
</Parameters>
982982
<Docs>
983-
<param name="ccevent">To be added.</param>
984-
<summary>To be added.</summary>
983+
<param name="ccevent">The event data.</param>
984+
<summary>Raises the <see cref="M:System.Data.DataColumnCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs)" /> event.</summary>
985985
<remarks>To be added.</remarks>
986986
</Docs>
987987
</Member>
@@ -1200,4 +1200,4 @@ Another column's expression depends on this column. </exception>
12001200
</Docs>
12011201
</Member>
12021202
</Members>
1203-
</Type>
1203+
</Type>

xml/System.Data/DataRowView.xml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@
308308
<summary>Returns a <see cref="T:System.Data.DataView" /> for the child <see cref="T:System.Data.DataTable" /> with the specified <see cref="T:System.Data.DataRelation" /> and parent.</summary>
309309
<returns>A <see cref="T:System.Data.DataView" /> for the child <see cref="T:System.Data.DataTable" />.</returns>
310310
<remarks>To be added.</remarks>
311+
<exception cref="T:System.ArgumentException"><paramref name="relation" /> is <see langword="null" />.</exception>
311312
</Docs>
312313
</Member>
313314
<Member MemberName="CreateChildView">
@@ -342,10 +343,11 @@
342343
</Parameters>
343344
<Docs>
344345
<param name="relationName">A string containing the <see cref="T:System.Data.DataRelation" /> name.</param>
345-
<param name="followParent">The parent</param>
346+
<param name="followParent"><see langword="true" /> to keep the created child view in sync with the parent; otherwise, <see langword="false" />.</param>
346347
<summary>Returns a <see cref="T:System.Data.DataView" /> for the child <see cref="T:System.Data.DataTable" /> with the specified <see cref="T:System.Data.DataRelation" /> name and parent.</summary>
347348
<returns>a <see cref="T:System.Data.DataView" /> for the child <see cref="T:System.Data.DataTable" />.</returns>
348349
<remarks>To be added.</remarks>
350+
<exception cref="T:System.ArgumentException"><paramref name="relation" /> is <see langword="null" />.</exception>
349351
</Docs>
350352
</Member>
351353
<Member MemberName="DataView">
@@ -692,7 +694,7 @@
692694
<Parameter Name="ndx" Type="System.Int32" />
693695
</Parameters>
694696
<Docs>
695-
<param name="ndx">The specified column.</param>
697+
<param name="ndx">The column index.</param>
696698
<summary>Gets or sets a value in a specified column.</summary>
697699
<value>The value of the column.</value>
698700
<remarks>
@@ -706,6 +708,8 @@
706708
707709
]]></format>
708710
</remarks>
711+
<exception cref="T:System.Data.DataException">The <see cref="P:System.Data.DataRowView.DataView" /> doesn't allow edits and <see cref="T:System.Data.DataRowView" /> is not new.</exception>
712+
<exception cref="T:System.IndexOutOfRangeException">No column corresponds to that index value.</exception>
709713
</Docs>
710714
</Member>
711715
<Member MemberName="Item">
@@ -754,6 +758,11 @@
754758
755759
]]></format>
756760
</remarks>
761+
<exception cref="T:System.ArgumentException">A column with the specified name or relation was not found.
762+
763+
-or-
764+
765+
The <see cref="P:System.Data.DataRowView.DataView" /> doesn't allow edits and <see cref="T:System.Data.DataRowView" /> is not new.</exception>
757766
</Docs>
758767
</Member>
759768
<Member MemberName="PropertyChanged">
@@ -1564,4 +1573,4 @@
15641573
</Docs>
15651574
</Member>
15661575
</Members>
1567-
</Type>
1576+
</Type>

xml/System.Data/DataTableCollection.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1128,8 +1128,8 @@
11281128
<ReturnType>System.Collections.ArrayList</ReturnType>
11291129
</ReturnValue>
11301130
<Docs>
1131-
<summary>To be added.</summary>
1132-
<value>To be added.</value>
1131+
<summary>Gets the items of the collection as a list.</summary>
1132+
<value>The items of the collection as a list.</value>
11331133
<remarks>To be added.</remarks>
11341134
</Docs>
11351135
</Member>
@@ -1158,8 +1158,8 @@
11581158
<Parameter Name="ccevent" Type="System.ComponentModel.CollectionChangeEventArgs" Index="0" FrameworkAlternate="netframework-1.1" />
11591159
</Parameters>
11601160
<Docs>
1161-
<param name="ccevent">To be added.</param>
1162-
<summary>To be added.</summary>
1161+
<param name="ccevent">The event data.</param>
1162+
<summary>Raises the <see cref="M:System.Data.DataTableCollection.OnCollectionChanged(System.ComponentModel.CollectionChangeEventArgs)" /> event.</summary>
11631163
<remarks>To be added.</remarks>
11641164
</Docs>
11651165
</Member>
@@ -1436,4 +1436,4 @@
14361436
</Docs>
14371437
</Member>
14381438
</Members>
1439-
</Type>
1439+
</Type>

0 commit comments

Comments
 (0)