Skip to content

Commit c1b537c

Browse files
carlossanlopRon Petrusha
authored andcommitted
Port System.Threading.Tasks source comments to Docs (#2312)
* Port System.Threading.Tasks source comments to Docs * Update xml/System.Threading.Tasks.Dataflow/BatchedJoinBlock`2.xml Makes sense. Co-Authored-By: carlossanlop <[email protected]> * Update xml/System.Threading.Tasks.Dataflow/BatchedJoinBlock`2.xml Makes sense. Thanks for the explanation. Co-Authored-By: carlossanlop <[email protected]> * Update xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml Co-Authored-By: carlossanlop <[email protected]> * Update xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml Nice catch. This was not among the /// comments apparently. Co-Authored-By: carlossanlop <[email protected]> * Update xml/System.Threading.Tasks/Parallel.xml Co-Authored-By: carlossanlop <[email protected]> * undo formatting change * change formatting
1 parent de90476 commit c1b537c

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

xml/System.Threading.Tasks.Dataflow/BatchedJoinBlock`2.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,10 @@
111111
<param name="dataflowBlockOptions">The options with which to configure this <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2" />.</param>
112112
<summary>Initializes a new <see cref="T:System.Threading.Tasks.Dataflow.BatchedJoinBlock`2" /> with the specified configuration.</summary>
113113
<remarks>To be added.</remarks>
114-
<exception cref="T:System.ArgumentNullException">The <paramref name="dataflowBlockOptions" /> is <see langword="null" />.</exception>
114+
<exception cref="T:System.ArgumentNullException">
115+
<paramref name="dataflowBlockOptions" /> is <see langword="null" />.</exception>
116+
<exception cref="T:System.ArgumentOutOfRangeException">
117+
<paramref name="batchSize" /> is less than one.</exception>
115118
</Docs>
116119
</Member>
117120
<Member MemberName="BatchSize">
@@ -578,4 +581,4 @@
578581
</Docs>
579582
</Member>
580583
</Members>
581-
</Type>
584+
</Type>

xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,4 +276,4 @@ is more important than maintaining the input-to-output ordering.
276276
</Docs>
277277
</Member>
278278
</Members>
279-
</Type>
279+
</Type>

xml/System.Threading.Tasks/Parallel.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1014,6 +1014,7 @@
10141014

10151015
The <see cref="M:System.Collections.Concurrent.Partitioner`1.GetPartitions(System.Int32)" /> method in the <paramref name="source" /> partitioner does not return the correct number of partitions.</exception>
10161016
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
1017+
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
10171018
</Docs>
10181019
</Member>
10191020
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1086,6 +1087,7 @@
10861087

10871088
The <see cref="M:System.Collections.Concurrent.Partitioner`1.GetPartitions(System.Int32)" /> method in the <paramref name="source" /> partitioner does not return the correct number of partitions.</exception>
10881089
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
1090+
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
10891091
</Docs>
10901092
</Member>
10911093
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1333,6 +1335,7 @@
13331335

13341336
The exception that is thrown when any methods in the <paramref name="source" /> orderable partitioner return <see langword="null" />.</exception>
13351337
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
1338+
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
13361339
</Docs>
13371340
</Member>
13381341
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1400,6 +1403,7 @@
14001403

14011404
The exception that is thrown when any methods in the <paramref name="source" /> partitioner return <see langword="null" />.</exception>
14021405
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
1406+
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
14031407
</Docs>
14041408
</Member>
14051409
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -1467,6 +1471,7 @@
14671471

14681472
The exception that is thrown when any methods in the <paramref name="source" /> partitioner return <see langword="null" />.</exception>
14691473
<related type="Article" href="https://docs.microsoft.com/previous-versions/msp-n-p/ff963552(v=pandp.10)">Parallel Loops</related>
1474+
<exception cref="T:System.AggregateException">The exception that is thrown to contain an exception thrown from one of the specified delegates.</exception>
14701475
</Docs>
14711476
</Member>
14721477
<Member MemberName="ForEach&lt;TSource&gt;">
@@ -2422,4 +2427,4 @@
24222427
</Docs>
24232428
</Member>
24242429
</Members>
2425-
</Type>
2430+
</Type>

0 commit comments

Comments
 (0)