Skip to content

Commit 8a19151

Browse files
carlossanlopbartonjs
carlossanlop
and
bartonjs
authored
Automatic port of System.Security.Cryptography documentation (dotnet#4621)
* Automatic port of System.Security.Cryptography documentation * Suggestions by gewarren * Suggestions by gewarren and bartonjs * Exceptions * Apply suggestions from code review Co-authored-by: Jeremy Barton <[email protected]> Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Jeremy Barton <[email protected]>
1 parent 297406a commit 8a19151

29 files changed

+1484
-446
lines changed

‎xml/System.Security.Cryptography.Pkcs/CmsRecipientCollection.xml

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CmsRecipientCollection" FullName="System.Security.Cryptography.Pkcs.CmsRecipientCollection">
1+
<Type Name="CmsRecipientCollection" FullName="System.Security.Cryptography.Pkcs.CmsRecipientCollection">
22
<TypeSignature Language="C#" Value="public sealed class CmsRecipientCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CmsRecipientCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" />
@@ -562,9 +562,18 @@
562562
<ReturnType>System.Boolean</ReturnType>
563563
</ReturnValue>
564564
<Docs>
565-
<summary>To be added.</summary>
566-
<value>To be added.</value>
567-
<remarks>To be added.</remarks>
565+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
566+
<value>
567+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
568+
<remarks>
569+
<format type="text/markdown"><![CDATA[
570+
571+
## Remarks
572+
573+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.CmsRecipientCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
574+
575+
]]></format>
576+
</remarks>
568577
</Docs>
569578
</Member>
570579
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -589,9 +598,17 @@
589598
<ReturnType>System.Object</ReturnType>
590599
</ReturnValue>
591600
<Docs>
592-
<summary>To be added.</summary>
593-
<value>To be added.</value>
594-
<remarks>To be added.</remarks>
601+
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
602+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
603+
<remarks>
604+
<format type="text/markdown"><![CDATA[
605+
606+
## Remarks
607+
608+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.CmsRecipientCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
609+
610+
]]></format>
611+
</remarks>
595612
</Docs>
596613
</Member>
597614
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">

‎xml/System.Security.Cryptography.Pkcs/CmsRecipientEnumerator.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="CmsRecipientEnumerator" FullName="System.Security.Cryptography.Pkcs.CmsRecipientEnumerator">
1+
<Type Name="CmsRecipientEnumerator" FullName="System.Security.Cryptography.Pkcs.CmsRecipientEnumerator">
22
<TypeSignature Language="C#" Value="public sealed class CmsRecipientEnumerator : System.Collections.IEnumerator" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CmsRecipientEnumerator extends System.Object implements class System.Collections.IEnumerator" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator" />
@@ -185,7 +185,15 @@
185185
<Docs>
186186
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</summary>
187187
<value>A <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> object that represents the current recipient in the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" /> collection.</value>
188-
<remarks>To be added.</remarks>
188+
<remarks>
189+
<format type="text/markdown"><![CDATA[
190+
191+
## Remarks
192+
193+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.CmsRecipientEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
194+
195+
]]></format>
196+
</remarks>
189197
<altmember cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" />
190198
<altmember cref="T:System.Security.Cryptography.Pkcs.CmsRecipientCollection" />
191199
</Docs>

‎xml/System.Security.Cryptography.Pkcs/RecipientInfoCollection.xml

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="RecipientInfoCollection" FullName="System.Security.Cryptography.Pkcs.RecipientInfoCollection">
1+
<Type Name="RecipientInfoCollection" FullName="System.Security.Cryptography.Pkcs.RecipientInfoCollection">
22
<TypeSignature Language="C#" Value="public sealed class RecipientInfoCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RecipientInfoCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" />
@@ -342,9 +342,18 @@
342342
<ReturnType>System.Boolean</ReturnType>
343343
</ReturnValue>
344344
<Docs>
345-
<summary>To be added.</summary>
346-
<value>To be added.</value>
347-
<remarks>To be added.</remarks>
345+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
346+
<value>
347+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
348+
<remarks>
349+
<format type="text/markdown"><![CDATA[
350+
351+
## Remarks
352+
353+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.RecipientInfoCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
354+
355+
]]></format>
356+
</remarks>
348357
</Docs>
349358
</Member>
350359
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -369,9 +378,17 @@
369378
<ReturnType>System.Object</ReturnType>
370379
</ReturnValue>
371380
<Docs>
372-
<summary>To be added.</summary>
373-
<value>To be added.</value>
374-
<remarks>To be added.</remarks>
381+
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
382+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
383+
<remarks>
384+
<format type="text/markdown"><![CDATA[
385+
386+
## Remarks
387+
388+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.RecipientInfoCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
389+
390+
]]></format>
391+
</remarks>
375392
</Docs>
376393
</Member>
377394
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
@@ -409,7 +426,15 @@
409426
<Docs>
410427
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.RecipientInfoCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
411428
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</returns>
412-
<remarks>To be added.</remarks>
429+
<remarks>
430+
<format type="text/markdown"><![CDATA[
431+
432+
## Remarks
433+
434+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.RecipientInfoCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
435+
436+
]]></format>
437+
</remarks>
413438
<altmember cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" />
414439
</Docs>
415440
</Member>

‎xml/System.Security.Cryptography.Pkcs/RecipientInfoEnumerator.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="RecipientInfoEnumerator" FullName="System.Security.Cryptography.Pkcs.RecipientInfoEnumerator">
1+
<Type Name="RecipientInfoEnumerator" FullName="System.Security.Cryptography.Pkcs.RecipientInfoEnumerator">
22
<TypeSignature Language="C#" Value="public sealed class RecipientInfoEnumerator : System.Collections.IEnumerator" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RecipientInfoEnumerator extends System.Object implements class System.Collections.IEnumerator" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator" />
@@ -182,7 +182,15 @@
182182
<Docs>
183183
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</summary>
184184
<value>A <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" /> object that represents the current recipient information structure in the <see cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" /> collection.</value>
185-
<remarks>To be added.</remarks>
185+
<remarks>
186+
<format type="text/markdown"><![CDATA[
187+
188+
## Remarks
189+
190+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.RecipientInfoEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
191+
192+
]]></format>
193+
</remarks>
186194
<altmember cref="T:System.Security.Cryptography.Pkcs.RecipientInfo" />
187195
<altmember cref="T:System.Security.Cryptography.Pkcs.RecipientInfoCollection" />
188196
</Docs>

‎xml/System.Security.Cryptography.Pkcs/SignerInfoCollection.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="SignerInfoCollection" FullName="System.Security.Cryptography.Pkcs.SignerInfoCollection">
1+
<Type Name="SignerInfoCollection" FullName="System.Security.Cryptography.Pkcs.SignerInfoCollection">
22
<TypeSignature Language="C#" Value="public sealed class SignerInfoCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SignerInfoCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" />
@@ -335,7 +335,15 @@
335335
<Docs>
336336
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.SignerInfoCollection.System#Collections#IEnumerable#GetEnumerator" /> method returns a <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object for the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
337337
<returns>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" /> object that can be used to enumerate the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</returns>
338-
<remarks>To be added.</remarks>
338+
<remarks>
339+
<format type="text/markdown"><![CDATA[
340+
341+
## Remarks
342+
343+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.SignerInfoCollection> instance is cast to an <xref:System.Collections.IEnumerable> interface.
344+
345+
]]></format>
346+
</remarks>
339347
<altmember cref="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" />
340348
</Docs>
341349
</Member>

‎xml/System.Security.Cryptography.Pkcs/SignerInfoEnumerator.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="SignerInfoEnumerator" FullName="System.Security.Cryptography.Pkcs.SignerInfoEnumerator">
1+
<Type Name="SignerInfoEnumerator" FullName="System.Security.Cryptography.Pkcs.SignerInfoEnumerator">
22
<TypeSignature Language="C#" Value="public sealed class SignerInfoEnumerator : System.Collections.IEnumerator" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SignerInfoEnumerator extends System.Object implements class System.Collections.IEnumerator" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.Pkcs.SignerInfoEnumerator" />
@@ -167,7 +167,15 @@
167167
<Docs>
168168
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.SignerInfoEnumerator.System#Collections#IEnumerator#Current" /> property retrieves the current <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object from the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</summary>
169169
<value>A <see cref="T:System.Security.Cryptography.Pkcs.SignerInfo" /> object that represents the current signer information structure in the <see cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" /> collection.</value>
170-
<remarks>To be added.</remarks>
170+
<remarks>
171+
<format type="text/markdown"><![CDATA[
172+
173+
## Remarks
174+
175+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.Pkcs.SignerInfoEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
176+
177+
]]></format>
178+
</remarks>
171179
<altmember cref="T:System.Security.Cryptography.Pkcs.SignerInfo" />
172180
<altmember cref="T:System.Security.Cryptography.Pkcs.SignerInfoCollection" />
173181
</Docs>

‎xml/System.Security.Cryptography.X509Certificates/X509ChainPolicy.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="X509ChainPolicy" FullName="System.Security.Cryptography.X509Certificates.X509ChainPolicy">
1+
<Type Name="X509ChainPolicy" FullName="System.Security.Cryptography.X509Certificates.X509ChainPolicy">
22
<TypeSignature Language="C#" Value="public sealed class X509ChainPolicy" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit X509ChainPolicy extends System.Object" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.X509Certificates.X509ChainPolicy" />
@@ -249,8 +249,10 @@
249249
<ReturnType>System.Boolean</ReturnType>
250250
</ReturnValue>
251251
<Docs>
252-
<summary>To be added.</summary>
253-
<value>To be added.</value>
252+
<summary>Gets or sets a value that indicates whether the chain engine can use the Authority Information Access (AIA) extension to locate unknown issuer certificates.</summary>
253+
<value>
254+
<see langword="true" /> if using the AIA extension is disabled; otherwise, <see langword="false" />.
255+
The default is <see langword="false" />.</value>
254256
<remarks>To be added.</remarks>
255257
</Docs>
256258
</Member>

‎xml/System.Security.Cryptography/AsnEncodedDataCollection.xml

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AsnEncodedDataCollection" FullName="System.Security.Cryptography.AsnEncodedDataCollection">
1+
<Type Name="AsnEncodedDataCollection" FullName="System.Security.Cryptography.AsnEncodedDataCollection">
22
<TypeSignature Language="C#" Value="public sealed class AsnEncodedDataCollection : System.Collections.ICollection" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AsnEncodedDataCollection extends System.Object implements class System.Collections.ICollection, class System.Collections.IEnumerable" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.AsnEncodedDataCollection" />
@@ -663,9 +663,18 @@ The length for <paramref name="index" /> is invalid.</exception>
663663
<ReturnType>System.Boolean</ReturnType>
664664
</ReturnValue>
665665
<Docs>
666-
<summary>To be added.</summary>
667-
<value>To be added.</value>
668-
<remarks>To be added.</remarks>
666+
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe).</summary>
667+
<value>
668+
<see langword="true" /> if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, <see langword="false" />.</value>
669+
<remarks>
670+
<format type="text/markdown"><![CDATA[
671+
672+
## Remarks
673+
674+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.AsnEncodedDataCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
675+
676+
]]></format>
677+
</remarks>
669678
</Docs>
670679
</Member>
671680
<Member MemberName="System.Collections.ICollection.SyncRoot">
@@ -693,9 +702,17 @@ The length for <paramref name="index" /> is invalid.</exception>
693702
<ReturnType>System.Object</ReturnType>
694703
</ReturnValue>
695704
<Docs>
696-
<summary>To be added.</summary>
697-
<value>To be added.</value>
698-
<remarks>To be added.</remarks>
705+
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</summary>
706+
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />.</value>
707+
<remarks>
708+
<format type="text/markdown"><![CDATA[
709+
710+
## Remarks
711+
712+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.AsnEncodedDataCollection> instance is cast to an <xref:System.Collections.ICollection> interface.
713+
714+
]]></format>
715+
</remarks>
699716
</Docs>
700717
</Member>
701718
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">

