Skip to content

System.Collections - Undoc 6.0 APIs #54869

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

Jump to bottom
Closed
carlossanlop opened this issue Jun 28, 2021 · 3 comments · Fixed by dotnet/dotnet-api-docs#6960 or dotnet/dotnet-api-docs#7071
Closed

System.Collections - Undoc 6.0 APIs #54869

carlossanlop opened this issue Jun 28, 2021 · 3 comments · Fixed by dotnet/dotnet-api-docs#6960 or dotnet/dotnet-api-docs#7071
Assignees
@eiriktsarpalis
Labels
area-System.Collections documentation Documentation bug or enhancement, does not impact product or test code
Milestone
6.0.0

Comments

@carlossanlop
Copy link
Contributor

The APIs in the table below were introduced in .NET 6.0 and are showing up as undocumented in the dotnet-api-docs repo.

Some of them are already documented in triple slash comments in source. Area owners, please:

  1. Verify if there are any APIs from the table have not been documented in source. If you find any, document them in triple slash and submit a PR to runtime to commit the documentation.
  2. Clone the dotnet-api-docs repo and port the triple slash comments by running this DocsPortingTool command:
DocsPortingTool \
    -Direction ToDocs \
    -Docs %REPOS%\dotnet-api-docs\xml \
    -Intellisense %REPOS%\runtime\artifacts\bin\ \
    -IncludedAssemblies System.Collections \
    -IncludedNamespaces System.Collections \
    -Save true
  1. Submit a PR to dotnet-api-docs with the ported documentation.
