Skip to content

Commit ddef212

Browse files
carlossanlopkouvel
carlossanlop
and
kouvel
authored
Auto port System.Threading ACL comments (#4147)
* Auto port System.Threading ACL comments * Apply suggestions from code review Co-Authored-By: Koundinya Veluri <[email protected]> * Apply suggestions from code review Co-Authored-By: Koundinya Veluri <[email protected]> Co-authored-by: Koundinya Veluri <[email protected]>
1 parent fecaf2d commit ddef212

File tree

3 files changed

+53
-24
lines changed

3 files changed

+53
-24
lines changed

‎xml/System.Threading/EventWaitHandleAcl.xml

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="EventWaitHandleAcl" FullName="System.Threading.EventWaitHandleAcl">
1+
<Type Name="EventWaitHandleAcl" FullName="System.Threading.EventWaitHandleAcl">
22
<TypeSignature Language="C#" Value="public static class EventWaitHandleAcl" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit EventWaitHandleAcl extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Threading.EventWaitHandleAcl" />
@@ -41,14 +41,32 @@
4141
<Parameter Name="eventSecurity" Type="System.Security.AccessControl.EventWaitHandleSecurity" />
4242
</Parameters>
4343
<Docs>
44-
<param name="initialState">To be added.</param>
45-
<param name="mode">To be added.</param>
46-
<param name="name">To be added.</param>
47-
<param name="createdNew">To be added.</param>
48-
<param name="eventSecurity">To be added.</param>
49-
<summary>To be added.</summary>
50-
<returns>To be added.</returns>
51-
<remarks>To be added.</remarks>
44+
<param name="initialState">
45+
<see langword="true" /> to set the initial state to signaled if the named event is created as a result of this call; <see langword="false" /> to set it to non-signaled.</param>
46+
<param name="mode">One of the enum values that determines whether the event resets automatically or manually.</param>
47+
<param name="name">The name, if the event is to be shared with other processes; otherwise, <see langword="null" /> or an empty string.</param>
48+
<param name="createdNew">When this method returns, this argument is always set to <see langword="true" /> if a local event is created; that is, when <paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />. If <paramref name="name" /> has a valid, non-empty value, this argument is set to <see langword="true" /> when the system event is created, or it is set to <see langword="false" /> if an existing system event is found with that name.</param>
49+
<param name="eventSecurity">The optional Windows access control security to apply.</param>
50+
<summary>Gets or creates an <see cref="T:System.Threading.EventWaitHandle" /> instance, allowing a <see cref="T:System.Security.AccessControl.EventWaitHandleSecurity" /> instance to be optionally specified to set it during the event creation.</summary>
51+
<returns>An object that represents an event wait handle as requested.</returns>
52+
<remarks>
53+
<format type="text/markdown"><![CDATA[
54+
55+
## Remarks
56+
57+
If a `name` is passed and the system event already exists, the existing event is returned. If `name` is `null` or <xref:System.String.Empty>, a new process-local event is created.
58+
59+
]]></format>
60+
</remarks>
61+
<exception cref="T:System.ArgumentException">.NET Framework only: The <paramref name="name" /> length is beyond MAX_PATH (260 characters).
62+
63+
-or-
64+
65+
.NET Framework only: The <paramref name="mode" /> enum value was out of legal range.</exception>
66+
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="mode" /> enum value was out of legal range.</exception>
67+
<exception cref="T:System.IO.DirectoryNotFoundException">Could not find a part of the path specified in <paramref name="name" />.</exception>
68+
<exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A system-wide synchronization event with the provided <paramref name="name" /> was not found.
69+
-or- An <see cref="T:System.Threading.EventWaitHandle" /> with system-wide name <paramref name="name" /> cannot be created. An <see cref="T:System.Threading.EventWaitHandle" /> of a different type might have the same name.</exception>
5270
</Docs>
5371
</Member>
5472
</Members>

‎xml/System.Threading/MutexAcl.xml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="MutexAcl" FullName="System.Threading.MutexAcl">
1+
<Type Name="MutexAcl" FullName="System.Threading.MutexAcl">
22
<TypeSignature Language="C#" Value="public static class MutexAcl" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit MutexAcl extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Threading.MutexAcl" />
@@ -40,13 +40,16 @@
4040
<Parameter Name="mutexSecurity" Type="System.Security.AccessControl.MutexSecurity" />
4141
</Parameters>
4242
<Docs>
43-
<param name="initiallyOwned">To be added.</param>
44-
<param name="name">To be added.</param>
45-
<param name="createdNew">To be added.</param>
46-
<param name="mutexSecurity">To be added.</param>
47-
<summary>To be added.</summary>
48-
<returns>To be added.</returns>
43+
<param name="initiallyOwned">
44+
<see langword="true" /> to give the calling thread initial ownership of the named system mutex if the named system mutex is created as a result of this call; otherwise, <see langword="false" />.</param>
45+
<param name="name">The optional name of the system mutex. If this argument is set to <see langword="null" /> or <see cref="F:System.String.Empty" />, a local mutex is created.</param>
46+
<param name="createdNew">When this method returns, this argument is always set to <see langword="true" /> if a local mutex is created; that is, when <paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />. If <paramref name="name" /> has a valid non-empty value, this argument is set to <see langword="true" /> when the system mutex is created, or it is set to <see langword="false" /> if an existing system mutex is found with that name. This parameter is passed uninitialized.</param>
47+
<param name="mutexSecurity">The optional mutex access control security to apply.</param>
48+
<summary>Gets or creates <see cref="T:System.Threading.Mutex" /> instance, allowing a <see cref="T:System.Security.AccessControl.MutexSecurity" /> to be optionally specified to set it during the mutex creation.</summary>
49+
<returns>An object that represents a system mutex, if named, or a local mutex, if nameless.</returns>
4950
<remarks>To be added.</remarks>
51+
<exception cref="T:System.ArgumentException">.NET Framework only: The length of the name exceeds the maximum limit.</exception>
52+
<exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A mutex handle with system-wide <paramref name="name" /> cannot be created. A mutex handle of a different type might have the same name.</exception>
5053
</Docs>
5154
</Member>
5255
</Members>

‎xml/System.Threading/SemaphoreAcl.xml

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="SemaphoreAcl" FullName="System.Threading.SemaphoreAcl">
1+
<Type Name="SemaphoreAcl" FullName="System.Threading.SemaphoreAcl">
22
<TypeSignature Language="C#" Value="public static class SemaphoreAcl" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit SemaphoreAcl extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Threading.SemaphoreAcl" />
@@ -41,14 +41,22 @@
4141
<Parameter Name="semaphoreSecurity" Type="System.Security.AccessControl.SemaphoreSecurity" />
4242
</Parameters>
4343
<Docs>
44-
<param name="initialCount">To be added.</param>
45-
<param name="maximumCount">To be added.</param>
46-
<param name="name">To be added.</param>
47-
<param name="createdNew">To be added.</param>
48-
<param name="semaphoreSecurity">To be added.</param>
49-
<summary>To be added.</summary>
50-
<returns>To be added.</returns>
44+
<param name="initialCount">The initial number of requests for the semaphore that can be satisfied concurrently.</param>
45+
<param name="maximumCount">The maximum number of requests for the semaphore that can be satisfied concurrently.</param>
46+
<param name="name">Optional argument to create a system semaphore. Set to <see langword="null" /> or <see cref="F:System.String.Empty" /> to create a local semaphore.</param>
47+
<param name="createdNew">When this method returns, this argument is always set to <see langword="true" /> if a local semaphore is created; that is, when <paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />. If <paramref name="name" /> has a valid, non-empty value, this argument is set to <see langword="true" /> when the system semaphore is created, or it is set to <see langword="false" /> if an existing system semaphore is found with that name. This parameter is passed uninitialized.</param>
48+
<param name="semaphoreSecurity">The optional semaphore access control security to apply.</param>
49+
<summary>Gets or creates an <see cref="T:System.Threading.Semaphore" /> instance, allowing a <see cref="T:System.Security.AccessControl.SemaphoreSecurity" /> instance to be optionally specified to set it during the event creation.</summary>
50+
<returns>An object that represents a system semaphore, if named, or a local semaphore, if nameless.</returns>
5151
<remarks>To be added.</remarks>
52+
<exception cref="T:System.ArgumentOutOfRangeException">
53+
<paramref name="initialCount" /> is a negative number.
54+
-or-
55+
56+
<paramref name="maximumCount" /> is not a positive number.</exception>
57+
<exception cref="T:System.ArgumentException">
58+
<paramref name="initialCount" /> is greater than <paramref name="maximumCount" />.</exception>
59+
<exception cref="T:System.Threading.WaitHandleCannotBeOpenedException">A semaphore handle with the system-wide name '<paramref name="name" />' cannot be created. A semaphore handle of a different type might have the same name.</exception>
5260
</Docs>
5361
</Member>
5462
</Members>

0 commit comments

Comments
 (0)