Skip to content

Add link to DataFlow conceptual documentation to DataFlow types #7318

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add link to DataFlow conceptual documentation to DataFlow types #7318

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
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/ActionBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

## Examples
The following example shows the use of the <xref:System.Threading.Tasks.Dataflow.ActionBlock%601> class to perform several computations using dataflow blocks, and returns the elapsed time required to perform the computations. This code example is part of a larger example provided for the [How to: Specify the Degree of Parallelism in a Dataflow Block](/dotnet/standard/parallel-programming/how-to-specify-the-degree-of-parallelism-in-a-dataflow-block) topic.
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/BatchBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/BatchedJoinBlock`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/BatchedJoinBlock`3.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/BroadcastBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

<xref:System.Threading.Tasks.Dataflow.BroadcastBlock%601> exposes at most one element at a time. However, unlike <xref:System.Threading.Tasks.Dataflow.WriteOnceBlock%601>, that element will be overwritten as new elements are provided to the block. <xref:System.Threading.Tasks.Dataflow.BroadcastBlock%601> ensures that the current element is broadcast to any linked targets before allowing the element to be overwritten.

Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/BufferBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/DataflowBlock.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

## Remarks
[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

<xref:System.Threading.Tasks.Dataflow.DataflowBlockOptions> is mutable and can be configured through its properties.

Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/DataflowLinkOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

<xref:System.Threading.Tasks.Dataflow.DataflowLinkOptions> is mutable and can be configured through its properties.

Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/DataflowMessageHeader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/DataflowMessageStatus.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/ExecutionDataflowBlockOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

<xref:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions> is mutable and can be configured through its properties.

Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/GroupingDataflowBlockOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

<xref:System.Threading.Tasks.Dataflow.GroupingDataflowBlockOptions> is mutable and can be configured through its properties.

Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/IDataflowBlock.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/IPropagatorBlock`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/IReceivableSourceBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/ISourceBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/ITargetBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/JoinBlock`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/JoinBlock`3.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/TransformBlock`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/TransformManyBlock`2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Threading.Tasks.Dataflow/WriteOnceBlock`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
## Remarks

[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]

For more information, see [Dataflow](/dotnet/standard/parallel-programming/dataflow-task-parallel-library).

]]></format>
</remarks>
Expand Down