Skip to content

Commit 047cd73

Browse files
jozkeeRon Petrusha
jozkee
and
Ron Petrusha
committed
Adding documentation for APIs in System.Collections.Immutable targeted for 3.0 (#2860)
* Adding documentation for APIs in System.Collections.Immutable targeted for 3.0 * Apply suggestions from code review Committing Ron's suggestions. Co-Authored-By: Ron Petrusha <[email protected]>
1 parent 9fdf549 commit 047cd73

File tree

7 files changed

+36
-36
lines changed

7 files changed

+36
-36
lines changed

‎xml/System.Collections.Immutable/ImmutableArray.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -901,12 +901,12 @@ This overload allows helper methods or custom builder classes to efficiently avo
901901
<Parameter Name="builder" Type="System.Collections.Immutable.ImmutableArray&lt;TSource&gt;+Builder" RefType="this" Index="0" FrameworkAlternate="netcore-3.0" />
902902
</Parameters>
903903
<Docs>
904-
<typeparam name="TSource">To be added.</typeparam>
905-
<param name="builder">To be added.</param>
906-
<summary>To be added.</summary>
907-
<returns>To be added.</returns>
904+
<typeparam name="TSource">The type of elements contained in the immutable array.</typeparam>
905+
<param name="builder">The builder to create the immutable array from.</param>
906+
<summary>Creates an immutable array from the current contents of the builder's array.</summary>
907+
<returns>An immutable array that contains the current contents of the builder's array.</returns>
908908
<remarks>To be added.</remarks>
909909
</Docs>
910910
</Member>
911911
</Members>
912-
</Type>
912+
</Type>

‎xml/System.Collections.Immutable/ImmutableArray`1.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,8 @@
252252
</ReturnValue>
253253
<Parameters />
254254
<Docs>
255-
<summary>To be added.</summary>
256-
<returns>To be added.</returns>
255+
<summary>Creates a new read-only memory region over this immutable array.</summary>
256+
<returns>The read-only memory representation of this immutable array.</returns>
257257
<remarks>To be added.</remarks>
258258
</Docs>
259259
</Member>
@@ -274,8 +274,8 @@
274274
</ReturnValue>
275275
<Parameters />
276276
<Docs>
277-
<summary>To be added.</summary>
278-
<returns>To be added.</returns>
277+
<summary>Creates a new read-only span over this immutable array.</summary>
278+
<returns>The read-only span representation of this immutable array.</returns>
279279
<remarks>To be added.</remarks>
280280
</Docs>
281281
</Member>

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -531,11 +531,11 @@
531531
<Parameter Name="builder" Type="System.Collections.Immutable.ImmutableDictionary&lt;TKey,TValue&gt;+Builder" RefType="this" Index="0" FrameworkAlternate="netcore-3.0" />
532532
</Parameters>
533533
<Docs>
534-
<typeparam name="TKey">To be added.</typeparam>
535-
<typeparam name="TValue">To be added.</typeparam>
536-
<param name="builder">To be added.</param>
537-
<summary>To be added.</summary>
538-
<returns>To be added.</returns>
534+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
535+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
536+
<param name="builder">The builder to create the immutable dictionary from.</param>
537+
<summary>Creates an immutable dictionary from the current contents of the builder's dictionary.</summary>
538+
<returns>An immutable dictionary that contains the current contents in the builder's dictionary.</returns>
539539
<remarks>To be added.</remarks>
540540
</Docs>
541541
</Member>
@@ -828,4 +828,4 @@
828828
</Docs>
829829
</Member>
830830
</Members>
831-
</Type>
831+
</Type>

‎xml/System.Collections.Immutable/ImmutableHashSet.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -433,10 +433,10 @@
433433
<Parameter Name="builder" Type="System.Collections.Immutable.ImmutableHashSet&lt;TSource&gt;+Builder" RefType="this" Index="0" FrameworkAlternate="netcore-3.0" />
434434
</Parameters>
435435
<Docs>
436-
<typeparam name="TSource">To be added.</typeparam>
437-
<param name="builder">To be added.</param>
438-
<summary>To be added.</summary>
439-
<returns>To be added.</returns>
436+
<typeparam name="TSource">The type of the elements in the hash set.</typeparam>
437+
<param name="builder">The builder to create the immutable hash set from.</param>
438+
<summary>Creates an immutable hash set from the current contents of the builder's set.</summary>
439+
<returns>An immutable hash set that contains the current contents in the builder's set.</returns>
440440
<remarks>To be added.</remarks>
441441
</Docs>
442442
</Member>
@@ -477,4 +477,4 @@
477477
</Docs>
478478
</Member>
479479
</Members>
480-
</Type>
480+
</Type>

‎xml/System.Collections.Immutable/ImmutableList.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -666,12 +666,12 @@
666666
<Parameter Name="builder" Type="System.Collections.Immutable.ImmutableList&lt;TSource&gt;+Builder" RefType="this" Index="0" FrameworkAlternate="netcore-3.0" />
667667
</Parameters>
668668
<Docs>
669-
<typeparam name="TSource">To be added.</typeparam>
670-
<param name="builder">To be added.</param>
671-
<summary>To be added.</summary>
672-
<returns>To be added.</returns>
669+
<typeparam name="TSource">The type of the elements in the list.</typeparam>
670+
<param name="builder">The builder to create the immutable list from.</param>
671+
<summary>Creates an immutable list from the current contents of the builder's collection.</summary>
672+
<returns>An immutable list that contains the current contents in the builder's collection.</returns>
673673
<remarks>To be added.</remarks>
674674
</Docs>
675675
</Member>
676676
</Members>
677-
</Type>
677+
</Type>

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -412,11 +412,11 @@
412412
<Parameter Name="builder" Type="System.Collections.Immutable.ImmutableSortedDictionary&lt;TKey,TValue&gt;+Builder" RefType="this" Index="0" FrameworkAlternate="netcore-3.0" />
413413
</Parameters>
414414
<Docs>
415-
<typeparam name="TKey">To be added.</typeparam>
416-
<typeparam name="TValue">To be added.</typeparam>
417-
<param name="builder">To be added.</param>
418-
<summary>To be added.</summary>
419-
<returns>To be added.</returns>
415+
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
416+
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
417+
<param name="builder">The builder to create the immutable sorted dictionary from.</param>
418+
<summary>Creates an immutable sorted dictionary from the current contents of the builder's dictionary.</summary>
419+
<returns>An immutable sorted dictionary that contains the current contents in the builder's dictionary.</returns>
420420
<remarks>To be added.</remarks>
421421
</Docs>
422422
</Member>
@@ -631,4 +631,4 @@
631631
</Docs>
632632
</Member>
633633
</Members>
634-
</Type>
634+
</Type>

‎xml/System.Collections.Immutable/ImmutableSortedSet.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -433,10 +433,10 @@
433433
<Parameter Name="builder" Type="System.Collections.Immutable.ImmutableSortedSet&lt;TSource&gt;+Builder" RefType="this" Index="0" FrameworkAlternate="netcore-3.0" />
434434
</Parameters>
435435
<Docs>
436-
<typeparam name="TSource">To be added.</typeparam>
437-
<param name="builder">To be added.</param>
438-
<summary>To be added.</summary>
439-
<returns>To be added.</returns>
436+
<typeparam name="TSource">The type of the elements in the immutable sorted set.</typeparam>
437+
<param name="builder">The builder to create the immutable sorted set from.</param>
438+
<summary>Creates an immutable sorted set from the current contents of the builder's set.</summary>
439+
<returns>An immutable sorted set that contains the current contents in the builder's set.</returns>
440440
<remarks>To be added.</remarks>
441441
</Docs>
442442
</Member>
@@ -477,4 +477,4 @@
477477
</Docs>
478478
</Member>
479479
</Members>
480-
</Type>
480+
</Type>

0 commit comments

Comments
 (0)