‎xml/System.Security.Cryptography/AsnEncodedDataEnumerator.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="AsnEncodedDataEnumerator" FullName="System.Security.Cryptography.AsnEncodedDataEnumerator">
1+
<Type Name="AsnEncodedDataEnumerator" FullName="System.Security.Cryptography.AsnEncodedDataEnumerator">
22
<TypeSignature Language="C#" Value="public sealed class AsnEncodedDataEnumerator : System.Collections.IEnumerator" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit AsnEncodedDataEnumerator extends System.Object implements class System.Collections.IEnumerator" />
44
<TypeSignature Language="DocId" Value="T:System.Security.Cryptography.AsnEncodedDataEnumerator" />
@@ -266,7 +266,15 @@
266266
<Docs>
267267
<summary>Gets the current <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object in an <see cref="T:System.Security.Cryptography.AsnEncodedDataCollection" /> object.</summary>
268268
<value>The current <see cref="T:System.Security.Cryptography.AsnEncodedData" /> object.</value>
269-
<remarks>To be added.</remarks>
269+
<remarks>
270+
<format type="text/markdown"><![CDATA[
271+
272+
## Remarks
273+
274+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Security.Cryptography.AsnEncodedDataEnumerator> instance is cast to an <xref:System.Collections.IEnumerator> interface.
275+
276+
]]></format>
277+
</remarks>
270278
</Docs>
271279
</Member>
272280
</Members>

0 commit comments

Comments
 (0)