Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
davidkallesen committed Aug 14, 2024
1 parent 1e717a9 commit 6218869
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/CodeDoc/Atc/Atc.Factories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<div style='text-align: right'>

[References](Index.md)&nbsp;&nbsp;-&nbsp;&nbsp;[References extended](IndexExtended.md)
</div>

# Atc.Factories

<br />

## AsyncEnumerableFactory
Provides factory methods for creating instances of `System.Collections.Generic.IAsyncEnumerable`1`.

>```csharp
>public static class AsyncEnumerableFactory
>```
### Static Methods
#### EmptyAsyncEnumerable
>```csharp
>IAsyncEnumerable<T> EmptyAsyncEnumerable()
>```
><b>Summary:</b> Returns an empty `System.Collections.Generic.IAsyncEnumerable`1`.
>
><b>Returns:</b> An empty `System.Collections.Generic.IAsyncEnumerable`1`.
<hr /><div style='text-align: right'><i>Generated by MarkdownCodeDoc version 1.2</i></div>
4 changes: 4 additions & 0 deletions docs/CodeDoc/Atc/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@

- [SemanticVersion](Atc.Data.SemVer.md#semanticversion)

## [Atc.Factories](Atc.Factories.md)

- [AsyncEnumerableFactory](Atc.Factories.md#asyncenumerablefactory)

## [Atc.Helpers](Atc.Helpers.md)

- [ArticleNumberHelper](Atc.Helpers.md#articlenumberhelper)
Expand Down
8 changes: 8 additions & 0 deletions docs/CodeDoc/Atc/IndexExtended.md
Original file line number Diff line number Diff line change
Expand Up @@ -4391,6 +4391,12 @@
- ToString()
- ToVersion()

## [Atc.Factories](Atc.Factories.md)

- [AsyncEnumerableFactory](Atc.Factories.md#asyncenumerablefactory)
- Static Methods
- EmptyAsyncEnumerable()

## [Atc.Helpers](Atc.Helpers.md)

- [ArticleNumberHelper](Atc.Helpers.md#articlenumberhelper)
Expand Down Expand Up @@ -5294,7 +5300,9 @@

- [EnumerableExtensions](System.Collections.Generic.md#enumerableextensions)
- Static Methods
- CountAsync(this IEnumerable&lt;T&gt; source, CancellationToken cancellationToken = null)
- ToAsyncEnumerable(this IEnumerable&lt;T&gt; source, CancellationToken cancellationToken = null)
- ToListAsync(this IEnumerable&lt;T&gt; source, CancellationToken cancellationToken = null)
- [ReadOnlyListExtensions](System.Collections.Generic.md#readonlylistextensions)
- Static Methods
- GetPowerSet(this IReadOnlyList&lt;T&gt; list)
Expand Down
22 changes: 22 additions & 0 deletions docs/CodeDoc/Atc/System.Collections.Generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,17 @@ Provides extension methods for asynchronous enumeration of collections.
### Static Methods
#### CountAsync
>```csharp
>Task<int> CountAsync(this IEnumerable<T> source, CancellationToken cancellationToken = null)
>```
><b>Summary:</b> Asynchronously counts the elements in a sequence.
>
><b>Parameters:</b><br>
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`source`&nbsp;&nbsp;-&nbsp;&nbsp;The source sequence to count.<br />
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`cancellationToken`&nbsp;&nbsp;-&nbsp;&nbsp;A to observe while waiting for the asynchronous operation to complete.<br />
>
><b>Returns:</b> A task that represents the asynchronous operation. The task result contains the number of elements in the sequence.
#### ToAsyncEnumerable
>```csharp
>IAsyncEnumerable<T> ToAsyncEnumerable(this IEnumerable<T> source, CancellationToken cancellationToken = null)
Expand All @@ -27,6 +38,17 @@ Provides extension methods for asynchronous enumeration of collections.
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`cancellationToken`&nbsp;&nbsp;-&nbsp;&nbsp;A to observe while waiting for the asynchronous operation to complete.<br />
>
><b>Returns:</b> An `System.Collections.Generic.IAsyncEnumerable`1` that contains the elements from the input sequence.
#### ToListAsync
>```csharp
>Task<List<T>> ToListAsync(this IEnumerable<T> source, CancellationToken cancellationToken = null)
>```
><b>Summary:</b> Asynchronously creates a `System.Collections.Generic.List`1` from an `System.Collections.Generic.IEnumerable`1`.
>
><b>Parameters:</b><br>
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`source`&nbsp;&nbsp;-&nbsp;&nbsp;The source sequence to convert to a list.<br />
>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`cancellationToken`&nbsp;&nbsp;-&nbsp;&nbsp;A to observe while waiting for the asynchronous operation to complete.<br />
>
><b>Returns:</b> A task that represents the asynchronous operation. The task result contains a list with the elements from the input sequence.
<br />
Expand Down

0 comments on commit 6218869

Please sign in to comment.