Undoc 6.0 System.Collections APIs table
Undoc 6.0 API
[P:System.Collections.Concurrent.ConcurrentDictionary2.Comparer](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Concurrent/ConcurrentDictionary2.xml)
[M:System.Collections.Generic.List1.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/List1.xml)
M:System.Collections.Generic.PriorityQueue2.#ctor(System.Collections.Generic.IEnumerable{System.ValueTuple{0,1}},System.Collections.Generic.IComparer{1})
[M:System.Collections.Generic.PriorityQueue2.#ctor(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.#ctor(System.Collections.Generic.IEnumerable{System.ValueTuple{0,1}})](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
M:System.Collections.Generic.PriorityQueue2.#ctor(System.Collections.Generic.IComparer{1})
[M:System.Collections.Generic.PriorityQueue2.#ctor](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
M:System.Collections.Generic.PriorityQueue2.#ctor(System.Int32,System.Collections.Generic.IComparer{1})
[M:System.Collections.Generic.PriorityQueue2.Clear](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.Comparer](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.Count](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.Dequeue](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.Enqueue(0,1)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnqueueDequeue(0,1)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnqueueRange(System.Collections.Generic.IEnumerable{0},1)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnqueueRange(System.Collections.Generic.IEnumerable{System.ValueTuple{0,1}})](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.Peek](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[T:System.Collections.Generic.PriorityQueue2](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.TrimExcess](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.TryDequeue(0@,1@)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.TryPeek(0@,1@)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItems](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Count](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.GetEnumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[T:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#Generic#IEnumerable<(TElementElement,TPriorityPriority)>#GetEnumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#ICollection#IsSynchronized](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#ICollection#SyncRoot](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#IEnumerable#GetEnumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.Current](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.Dispose](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.MoveNext](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[T:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.System#Collections#Generic#IEnumerator<(TElementElement,TPriorityPriority)>#Current](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.System#Collections#IEnumerator#Current](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.System#Collections#IEnumerator#Reset](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.Queue1.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/Queue1.xml)
[M:System.Collections.Generic.Stack1.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/Stack1.xml)
@carlossanlop carlossanlop added this to the 6.0.0 milestone Jun 28, 2021
@ghost
Copy link

ghost commented Jun 28, 2021

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

@ghost ghost added the untriaged New issue has not been triaged by the area owner label Jun 28, 2021
@ghost
Copy link

ghost commented Jun 29, 2021

Tagging subscribers to this area: @eiriktsarpalis
See info in area-owners.md if you want to be subscribed.

Issue Details

The APIs in the table below were introduced in .NET 6.0 and are showing up as undocumented in the dotnet-api-docs repo.

Some of them are already documented in triple slash comments in source. Area owners, please:

  1. Verify if there are any APIs from the table have not been documented in source. If you find any, document them in triple slash and submit a PR to runtime to commit the documentation.
  2. Clone the dotnet-api-docs repo and port the triple slash comments by running this DocsPortingTool command:
DocsPortingTool \
    -Direction ToDocs \
    -Docs %REPOS%\dotnet-api-docs\xml \
    -Intellisense %REPOS%\runtime\artifacts\bin\ \
    -IncludedAssemblies System.Collections \
    -IncludedNamespaces System.Collections \
    -Save true
  1. Submit a PR to dotnet-api-docs with the ported documentation.
Undoc 6.0 System.Collections APIs table
Undoc 6.0 API
[P:System.Collections.Concurrent.ConcurrentDictionary2.Comparer](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Concurrent/ConcurrentDictionary2.xml)
[M:System.Collections.Generic.List1.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/List1.xml)
M:System.Collections.Generic.PriorityQueue2.#ctor(System.Collections.Generic.IEnumerable{System.ValueTuple{0,1}},System.Collections.Generic.IComparer{1})
[M:System.Collections.Generic.PriorityQueue2.#ctor(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.#ctor(System.Collections.Generic.IEnumerable{System.ValueTuple{0,1}})](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
M:System.Collections.Generic.PriorityQueue2.#ctor(System.Collections.Generic.IComparer{1})
[M:System.Collections.Generic.PriorityQueue2.#ctor](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
M:System.Collections.Generic.PriorityQueue2.#ctor(System.Int32,System.Collections.Generic.IComparer{1})
[M:System.Collections.Generic.PriorityQueue2.Clear](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.Comparer](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.Count](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.Dequeue](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.Enqueue(0,1)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnqueueDequeue(0,1)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnqueueRange(System.Collections.Generic.IEnumerable{0},1)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnqueueRange(System.Collections.Generic.IEnumerable{System.ValueTuple{0,1}})](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.Peek](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[T:System.Collections.Generic.PriorityQueue2](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.TrimExcess](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.TryDequeue(0@,1@)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[M:System.Collections.Generic.PriorityQueue2.TryPeek(0@,1@)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItems](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Count](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.GetEnumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[T:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#Generic#IEnumerable<(TElementElement,TPriorityPriority)>#GetEnumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#ICollection#CopyTo(System.Array,System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#ICollection#IsSynchronized](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#ICollection#SyncRoot](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.System#Collections#IEnumerable#GetEnumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.Current](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.Dispose](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.MoveNext](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[T:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.System#Collections#Generic#IEnumerator<(TElementElement,TPriorityPriority)>#Current](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[P:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.System#Collections#IEnumerator#Current](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.PriorityQueue2.UnorderedItemsCollection.Enumerator.System#Collections#IEnumerator#Reset](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/PriorityQueue2+UnorderedItemsCollection+Enumerator.xml)
[M:System.Collections.Generic.Queue1.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/Queue1.xml)
[M:System.Collections.Generic.Stack1.EnsureCapacity(System.Int32)](https://github.com/dotnet/dotnet-api-docs/blob/main/xml/System.Collections.Generic/Stack1.xml)
Author: carlossanlop
Assignees: -
Labels:

area-System.Collections, untriaged
Milestone: 6.0.0

@eiriktsarpalis eiriktsarpalis added documentation Documentation bug or enhancement, does not impact product or test code and removed untriaged New issue has not been triaged by the area owner labels Jun 29, 2021
@eiriktsarpalis eiriktsarpalis self-assigned this Jun 29, 2021
@eiriktsarpalis eiriktsarpalis mentioned this issue Jul 23, 2021
Closed
@danmoseley danmoseley mentioned this issue Aug 3, 2021
Merged
@eiriktsarpalis eiriktsarpalis reopened this Aug 3, 2021
@eiriktsarpalis
Copy link
Member

Reopening to keep track of a few elements missing documentation (see dotnet/dotnet-api-docs#6960)

@danmoseley danmoseley mentioned this issue Aug 7, 2021
Closed
This was referenced Aug 24, 2021
Closed
Merged
Merged
@ghost ghost locked as resolved and limited conversation to collaborators Sep 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@eiriktsarpalis eiriktsarpalis

Labels
area-System.Collections documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Milestone
6.0.0
4 participants
@carlossanlop @eiriktsarpalis @danmoseley @jeffschwMSFT