Skip to content

Commit 162b1bc

Browse files
add missing API docs
1 parent 65dd96b commit 162b1bc

9 files changed

+16
-11
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -240,3 +240,6 @@ samples/framework/docker/MVCRandomAnswerGenerator/containerImage
240240
.DS_Store
241241
_dependentPackages/
242242
!/xml/System.Net.Cache/
243+
244+
# Ignore ionide caches
245+
.ionide/

xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@
439439
<Parameter Name="items" Type="System.ReadOnlySpan&lt;TDerived&gt;" Index="0" FrameworkAlternate="net-7.0" />
440440
</Parameters>
441441
<Docs>
442-
<typeparam name="TDerived">To be added.</typeparam>
442+
<typeparam name="TDerived">The type that derives from the type of item already in the array.</typeparam>
443443
<param name="items">The items to add at the end of the array.</param>
444444
<summary>Adds the specified items to the end of the array.</summary>
445445
<remarks>To be added.</remarks>

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@
351351
<Parameter Name="items" Type="System.Collections.Immutable.ImmutableArray&lt;TDerived&gt;" Index="0" FrameworkAlternate="net-7.0" />
352352
</Parameters>
353353
<Docs>
354-
<typeparam name="TDerived">To be added.</typeparam>
354+
<typeparam name="TDerived">The type that derives from the type of item already in the array.</typeparam>
355355
<param name="items">The values to add.</param>
356356
<summary>Adds the specified items to the end of the array.</summary>
357357
<returns>A new list with the elements added.</returns>
@@ -384,7 +384,7 @@
384384
<Parameter Name="items" Type="TDerived[]" Index="0" FrameworkAlternate="net-7.0" />
385385
</Parameters>
386386
<Docs>
387-
<typeparam name="TDerived">To be added.</typeparam>
387+
<typeparam name="TDerived">The type that derives from the type of item already in the array.</typeparam>
388388
<param name="items">The values to add.</param>
389389
<summary>Adds the specified items to the end of the array.</summary>
390390
<returns>A new list with the elements added.</returns>

xml/System.Collections.Immutable/ImmutableHashSet`1+Enumerator.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@
209209
</ReturnValue>
210210
<Docs>
211211
<summary>Gets the current element.</summary>
212-
<value>To be added.</value>
212+
<value>The element in the collection at the current position of the enumerator.</value>
213213
<remarks>
214214
<format type="text/markdown"><![CDATA[
215215

xml/System.Collections.Immutable/ImmutableHashSet`1.xml

+5-3
Original file line numberDiff line numberDiff line change
@@ -888,7 +888,8 @@
888888
</ReturnValue>
889889
<Docs>
890890
<summary>See the <see cref="T:System.Collections.Generic.ICollection`1" /> interface.</summary>
891-
<value>To be added.</value>
891+
<value>
892+
<see langword="true" /> if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, <see langword="false" />.</value>
892893
<remarks>To be added.</remarks>
893894
</Docs>
894895
</Member>
@@ -1275,7 +1276,8 @@
12751276
</ReturnValue>
12761277
<Docs>
12771278
<summary>See the <see cref="T:System.Collections.ICollection" /> interface.</summary>
1278-
<value>To be added.</value>
1279+
<value>
1280+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
12791281
<remarks>
12801282
<format type="text/markdown"><![CDATA[
12811283
@@ -1322,7 +1324,7 @@ This member is an explicit interface member implementation. It can be used only
13221324
</ReturnValue>
13231325
<Docs>
13241326
<summary>See <see cref="T:System.Collections.ICollection" />.</summary>
1325-
<value>To be added.</value>
1327+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
13261328
<remarks>
13271329
<format type="text/markdown"><![CDATA[
13281330

xml/System.Collections.Immutable/ImmutableList`1+Builder.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1562,7 +1562,7 @@
15621562
<param name="equalityComparer">The equality comparer to use in the search.
15631563
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
15641564
<summary>Removes the first occurrence matching the specified value from this list.</summary>
1565-
<returns>To be added.</returns>
1565+
<returns>A value indicating whether the specified element was found and removed from the collection.</returns>
15661566
<remarks>To be added.</remarks>
15671567
</Docs>
15681568
</Member>

xml/System.Collections.Immutable/ImmutableList`1+Enumerator.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@
223223
</ReturnValue>
224224
<Docs>
225225
<summary>The current element.</summary>
226-
<value>To be added.</value>
226+
<value>The element in the collection at the current position of the enumerator.</value>
227227
<remarks>
228228
<format type="text/markdown"><![CDATA[
229229

xml/System.Collections.Immutable/ImmutableSortedDictionary`2+Enumerator.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@
223223
</ReturnValue>
224224
<Docs>
225225
<summary>The current element.</summary>
226-
<value>To be added.</value>
226+
<value>The element in the collection at the current position of the enumerator.</value>
227227
<remarks>
228228
<format type="text/markdown"><![CDATA[
229229

xml/System.Collections.Immutable/ImmutableSortedSet`1+Enumerator.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@
231231
</ReturnValue>
232232
<Docs>
233233
<summary>The current element.</summary>
234-
<value>To be added.</value>
234+
<value>The element in the collection at the current position of the enumerator.</value>
235235
<remarks>
236236
<format type="text/markdown"><![CDATA[
237237

0 commit comments

Comments
 (0)