Skip to content

Commit 771bd48

Browse files
carlossanlopmairaweiriktsarpalis
authored
Automatic port of System.Collections.Immutable (#3946)
* Automatic port of System.Collections.Immutable * suggestions by mairaw Co-Authored-By: Maira Wenzel <[email protected]> * Apply suggestions from code review Co-Authored-By: Eirik Tsarpalis <[email protected]> * overwrite -> replace * Apply suggestions from code review Co-Authored-By: Eirik Tsarpalis <[email protected]> * Reverting bad documentation to "To be added" Co-authored-by: Maira Wenzel <[email protected]> Co-authored-by: Eirik Tsarpalis <[email protected]>
1 parent 474e8d5 commit 771bd48

File tree

4 files changed

+56
-53
lines changed

4 files changed

+56
-53
lines changed

‎xml/System.Collections.Immutable/ImmutableDictionary`2+Builder.xml‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -705,8 +705,9 @@
705705
<ReturnType>System.Boolean</ReturnType>
706706
</ReturnValue>
707707
<Docs>
708-
<summary>To be added.</summary>
709-
<value>To be added.</value>
708+
<summary>Gets a value that indicates whether the collection is read-only.</summary>
709+
<value>
710+
<see langword="true" /> if the collection is read-only; otherwise, <see langword="false" />.</value>
710711
<remarks>To be added.</remarks>
711712
</Docs>
712713
</Member>
@@ -735,8 +736,8 @@
735736
<ReturnType>System.Collections.Generic.ICollection&lt;TKey&gt;</ReturnType>
736737
</ReturnValue>
737738
<Docs>
738-
<summary>To be added.</summary>
739-
<value>To be added.</value>
739+
<summary>Gets a collection containing the keys of the generic dictionary.</summary>
740+
<value>A collection containing the keys of the object that implements the generic dictionary.</value>
740741
<remarks>To be added.</remarks>
741742
</Docs>
742743
</Member>
@@ -765,8 +766,8 @@
765766
<ReturnType>System.Collections.Generic.ICollection&lt;TValue&gt;</ReturnType>
766767
</ReturnValue>
767768
<Docs>
768-
<summary>To be added.</summary>
769-
<value>To be added.</value>
769+
<summary>Gets a collection containing the values in the generic dictionary.</summary>
770+
<value>A collection containing the values in the object that implements the generic dictionary.</value>
770771
<remarks>To be added.</remarks>
771772
</Docs>
772773
</Member>
@@ -796,8 +797,8 @@
796797
</ReturnValue>
797798
<Parameters />
798799
<Docs>
799-
<summary>To be added.</summary>
800-
<returns>To be added.</returns>
800+
<summary>Returns an enumerator that iterates through the collection.</summary>
801+
<returns>An enumerator that can be used to iterate through the collection.</returns>
801802
<remarks>To be added.</remarks>
802803
</Docs>
803804
</Member>

‎xml/System.Collections.Immutable/ImmutableDictionary`2.xml‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -825,9 +825,9 @@
825825
<Parameter Name="value" Type="TValue" />
826826
</Parameters>
827827
<Docs>
828-
<param name="key">To be added.</param>
829-
<param name="value">To be added.</param>
830-
<summary>To be added.</summary>
828+
<param name="key">The object to use as the key of the element to add.</param>
829+
<param name="value">The object to use as the value of the element to add.</param>
830+
<summary>Adds an element with the provided key and value to the immutable dictionary.</summary>
831831
<remarks>To be added.</remarks>
832832
</Docs>
833833
</Member>
@@ -859,9 +859,9 @@
859859
<Parameter Name="key" Type="TKey" />
860860
</Parameters>
861861
<Docs>
862-
<param name="key">To be added.</param>
863-
<summary>To be added.</summary>
864-
<value>To be added.</value>
862+
<param name="key">The type of the key.</param>
863+
<summary>Gets or sets the <typeparamref name="TValue" /> with the specified key.</summary>
864+
<value>An object of type <typeparamref name="TValue" /> associated with the <paramref name="key" />.</value>
865865
<remarks>To be added.</remarks>
866866
</Docs>
867867
</Member>
@@ -890,8 +890,8 @@
890890
<ReturnType>System.Collections.Generic.ICollection&lt;TKey&gt;</ReturnType>
891891
</ReturnValue>
892892
<Docs>
893-
<summary>To be added.</summary>
894-
<value>To be added.</value>
893+
<summary>Gets the keys.</summary>
894+
<value>A collection containing the keys.</value>
895895
<remarks>To be added.</remarks>
896896
</Docs>
897897
</Member>
@@ -923,9 +923,10 @@
923923
<Parameter Name="key" Type="TKey" />
924924
</Parameters>
925925
<Docs>
926-
<param name="key">To be added.</param>
927-
<summary>To be added.</summary>
928-
<returns>To be added.</returns>
926+
<param name="key">The key of the element to remove.</param>
927+
<summary>Removes the element with the specified key from the generic dictionary.</summary>
928+
<returns>
929+
<see langword="true" /> if the element is successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="key" /> was not found in the original generic dictionary.</returns>
929930
<remarks>To be added.</remarks>
930931
</Docs>
931932
</Member>
@@ -954,8 +955,8 @@
954955
<ReturnType>System.Collections.Generic.ICollection&lt;TValue&gt;</ReturnType>
955956
</ReturnValue>
956957
<Docs>
957-
<summary>To be added.</summary>
958-
<value>To be added.</value>
958+
<summary>Gets the values.</summary>
959+
<value>A collection containing the values.</value>
959960
<remarks>To be added.</remarks>
960961
</Docs>
961962
</Member>
@@ -985,8 +986,8 @@
985986
</ReturnValue>
986987
<Parameters />
987988
<Docs>
988-
<summary>To be added.</summary>
989-
<returns>To be added.</returns>
989+
<summary>Returns an enumerator that iterates through the collection.</summary>
990+
<returns>An enumerator that can be used to iterate through the collection.</returns>
990991
<remarks>To be added.</remarks>
991992
</Docs>
992993
</Member>
@@ -1593,8 +1594,8 @@
15931594
</ReturnValue>
15941595
<Parameters />
15951596
<Docs>
1596-
<summary>To be added.</summary>
1597-
<returns>To be added.</returns>
1597+
<summary>Retrieves an empty dictionary that has the same ordering and key-value comparison rules as this dictionary instance.</summary>
1598+
<returns>The immutable dictionary instance.</returns>
15981599
<remarks>To be added.</remarks>
15991600
</Docs>
16001601
</Member>
@@ -1730,9 +1731,9 @@
17301731
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;TKey,TValue&gt;&gt;" />
17311732
</Parameters>
17321733
<Docs>
1733-
<param name="items">To be added.</param>
1734-
<summary>To be added.</summary>
1735-
<returns>To be added.</returns>
1734+
<param name="items">The key-value pairs to set on the map. Any keys that conflict with existing keys will replace the previous values.</param>
1735+
<summary>Applies a given set of key-value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary.</summary>
1736+
<returns>A copy of the immutable dictionary with updated key-value pairs.</returns>
17361737
<remarks>To be added.</remarks>
17371738
</Docs>
17381739
</Member>

‎xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Builder.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -681,8 +681,8 @@
681681
<ReturnType>System.Boolean</ReturnType>
682682
</ReturnValue>
683683
<Docs>
684-
<summary>To be added.</summary>
685-
<value>To be added.</value>
684+
<summary>Gets a value that indicates whether this instance is read-only.</summary>
685+
<value>Always <see langword="false" />.</value>
686686
<remarks>To be added.</remarks>
687687
</Docs>
688688
</Member>

‎xml/System.Collections.Immutable/ImmutableSortedDictionary`2.xml‎

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -807,9 +807,9 @@
807807
<Parameter Name="value" Type="TValue" />
808808
</Parameters>
809809
<Docs>
810-
<param name="key">To be added.</param>
811-
<param name="value">To be added.</param>
812-
<summary>To be added.</summary>
810+
<param name="key">The object to use as the key of the element to add.</param>
811+
<param name="value">The object to use as the value of the element to add.</param>
812+
<summary>Adds an element with the provided key and value to the generic dictionary.</summary>
813813
<remarks>To be added.</remarks>
814814
</Docs>
815815
</Member>
@@ -842,8 +842,8 @@
842842
</Parameters>
843843
<Docs>
844844
<param name="key">To be added.</param>
845-
<summary>To be added.</summary>
846-
<value>To be added.</value>
845+
<summary>Gets or sets the <typeparamref name="TValue" /> with the specified key.</summary>
846+
<value>An object of type <typeparamref name="TValue" /> associated with the <paramref name="key" />.</value>
847847
<remarks>To be added.</remarks>
848848
</Docs>
849849
</Member>
@@ -872,8 +872,8 @@
872872
<ReturnType>System.Collections.Generic.ICollection&lt;TKey&gt;</ReturnType>
873873
</ReturnValue>
874874
<Docs>
875-
<summary>To be added.</summary>
876-
<value>To be added.</value>
875+
<summary>Gets the keys.</summary>
876+
<value>A collection containing the keys.</value>
877877
<remarks>To be added.</remarks>
878878
</Docs>
879879
</Member>
@@ -905,9 +905,10 @@
905905
<Parameter Name="key" Type="TKey" />
906906
</Parameters>
907907
<Docs>
908-
<param name="key">To be added.</param>
909-
<summary>To be added.</summary>
910-
<returns>To be added.</returns>
908+
<param name="key">The key of the element to remove.</param>
909+
<summary>Removes the element with the specified key from the generic dictionary.</summary>
910+
<returns>
911+
<see langword="true" /> if the element is successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="key" /> was not found in the original generic dictionary.</returns>
911912
<remarks>To be added.</remarks>
912913
</Docs>
913914
</Member>
@@ -936,8 +937,8 @@
936937
<ReturnType>System.Collections.Generic.ICollection&lt;TValue&gt;</ReturnType>
937938
</ReturnValue>
938939
<Docs>
939-
<summary>To be added.</summary>
940-
<value>To be added.</value>
940+
<summary>Gets the values.</summary>
941+
<value>A collection containing the values.</value>
941942
<remarks>To be added.</remarks>
942943
</Docs>
943944
</Member>
@@ -967,8 +968,8 @@
967968
</ReturnValue>
968969
<Parameters />
969970
<Docs>
970-
<summary>To be added.</summary>
971-
<returns>To be added.</returns>
971+
<summary>Returns an enumerator that iterates through the collection.</summary>
972+
<returns>An enumerator that can be used to iterate through the collection.</returns>
972973
<remarks>To be added.</remarks>
973974
</Docs>
974975
</Member>
@@ -1511,7 +1512,7 @@
15111512
<param name="key">To be added.</param>
15121513
<param name="value">To be added.</param>
15131514
<summary>To be added.</summary>
1514-
<returns>To be added.</returns>
1515+
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
15151516
<remarks>To be added.</remarks>
15161517
</Docs>
15171518
</Member>
@@ -1545,7 +1546,7 @@
15451546
<Docs>
15461547
<param name="pairs">To be added.</param>
15471548
<summary>To be added.</summary>
1548-
<returns>To be added.</returns>
1549+
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
15491550
<remarks>To be added.</remarks>
15501551
</Docs>
15511552
</Member>
@@ -1576,7 +1577,7 @@
15761577
<Parameters />
15771578
<Docs>
15781579
<summary>To be added.</summary>
1579-
<returns>To be added.</returns>
1580+
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
15801581
<remarks>To be added.</remarks>
15811582
</Docs>
15821583
</Member>
@@ -1610,7 +1611,7 @@
16101611
<Docs>
16111612
<param name="key">To be added.</param>
16121613
<summary>To be added.</summary>
1613-
<returns>To be added.</returns>
1614+
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
16141615
<remarks>To be added.</remarks>
16151616
</Docs>
16161617
</Member>
@@ -1644,7 +1645,7 @@
16441645
<Docs>
16451646
<param name="keys">To be added.</param>
16461647
<summary>To be added.</summary>
1647-
<returns>To be added.</returns>
1648+
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
16481649
<remarks>To be added.</remarks>
16491650
</Docs>
16501651
</Member>
@@ -1680,7 +1681,7 @@
16801681
<param name="key">To be added.</param>
16811682
<param name="value">To be added.</param>
16821683
<summary>To be added.</summary>
1683-
<returns>To be added.</returns>
1684+
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
16841685
<remarks>To be added.</remarks>
16851686
</Docs>
16861687
</Member>
@@ -1712,9 +1713,9 @@
17121713
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;TKey,TValue&gt;&gt;" />
17131714
</Parameters>
17141715
<Docs>
1715-
<param name="items">To be added.</param>
1716-
<summary>To be added.</summary>
1717-
<returns>To be added.</returns>
1716+
<param name="items">A set of key-value pairs to set on the map.</param>
1717+
<summary>Applies a given set of key-value pairs to an immutable dictionary, replacing any conflicting keys in the resulting dictionary.</summary>
1718+
<returns>The <see cref="T:System.Collections.Immutable.IImmutableDictionary`2" /> instance.</returns>
17181719
<remarks>To be added.</remarks>
17191720
</Docs>
17201721
</Member>

0 commit comments

Comments
 (0)