Skip to content

Doc updates for collections #6960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 3, 2021
Merged

Doc updates for collections #6960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions xml/System.Collections.Concurrent/ConcurrentDictionary`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,9 +719,20 @@
<ReturnType>System.Collections.Generic.IEqualityComparer&lt;TKey&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> that is used to determine equality of keys for the dictionary.</summary>
<value>The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> generic interface implementation that is used to determine equality of keys for the current <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> and to provide hash values for the keys.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

<xref:System.Collections.Concurrent.ConcurrentDictionary`2> requires an equality implementation to determine
whether keys are equal. You can specify an implementation of the <xref:System.Collections.Generic.IEqualityComparer`1>
generic interface by using a constructor that accepts a comparer parameter;
if you do not specify one, the default generic equality comparer <xref:System.Collections.Generic.EqualityComparer`1.Default> is used.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ContainsKey">
Expand Down
5 changes: 3 additions & 2 deletions xml/System.Collections.Generic/List`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1418,8 +1418,9 @@
<Parameter Name="capacity" Type="System.Int32" Index="0" FrameworkAlternate="net-6.0" />
</Parameters>
<Docs>
<param name="capacity">To be added.</param>
<summary>To be added.</summary>
<param name="capacity">The minimum capacity to ensure.</param>
<summary>Ensures that the capacity of this list is at least the specified <paramref name="capacity" />.
If the current capacity of the list is less than specified <paramref name="capacity" />, the capacity is increased by continuously twice current capacity until it is at least the specified <paramref name="capacity" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
41 changes: 29 additions & 12 deletions xml/System.Collections.Generic/PriorityQueue`2+UnorderedItemsCollection+Enumerator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<summary>Enumerates the element and priority pairs of a <see cref="T:System.Collections.Generic.PriorityQueue`2" />, without any ordering guarantees.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -57,7 +57,7 @@
<ReturnType>System.ValueTuple&lt;TElement,TPriority&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the element at the current position of the enumerator.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -82,7 +82,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Releases all resources used by the <see cref="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -106,8 +106,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Advances the enumerator to the next element of the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems" />.</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -136,8 +137,8 @@
<ReturnType>System.ValueTuple&lt;TElement,TPriority&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
<value>The element in the collection at the current position of the enumerator.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -160,9 +161,17 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the element in the collection at the current position of the enumerator.</summary>
<value>The element in the collection at the current position of the enumerator.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerator.Reset">
Expand All @@ -185,8 +194,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Sets the enumerator to its initial position, which is before the first element in the collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
63 changes: 44 additions & 19 deletions xml/System.Collections.Generic/PriorityQueue`2+UnorderedItemsCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<summary>Enumerates the contents of a <see cref="T:System.Collections.Generic.PriorityQueue`2" />, without any ordering guarantees.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -58,8 +58,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the number of elements in the collection.</summary>
<value>The number of elements in the collection.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -80,8 +80,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems" />.</summary>
<returns>An <see cref="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator" /> for the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -111,8 +111,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the collection.</summary>
<returns>An enumerator that can be used to iterate through the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -139,9 +139,9 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="array">To be added.</param>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from <see cref="T:System.Collections.ICollection" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -164,9 +164,18 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
<value>
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.ICollection.SyncRoot">
Expand All @@ -188,9 +197,17 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection> instance is cast to an <xref:System.Collections.ICollection> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
Expand All @@ -213,9 +230,17 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Returns an enumerator that iterates through a collection.</summary>
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading