Skip to content

Commit a7dd410

Browse files
krwqcarlossanlop
andauthored
Add missing API docs for System.Security (#4761)
* add missing API docs for System.Security * replace xref with see cref * Update xml/System.Security.Cryptography.X509Certificates/X509ChainPolicy.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Security.Cryptography.X509Certificates/X509ChainTrustMode.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Security.Cryptography.X509Certificates/X509ChainTrustMode.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Security.Cryptography.X509Certificates/X509ChainTrustMode.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Security.Cryptography.X509Certificates/X509ChainPolicy.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Security.Cryptography.X509Certificates/X509ChainPolicy.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Security.Cryptography.X509Certificates/X509ChainPolicy.xml Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]>
1 parent 65c0989 commit a7dd410

File tree

3 files changed

+29
-13
lines changed

3 files changed

+29
-13
lines changed

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

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,17 @@
225225
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2Collection</ReturnType>
226226
</ReturnValue>
227227
<Docs>
228-
<summary>To be added.</summary>
229-
<value>To be added.</value>
230-
<remarks>To be added.</remarks>
228+
<summary>Represents a collection of certificates replacing the default certificate trust.</summary>
229+
<value>A collection of certificates replacing the default certificate trust.</value>
230+
<remarks>
231+
<format type="text/markdown"><![CDATA[
232+
233+
## Remarks
234+
235+
The collection is respected only when <xref:System.Security.Cryptography.X509Certificates.X509ChainPolicy.CustomTrustStore> is set to <xref:System.Security.Cryptography.X509Certificates.X509ChainTrustMode.CustomRootTrust>.
236+
237+
]]></format>
238+
</remarks>
231239
</Docs>
232240
</Member>
233241
<Member MemberName="DisableCertificateDownloads">
@@ -489,9 +497,17 @@
489497
<ReturnType>System.Security.Cryptography.X509Certificates.X509ChainTrustMode</ReturnType>
490498
</ReturnValue>
491499
<Docs>
492-
<summary>To be added.</summary>
493-
<value>To be added.</value>
494-
<remarks>To be added.</remarks>
500+
<summary>The mode determining the root trust for building the certificate chain.</summary>
501+
<value>An <see cref="T:System.Security.Cryptography.X509Certificates.X509ChainTrustMode" /> value determining the root trust.</value>
502+
<remarks>
503+
<format type="text/markdown"><![CDATA[
504+
505+
## Remarks
506+
507+
When <xref:System.Security.Cryptography.X509Certificates.X509ChainTrustMode.CustomRootTrust> is used, the <xref:System.Security.Cryptography.X509Certificates.X509ChainPolicy.CustomTrustStore> will be used instead of the default root trust.
508+
509+
]]></format>
510+
</remarks>
495511
</Docs>
496512
</Member>
497513
<Member MemberName="UrlRetrievalTimeout">

xml/System.Security.Cryptography.X509Certificates/X509ChainTrustMode.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
16+
<summary>The mode determining the root trust for building the certificate chain.</summary>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -34,7 +34,7 @@
3434
</ReturnValue>
3535
<MemberValue>1</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>When this value is used, the <see cref="P:System.Security.Cryptography.X509Certificates.X509ChainPolicy.CustomTrustStore" /> will be used instead of the default root trust.</summary>
3838
</Docs>
3939
</Member>
4040
<Member MemberName="System">
@@ -54,7 +54,7 @@
5454
</ReturnValue>
5555
<MemberValue>0</MemberValue>
5656
<Docs>
57-
<summary>To be added.</summary>
57+
<summary>Use the default (system) root trust.</summary>
5858
</Docs>
5959
</Member>
6060
</Members>

xml/System.Security.Cryptography/HashAlgorithm.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -440,10 +440,10 @@ The following example calculates the <xref:System.Security.Cryptography.SHA256>
440440
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="net-5.0" />
441441
</Parameters>
442442
<Docs>
443-
<param name="inputStream">To be added.</param>
444-
<param name="cancellationToken">To be added.</param>
445-
<summary>To be added.</summary>
446-
<returns>To be added.</returns>
443+
<param name="inputStream">The input to compute the hash code for.</param>
444+
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
445+
<summary>Asynchronously computes the hash value for the specified <see cref="T:System.IO.Stream" /> object.</summary>
446+
<returns>A task that represents the asynchronous compute hash operation and wraps the computed hash code.</returns>
447447
<remarks>To be added.</remarks>
448448
</Docs>
449449
</Member>

0 commit comments

Comments
 (0)