Skip to content

Commit 6a125d2

Browse files
carlossanlopRon Petrusha
authored andcommitted
Document System.Threading APIs (#3229)
* Document System.Threading APIs * Additional documentation for Channel * suggestions by stephentoub and tarekgh * suggestions by rpetrusha Co-Authored-By: Ron Petrusha <[email protected]> * additional abstract removal
1 parent e252185 commit 6a125d2

File tree

9 files changed

+20
-12
lines changed

9 files changed

+20
-12
lines changed

xml/System.Threading.Channels/Channel.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@
103103
</TypeParameters>
104104
<Parameters />
105105
<Docs>
106-
<typeparam name="T">To be added.</typeparam>
106+
<typeparam name="T">The type of data in the channel.</typeparam>
107107
<summary>Creates an unbounded channel usable by any number of readers and writers concurrently.</summary>
108108
<returns>The created channel.</returns>
109109
<remarks>To be added.</remarks>

xml/System.Threading.Channels/ChannelOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
</AssemblyInfo>
3434
<Parameters />
3535
<Docs>
36-
<summary>To be added.</summary>
36+
<summary>Initializes an instance of the <see cref="T:System.Threading.Channels.ChannelOptions" /> class.</summary>
3737
<remarks>To be added.</remarks>
3838
</Docs>
3939
</Member>

xml/System.Threading.Channels/ChannelReader`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</AssemblyInfo>
3838
<Parameters />
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Initializes an instance of the <see cref="T:System.Threading.Channels.ChannelReader`1" /> class.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
</Member>

xml/System.Threading.Channels/ChannelWriter`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</AssemblyInfo>
3838
<Parameters />
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Initializes an instance of the <see cref="T:System.Threading.Channels.ChannelWriter`1" /> class.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
</Member>

xml/System.Threading.Channels/Channel`1.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
</AssemblyInfo>
4242
<Parameters />
4343
<Docs>
44-
<summary>To be added.</summary>
44+
<summary>Initializes an instance of the <see cref="T:System.Threading.Channels.Channel`1" /> class.</summary>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>

xml/System.Threading.Channels/Channel`2.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
</AssemblyInfo>
4040
<Parameters />
4141
<Docs>
42-
<summary>To be added.</summary>
42+
<summary>Initializes an instance of the <see cref="T:System.Threading.Channels.Channel`2" /> class.</summary>
4343
<remarks>To be added.</remarks>
4444
</Docs>
4545
</Member>

xml/System.Threading.Channels/UnboundedChannelOptions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
</AssemblyInfo>
3434
<Parameters />
3535
<Docs>
36-
<summary>To be added.</summary>
36+
<summary>Initializes a new instance of the <see cref="T:System.Threading.Channels.UnboundedChannelOptions" /> class.</summary>
3737
<remarks>To be added.</remarks>
3838
</Docs>
3939
</Member>

xml/System.Threading.Tasks/Task.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3040,8 +3040,8 @@ Task t Status: RanToCompletion, Result: 42
30403040
<ReturnType>System.Boolean</ReturnType>
30413041
</ReturnValue>
30423042
<Docs>
3043-
<summary>To be added.</summary>
3044-
<value>To be added.</value>
3043+
<summary>Gets whether the task ran to completion.</summary>
3044+
<value><see langword="true" /> if the task ran to completion; otherwise <see langword="false" />.</value>
30453045
<remarks>To be added.</remarks>
30463046
</Docs>
30473047
</Member>

xml/System.Threading/Thread.xml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1826,9 +1826,17 @@ Main thread: ThreadProc.Join has returned. Press Enter to end program.
18261826
</ReturnValue>
18271827
<Parameters />
18281828
<Docs>
1829-
<summary>To be added.</summary>
1830-
<returns>To be added.</returns>
1831-
<remarks>To be added.</remarks>
1829+
<summary>Gets an ID used to indicate on which processor the current thread is executing.</summary>
1830+
<returns>An integer representing the cached processor ID.</returns>
1831+
<remarks>
1832+
<format type="text/markdown"><![CDATA[
1833+
1834+
## Remarks
1835+
1836+
This value is cached and periodically refreshed. It may be stale by the time it's used: consuming code must not rely on its accuracy for correctness.
1837+
1838+
]]></format>
1839+
</remarks>
18321840
</Docs>
18331841
</Member>
18341842
<Member MemberName="GetData">

0 commit comments

Comments
 (0)