Skip to content

Commit 499b5a7

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Automatically port new System.Threading ACL documentation (dotnet#4234)
* Automatically port new System.Threading ACL documentation * suggestions by gewarren Co-authored-by: Genevieve Warren <gewarren@microsoft.com> Co-authored-by: Genevieve Warren <gewarren@microsoft.com>
1 parent 50249c6 commit 499b5a7

File tree

4 files changed

+31
-25
lines changed

4 files changed

+31
-25
lines changed

‎xml/System.Threading/EventWaitHandleAcl.xml‎

Lines changed: 2 additions & 2 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" />
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Provides a Windows-specific extension method for creating <see cref="T:System.Threading.EventWaitHandle" /> objects with specific access control list (ACL) security.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>

‎xml/System.Threading/MutexAcl.xml‎

Lines changed: 2 additions & 2 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" />
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Provides a Windows-specific extension method for creating <see cref="T:System.Threading.Mutex" /> objects with specific access control list (ACL) security.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>

‎xml/System.Threading/SemaphoreAcl.xml‎

Lines changed: 2 additions & 2 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" />
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Provides a Windows-specific extension method for creating <see cref="T:System.Threading.Semaphore" /> objects with specific access control list (ACL) security.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>

‎xml/System.Threading/ThreadingAclExtensions.xml‎

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
</Attribute>
2525
</Attributes>
2626
<Docs>
27-
<summary>To be added.</summary>
27+
<summary>Provides Windows-specific extension methods for managing the access control list (ACL) security descriptors for <see cref="T:System.Threading.EventWaitHandle" />, <see cref="T:System.Threading.Mutex" />, and <see cref="T:System.Threading.Semaphore" />.</summary>
2828
<remarks>To be added.</remarks>
2929
</Docs>
3030
<Members>
@@ -52,9 +52,9 @@
5252
<Parameter Name="handle" Type="System.Threading.EventWaitHandle" RefType="this" />
5353
</Parameters>
5454
<Docs>
55-
<param name="handle">To be added.</param>
56-
<summary>To be added.</summary>
57-
<returns>To be added.</returns>
55+
<param name="handle">The event wait handle from which the security descriptors should be returned.</param>
56+
<summary>Returns the security descriptors for the specified <paramref name="handle" />.</summary>
57+
<returns>The security descriptors for the specified <paramref name="handle" />.</returns>
5858
<remarks>To be added.</remarks>
5959
</Docs>
6060
</Member>
@@ -82,9 +82,9 @@
8282
<Parameter Name="mutex" Type="System.Threading.Mutex" RefType="this" />
8383
</Parameters>
8484
<Docs>
85-
<param name="mutex">To be added.</param>
86-
<summary>To be added.</summary>
87-
<returns>To be added.</returns>
85+
<param name="mutex">The mutex from which the security descriptors should be returned.</param>
86+
<summary>Returns the security descriptors for the specified <paramref name="mutex" />.</summary>
87+
<returns>The security descriptors for the specified <paramref name="mutex" />.</returns>
8888
<remarks>To be added.</remarks>
8989
</Docs>
9090
</Member>
@@ -112,9 +112,9 @@
112112
<Parameter Name="semaphore" Type="System.Threading.Semaphore" RefType="this" />
113113
</Parameters>
114114
<Docs>
115-
<param name="semaphore">To be added.</param>
116-
<summary>To be added.</summary>
117-
<returns>To be added.</returns>
115+
<param name="semaphore">The semaphore from which the security descriptors should be returned.</param>
116+
<summary>Returns the security descriptors for the specified <paramref name="semaphore" />.</summary>
117+
<returns>The security descriptors for the specified semaphore.</returns>
118118
<remarks>To be added.</remarks>
119119
</Docs>
120120
</Member>
@@ -143,10 +143,12 @@
143143
<Parameter Name="eventSecurity" Type="System.Security.AccessControl.EventWaitHandleSecurity" />
144144
</Parameters>
145145
<Docs>
146-
<param name="handle">To be added.</param>
147-
<param name="eventSecurity">To be added.</param>
148-
<summary>To be added.</summary>
146+
<param name="handle">The event wait handle onto which the <paramref name="eventSecurity" /> will be applied.</param>
147+
<param name="eventSecurity">The security descriptors to apply to the specified <paramref name="handle" />.</param>
148+
<summary>Sets the security descriptors for the specified event wait handle.</summary>
149149
<remarks>To be added.</remarks>
150+
<exception cref="T:System.ArgumentNullException">
151+
<paramref name="eventSecurity" /> is <see langword="null" />.</exception>
150152
</Docs>
151153
</Member>
152154
<Member MemberName="SetAccessControl">
@@ -174,10 +176,12 @@
174176
<Parameter Name="mutexSecurity" Type="System.Security.AccessControl.MutexSecurity" />
175177
</Parameters>
176178
<Docs>
177-
<param name="mutex">To be added.</param>
178-
<param name="mutexSecurity">To be added.</param>
179-
<summary>To be added.</summary>
179+
<param name="mutex">The mutex onto which the <paramref name="mutexSecurity" /> will be applied.</param>
180+
<param name="mutexSecurity">The security descriptors to apply to the specified <paramref name="mutex" />.</param>
181+
<summary>Sets the security descriptors for the specified mutex.</summary>
180182
<remarks>To be added.</remarks>
183+
<exception cref="T:System.ArgumentNullException">
184+
<paramref name="mutexSecurity" /> is <see langword="null" />.</exception>
181185
</Docs>
182186
</Member>
183187
<Member MemberName="SetAccessControl">
@@ -205,10 +209,12 @@
205209
<Parameter Name="semaphoreSecurity" Type="System.Security.AccessControl.SemaphoreSecurity" />
206210
</Parameters>
207211
<Docs>
208-
<param name="semaphore">To be added.</param>
209-
<param name="semaphoreSecurity">To be added.</param>
210-
<summary>To be added.</summary>
212+
<param name="semaphore">The semaphore onto which the <paramref name="semaphoreSecurity" /> will be applied.</param>
213+
<param name="semaphoreSecurity">The security descriptors to apply to the specified <paramref name="semaphore" />.</param>
214+
<summary>Sets the security descriptors for the specified semaphore.</summary>
211215
<remarks>To be added.</remarks>
216+
<exception cref="T:System.ArgumentNullException">
217+
<paramref name="semaphoreSecurity" /> is <see langword="null" />.</exception>
212218
</Docs>
213219
</Member>
214220
</Members>

0 commit comments

Comments
 (0)