Skip to content

Commit 1cdc095

Browse files
carlossanlopmairaw
carlossanlop
and
mairaw
committed
Automatically port System.Collections and System.Drawing triple slash comments (#2681)
* Automatically port System.Collections and System.Drawing triple slash comments * suggestions by mairaw Co-Authored-By: Maira Wenzel <[email protected]>
1 parent b54b56a commit 1cdc095

File tree

5 files changed

+50
-46
lines changed

5 files changed

+50
-46
lines changed

‎xml/System.Collections.Generic/HashSet`1.xml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1006,10 +1006,12 @@
10061006
<Parameter Name="capacity" Type="System.Int32" Index="0" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
10071007
</Parameters>
10081008
<Docs>
1009-
<param name="capacity">To be added.</param>
1010-
<summary>To be added.</summary>
1011-
<returns>To be added.</returns>
1009+
<param name="capacity">The minimum capacity to ensure.</param>
1010+
<summary>Ensures that this hash set can hold the specified number of elements without growing.</summary>
1011+
<returns>The new capacity of this instance.</returns>
10121012
<remarks>To be added.</remarks>
1013+
<exception cref="T:System.ArgumentOutOfRangeException">
1014+
<paramref name="capacity" /> is less than zero.</exception>
10131015
</Docs>
10141016
</Member>
10151017
<Member MemberName="ExceptWith">
@@ -2239,4 +2241,4 @@
22392241
</Docs>
22402242
</Member>
22412243
</Members>
2242-
</Type>
2244+
</Type>

‎xml/System.Collections.ObjectModel/ObservableCollection`1.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,7 @@
422422
<Docs>
423423
<summary>Occurs when an item is added, removed, changed, moved, or the entire list is refreshed.</summary>
424424
<remarks>To be added.</remarks>
425+
<altmember cref="T:System.Collections.Specialized.INotifyCollectionChanged" />
425426
<altmember cref="E:System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged" />
426427
</Docs>
427428
</Member>
@@ -890,4 +891,4 @@
890891
</Docs>
891892
</Member>
892893
</Members>
893-
</Type>
894+
</Type>

‎xml/System.Drawing.Text/PrivateFontCollection.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,10 +175,11 @@
175175
<Parameter Name="disposing" Type="System.Boolean" />
176176
</Parameters>
177177
<Docs>
178-
<param name="disposing">To be added.</param>
179-
<summary>To be added.</summary>
178+
<param name="disposing">
179+
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
180+
<summary>Releases the unmanaged resources used by the <see cref="T:System.Drawing.Text.PrivateFontCollection" /> and optionally releases the managed resources.</summary>
180181
<remarks>To be added.</remarks>
181182
</Docs>
182183
</Member>
183184
</Members>
184-
</Type>
185+
</Type>

‎xml/System.Drawing/Size.xml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -561,10 +561,10 @@
561561
<Parameter Name="right" Type="System.Int32" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
562562
</Parameters>
563563
<Docs>
564-
<param name="left">To be added.</param>
565-
<param name="right">To be added.</param>
566-
<summary>To be added.</summary>
567-
<returns>To be added.</returns>
564+
<param name="left">The dividend.</param>
565+
<param name="right">The divisor.</param>
566+
<summary>Divides the specified <see cref="T:System.Drawing.Size" /> by the specified integer.</summary>
567+
<returns>A new <see cref="T:System.Drawing.Size" />, which contains the result of dividing <paramref name="left" />'s height by <paramref name="right" /> and <paramref name="left" />'s width by <paramref name="right" />, respectively.</returns>
568568
<remarks>To be added.</remarks>
569569
</Docs>
570570
</Member>
@@ -595,10 +595,10 @@
595595
<Parameter Name="right" Type="System.Single" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
596596
</Parameters>
597597
<Docs>
598-
<param name="left">To be added.</param>
599-
<param name="right">To be added.</param>
600-
<summary>To be added.</summary>
601-
<returns>To be added.</returns>
598+
<param name="left">The dividend.</param>
599+
<param name="right">The divisor.</param>
600+
<summary>Divides the specified <see cref="T:System.Drawing.Size" /> by the specified single-precision floating-point number.</summary>
601+
<returns>The result of dividing <paramref name="left" />'s width and height by <paramref name="right" />.</returns>
602602
<remarks>To be added.</remarks>
603603
</Docs>
604604
</Member>
@@ -817,10 +817,10 @@
817817
<Parameter Name="right" Type="System.Int32" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
818818
</Parameters>
819819
<Docs>
820-
<param name="left">To be added.</param>
821-
<param name="right">To be added.</param>
822-
<summary>To be added.</summary>
823-
<returns>To be added.</returns>
820+
<param name="left">The multiplicand.</param>
821+
<param name="right">The multiplier.</param>
822+
<summary>Multiplies the specified <see cref="T:System.Drawing.Size" /> by the specified integer.</summary>
823+
<returns>The result of multiplying <paramref name="left" />'s width and height by <paramref name="right" />.</returns>
824824
<remarks>To be added.</remarks>
825825
</Docs>
826826
</Member>
@@ -851,10 +851,10 @@
851851
<Parameter Name="right" Type="System.Single" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
852852
</Parameters>
853853
<Docs>
854-
<param name="left">To be added.</param>
855-
<param name="right">To be added.</param>
856-
<summary>To be added.</summary>
857-
<returns>To be added.</returns>
854+
<param name="left">The multiplicand.</param>
855+
<param name="right">The multiplier.</param>
856+
<summary>Multiplies the specified <see cref="T:System.Drawing.Size" /> by the specified single-precision floating-point number.</summary>
857+
<returns>The result of multiplying <paramref name="left" />'s width and height by <paramref name="right" />.</returns>
858858
<remarks>To be added.</remarks>
859859
</Docs>
860860
</Member>
@@ -885,10 +885,10 @@
885885
<Parameter Name="right" Type="System.Drawing.Size" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
886886
</Parameters>
887887
<Docs>
888-
<param name="left">To be added.</param>
889-
<param name="right">To be added.</param>
890-
<summary>To be added.</summary>
891-
<returns>To be added.</returns>
888+
<param name="left">The multiplier.</param>
889+
<param name="right">The multiplicand.</param>
890+
<summary>Multiplies the specified integer by the specified <see cref="T:System.Drawing.Size" />.</summary>
891+
<returns>The result of multiplying <paramref name="right" />'s width and height by <paramref name="left" />.</returns>
892892
<remarks>To be added.</remarks>
893893
</Docs>
894894
</Member>
@@ -919,10 +919,10 @@
919919
<Parameter Name="right" Type="System.Drawing.Size" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
920920
</Parameters>
921921
<Docs>
922-
<param name="left">To be added.</param>
923-
<param name="right">To be added.</param>
924-
<summary>To be added.</summary>
925-
<returns>To be added.</returns>
922+
<param name="left">The multiplier.</param>
923+
<param name="right">The multiplicand.</param>
924+
<summary>Multiplies the specified single-precision floating-point number by the specified <see cref="T:System.Drawing.Size" />.</summary>
925+
<returns>The result of multiplying <paramref name="right" />'s width and height by <paramref name="left" />.</returns>
926926
<remarks>To be added.</remarks>
927927
</Docs>
928928
</Member>
@@ -1215,4 +1215,4 @@
12151215
</Docs>
12161216
</Member>
12171217
</Members>
1218-
</Type>
1218+
</Type>

‎xml/System.Drawing/SizeF.xml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -574,10 +574,10 @@
574574
<Parameter Name="right" Type="System.Single" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
575575
</Parameters>
576576
<Docs>
577-
<param name="left">To be added.</param>
578-
<param name="right">To be added.</param>
579-
<summary>To be added.</summary>
580-
<returns>To be added.</returns>
577+
<param name="left">The dividend.</param>
578+
<param name="right">The divisor.</param>
579+
<summary>Divides the specified <see cref="T:System.Drawing.SizeF" /> by the specified single-precision floating-point number.</summary>
580+
<returns>The result of dividing <paramref name="left" />'s width and height by <paramref name="right" />.</returns>
581581
<remarks>To be added.</remarks>
582582
</Docs>
583583
</Member>
@@ -728,10 +728,10 @@
728728
<Parameter Name="right" Type="System.Single" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
729729
</Parameters>
730730
<Docs>
731-
<param name="left">To be added.</param>
732-
<param name="right">To be added.</param>
733-
<summary>To be added.</summary>
734-
<returns>To be added.</returns>
731+
<param name="left">The multiplicand.</param>
732+
<param name="right">The multiplier.</param>
733+
<summary>Multiplies the specified <see cref="T:System.Drawing.SizeF" /> by the specified single-precision floating-point number.</summary>
734+
<returns>The result of multiplying <paramref name="left" />'s width and height by <paramref name="right" />.</returns>
735735
<remarks>To be added.</remarks>
736736
</Docs>
737737
</Member>
@@ -762,10 +762,10 @@
762762
<Parameter Name="right" Type="System.Drawing.SizeF" Index="1" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
763763
</Parameters>
764764
<Docs>
765-
<param name="left">To be added.</param>
766-
<param name="right">To be added.</param>
767-
<summary>To be added.</summary>
768-
<returns>To be added.</returns>
765+
<param name="left">The multiplier.</param>
766+
<param name="right">The multiplicand.</param>
767+
<summary>Multiplies the specified single-precision floating-point number by the specified <see cref="T:System.Drawing.SizeF" />.</summary>
768+
<returns>The result of multiplying <paramref name="right" />'s width and height by <paramref name="left" />.</returns>
769769
<remarks>To be added.</remarks>
770770
</Docs>
771771
</Member>
@@ -1016,4 +1016,4 @@
10161016
</Docs>
10171017
</Member>
10181018
</Members>
1019-
</Type>
1019+
</Type>

0 commit comments

Comments
 (0)