Skip to content

Commit 1a913ef

Browse files
Automatically port System.Security documentation (#4622)
* Automatically port System.Security documentation * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * move exception from summary Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
1 parent f0db820 commit 1a913ef

File tree

8 files changed

+178
-62
lines changed

8 files changed

+178
-62
lines changed

xml/System.Security.AccessControl/AuthorizationRuleCollection.xml

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AuthorizationRuleCollection" FullName="System.Security.AccessControl.AuthorizationRuleCollection">
1+
<Type Name="AuthorizationRuleCollection" FullName="System.Security.AccessControl.AuthorizationRuleCollection">
22
<TypeSignature Language="C#" Value="public sealed class AuthorizationRuleCollection : System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;net-5.0;netcore-3.0;netcore-3.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AuthorizationRuleCollection extends System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;net-5.0;netcore-3.0;netcore-3.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
44
<TypeSignature Language="DocId" Value="T:System.Security.AccessControl.AuthorizationRuleCollection" />
@@ -159,8 +159,8 @@
159159
<ReturnType>System.Int32</ReturnType>
160160
</ReturnValue>
161161
<Docs>
162-
<summary>To be added.</summary>
163-
<value>To be added.</value>
162+
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.ICollection" />.</summary>
163+
<value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
164164
<remarks>To be added.</remarks>
165165
</Docs>
166166
</Member>
@@ -226,9 +226,9 @@
226226
<Parameter Name="index" Type="System.Int32" Index="1" FrameworkAlternate="netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0" />
227227
</Parameters>
228228
<Docs>
229-
<param name="array">To be added.</param>
230-
<param name="index">To be added.</param>
231-
<summary>To be added.</summary>
229+
<param name="array">The one-dimensional array as the destination for the elements copied from <see cref="T:System.Collections.ICollection" />. The array must have zero-based indexing.</param>
230+
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
231+
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
232232
<remarks>To be added.</remarks>
233233
</Docs>
234234
</Member>
@@ -255,9 +255,18 @@
255255
<ReturnType>System.Boolean</ReturnType>
256256
</ReturnValue>
257257
<Docs>
258-
<summary>To be added.</summary>
259-
<value>To be added.</value>
260-
<remarks>To be added.</remarks>
258+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
259+
<value>
260+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
261+
<remarks>
262+
<format type="text/markdown"><![CDATA[
263+
264+
## Remarks
265+
266+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.AccessControl.AuthorizationRuleCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
267+
268+
]]></format>
269+
</remarks>
261270
</Docs>
262271
</Member>
263272
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -283,9 +292,17 @@
283292
<ReturnType>System.Object</ReturnType>
284293
</ReturnValue>
285294
<Docs>
286-
<summary>To be added.</summary>
287-
<value>To be added.</value>
288-
<remarks>To be added.</remarks>
295+
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
296+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
297+
<remarks>
298+
<format type="text/markdown"><![CDATA[
299+
300+
## Remarks
301+
302+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.AccessControl.AuthorizationRuleCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
303+
304+
]]></format>
305+
</remarks>
289306
</Docs>
290307
</Member>
291308
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -312,9 +329,17 @@
312329
</ReturnValue>
313330
<Parameters />
314331
<Docs>
315-
<summary>To be added.</summary>
316-
<returns>To be added.</returns>
317-
<remarks>To be added.</remarks>
332+
<summary>Returns an enumerator that iterates through a collection.</summary>
333+
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
334+
<remarks>
335+
<format type="text/markdown"><![CDATA[
336+
337+
## Remarks
338+
339+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.AccessControl.AuthorizationRuleCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
340+
341+
]]></format>
342+
</remarks>
318343
</Docs>
319344
</Member>
320345
</Members>

xml/System.Security.AccessControl/GenericAcl.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="GenericAcl" FullName="System.Security.AccessControl.GenericAcl">
1+
<Type Name="GenericAcl" FullName="System.Security.AccessControl.GenericAcl">
22
<TypeSignature Language="C#" Value="public abstract class GenericAcl : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit GenericAcl extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;net-5.0;netcore-1.0;netcore-1.1;netcore-3.0;netcore-3.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8" />
44
<TypeSignature Language="DocId" Value="T:System.Security.AccessControl.GenericAcl" />
@@ -539,7 +539,15 @@
539539
<Docs>
540540
<summary>Returns a new instance of the <see cref="T:System.Security.AccessControl.AceEnumerator" /> class cast as an instance of the <see cref="T:System.Collections.IEnumerator" /> interface.</summary>
541541
<returns>A new <see cref="T:System.Security.AccessControl.AceEnumerator" /> object, cast as an instance of the <see cref="T:System.Collections.IEnumerator" /> interface.</returns>
542-
<remarks>To be added.</remarks>
542+
<remarks>
543+
<format type="text/markdown"><![CDATA[
544+
545+
## Remarks
546+
547+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.AccessControl.GenericAcl> instance is cast to an <xref:System.Collections.IEnumerable> interface.
548+
549+
]]></format>
550+
</remarks>
543551
</Docs>
544552
</Member>
545553
</Members>

xml/System.Security.Authentication.ExtendedProtection/ServiceNameCollection.xml

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ServiceNameCollection" FullName="System.Security.Authentication.ExtendedProtection.ServiceNameCollection">
1+
<Type Name="ServiceNameCollection" FullName="System.Security.Authentication.ExtendedProtection.ServiceNameCollection">
22
<TypeSignature Language="C#" Value="public class ServiceNameCollection : System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="net-5.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netstandard-2.0;netstandard-2.1;xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceNameCollection extends System.Collections.ReadOnlyCollectionBase" FrameworkAlternate="net-5.0;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;netframework-2.0;netframework-3.0;netframework-3.5;netstandard-2.0;netstandard-2.1" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" />
@@ -176,8 +176,8 @@
176176
<ReturnType>System.Int32</ReturnType>
177177
</ReturnValue>
178178
<Docs>
179-
<summary>To be added.</summary>
180-
<value>To be added.</value>
179+
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.ICollection" />.</summary>
180+
<value>The number of elements contained in the <see cref="T:System.Collections.ICollection" />.</value>
181181
<remarks>To be added.</remarks>
182182
</Docs>
183183
</Member>
@@ -207,8 +207,8 @@
207207
</ReturnValue>
208208
<Parameters />
209209
<Docs>
210-
<summary>To be added.</summary>
211-
<returns>To be added.</returns>
210+
<summary>Returns an enumerator that iterates through a collection.</summary>
211+
<returns>An enumerator that can be used to iterate through the collection.</returns>
212212
<remarks>To be added.</remarks>
213213
</Docs>
214214
</Member>
@@ -353,9 +353,9 @@
353353
<Parameter Name="index" Type="System.Int32" Index="1" FrameworkAlternate="netcore-1.0;netcore-1.1" />
354354
</Parameters>
355355
<Docs>
356-
<param name="array">To be added.</param>
357-
<param name="index">To be added.</param>
358-
<summary>To be added.</summary>
356+
<param name="array">The one-dimensional array as the destination for the elements copied from <see cref="T:System.Collections.ICollection" />. The array must have zero-based indexing.</param>
357+
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
358+
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
359359
<remarks>To be added.</remarks>
360360
</Docs>
361361
</Member>
@@ -384,9 +384,18 @@
384384
<ReturnType>System.Boolean</ReturnType>
385385
</ReturnValue>
386386
<Docs>
387-
<summary>To be added.</summary>
388-
<value>To be added.</value>
389-
<remarks>To be added.</remarks>
387+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
388+
<value>
389+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
390+
<remarks>
391+
<format type="text/markdown"><![CDATA[
392+
393+
## Remarks
394+
395+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Authentication.ExtendedProtection.ServiceNameCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
396+
397+
]]></format>
398+
</remarks>
390399
</Docs>
391400
</Member>
392401
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -414,9 +423,17 @@
414423
<ReturnType>System.Object</ReturnType>
415424
</ReturnValue>
416425
<Docs>
417-
<summary>To be added.</summary>
418-
<value>To be added.</value>
419-
<remarks>To be added.</remarks>
426+
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
427+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
428+
<remarks>
429+
<format type="text/markdown"><![CDATA[
430+
431+
## Remarks
432+
433+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Authentication.ExtendedProtection.ServiceNameCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
434+
435+
]]></format>
436+
</remarks>
420437
</Docs>
421438
</Member>
422439
</Members>

xml/System.Security.Permissions/KeyContainerPermissionAccessEntryCollection.xml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="KeyContainerPermissionAccessEntryCollection" FullName="System.Security.Permissions.KeyContainerPermissionAccessEntryCollection">
1+
<Type Name="KeyContainerPermissionAccessEntryCollection" FullName="System.Security.Permissions.KeyContainerPermissionAccessEntryCollection">
22
<TypeSignature Language="C#" Value="public sealed class KeyContainerPermissionAccessEntryCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit KeyContainerPermissionAccessEntryCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;net-5.0;netcore-3.0;netcore-3.1" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Permissions.KeyContainerPermissionAccessEntryCollection" />
@@ -184,9 +184,9 @@
184184
<Parameter Name="index" Type="System.Int32" Index="1" FrameworkAlternate="dotnet-plat-ext-2.1;dotnet-plat-ext-2.2;dotnet-plat-ext-3.0;dotnet-plat-ext-3.1;dotnet-plat-ext-5.0;net-5.0;netcore-3.0;netcore-3.1" />
185185
</Parameters>
186186
<Docs>
187-
<param name="array">To be added.</param>
188-
<param name="index">To be added.</param>
189-
<summary>To be added.</summary>
187+
<param name="array">The one-dimensional array as the destination for the elements copied from <see cref="T:System.Collections.ICollection" />. The array must have zero-based indexing.</param>
188+
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
189+
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
190190
<remarks>To be added.</remarks>
191191
</Docs>
192192
</Member>
@@ -627,7 +627,15 @@
627627
<Docs>
628628
<summary>Returns a <see cref="T:System.Security.Permissions.KeyContainerPermissionAccessEntryEnumerator" /> object that can be used to iterate through the objects in the collection.</summary>
629629
<returns>A <see cref="T:System.Security.Permissions.KeyContainerPermissionAccessEntryEnumerator" /> object that can be used to iterate through the collection.</returns>
630-
<remarks>To be added.</remarks>
630+
<remarks>
631+
<format type="text/markdown"><![CDATA[
632+
633+
## Remarks
634+
635+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Permissions.KeyContainerPermissionAccessEntryCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
636+
637+
]]></format>
638+
</remarks>
631639
</Docs>
632640
</Member>
633641
</Members>

xml/System.Security.Policy/ApplicationTrustCollection.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="ApplicationTrustCollection" FullName="System.Security.Policy.ApplicationTrustCollection">
1+
<Type Name="ApplicationTrustCollection" FullName="System.Security.Policy.ApplicationTrustCollection">
22
<TypeSignature Language="C#" Value="public sealed class ApplicationTrustCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ApplicationTrustCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Policy.ApplicationTrustCollection" />
@@ -969,7 +969,15 @@
969969
<Docs>
970970
<summary>Returns an enumerator that iterates through the collection.</summary>
971971
<returns>An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</returns>
972-
<remarks>To be added.</remarks>
972+
<remarks>
973+
<format type="text/markdown"><![CDATA[
974+
975+
## Remarks
976+
977+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Policy.ApplicationTrustCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
978+
979+
]]></format>
980+
</remarks>
973981
</Docs>
974982
</Member>
975983
</Members>

xml/System.Security.Principal/IdentityReferenceCollection.xml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="IdentityReferenceCollection" FullName="System.Security.Principal.IdentityReferenceCollection">
1+
<Type Name="IdentityReferenceCollection" FullName="System.Security.Principal.IdentityReferenceCollection">
22
<TypeSignature Language="C#" Value="public class IdentityReferenceCollection : System.Collections.Generic.ICollection&lt;System.Security.Principal.IdentityReference&gt;, System.Collections.Generic.IEnumerable&lt;System.Security.Principal.IdentityReference&gt;" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IdentityReferenceCollection extends System.Object implements class System.Collections.Generic.ICollection`1&lt;class System.Security.Principal.IdentityReference&gt;, class System.Collections.Generic.IEnumerable`1&lt;class System.Security.Principal.IdentityReference&gt;, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Principal.IdentityReferenceCollection" />
@@ -454,8 +454,9 @@
454454
<ReturnType>System.Boolean</ReturnType>
455455
</ReturnValue>
456456
<Docs>
457-
<summary>To be added.</summary>
458-
<value>To be added.</value>
457+
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.</summary>
458+
<value>
459+
<see langword="true" /> if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, <see langword="false" />.</value>
459460
<remarks>To be added.</remarks>
460461
</Docs>
461462
</Member>
@@ -490,7 +491,15 @@
490491
<Docs>
491492
<summary>Gets an enumerator that can be used to iterate through the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</summary>
492493
<returns>An enumerator for the <see cref="T:System.Security.Principal.IdentityReferenceCollection" /> collection.</returns>
493-
<remarks>To be added.</remarks>
494+
<remarks>
495+
<format type="text/markdown"><![CDATA[
496+
497+
## Remarks
498+
499+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Principal.IdentityReferenceCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
500+
501+
]]></format>
502+
</remarks>
494503
</Docs>
495504
</Member>
496505
<MemberGroup MemberName="Translate">

0 commit comments

Comments
 (0)