Skip to content

Commit d31e34d

Browse files
carlossanlopmairaw
authored andcommitted
Port System.Security.Cryptography.Pkcs source comments to Docs (#2309)
* Port System.Security.Cryptography.Pkcs source comments to Docs * Update xml/System.Security.Cryptography.Pkcs/Pkcs12CertBag.xml Co-Authored-By: carlossanlop <[email protected]> * Update xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampRequest.xml Co-Authored-By: carlossanlop <[email protected]> * Update xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampRequest.xml Co-Authored-By: carlossanlop <[email protected]>
1 parent c1fa9fd commit d31e34d

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

xml/System.Security.Cryptography.Pkcs/Pkcs12CertBag.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@
3737
<Parameter Name="encodedCertificate" Type="System.ReadOnlyMemory&lt;System.Byte&gt;" />
3838
</Parameters>
3939
<Docs>
40-
<param name="certificateType">To be added.</param>
41-
<param name="encodedCertificate">To be added.</param>
42-
<summary>To be added.</summary>
40+
<param name="certificateType">The Object Identifier (OID) for the certificate type.</param>
41+
<param name="encodedCertificate">The encoded certificate value.</param>
42+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.Pkcs12CertBag" /> class using the specified certificate type and encoding.</summary>
4343
<remarks>To be added.</remarks>
4444
</Docs>
4545
</Member>
@@ -134,4 +134,4 @@
134134
</Docs>
135135
</Member>
136136
</Members>
137-
</Type>
137+
</Type>

xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampRequest.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -121,14 +121,14 @@
121121
<Parameter Name="extensions" Type="System.Security.Cryptography.X509Certificates.X509ExtensionCollection" />
122122
</Parameters>
123123
<Docs>
124-
<param name="hash">To be added.</param>
125-
<param name="hashAlgorithmId">To be added.</param>
126-
<param name="requestedPolicyId">To be added.</param>
127-
<param name="nonce">To be added.</param>
128-
<param name="requestSignerCertificates">To be added.</param>
129-
<param name="extensions">To be added.</param>
130-
<summary>To be added.</summary>
131-
<returns>To be added.</returns>
124+
<param name="hash">The pre-computed hash value to be timestamped.</param>
125+
<param name="hashAlgorithmId">The Object Identifier (OID) for the hash algorithm that produced <paramref name="hash" />.</param>
126+
<param name="requestedPolicyId">The Object Identifier (OID) for a timestamp policy the Timestamp Authority (TSA) should use, or <see langword="null" /> to express no preference.</param>
127+
<param name="nonce">An optional nonce (number used once) to uniquely identify this request to pair it with the response. The value is interpreted as an unsigned big-endian integer and may be normalized to the encoding format.</param>
128+
<param name="requestSignerCertificates"><see langword="true" /> to indicate the Timestamp Authority (TSA) must include the signing certificate in the issued timestamp token; otherwise, <see langword="false" />.</param>
129+
<param name="extensions">RFC3161 extensions to present with the request.</param>
130+
<summary>Create a timestamp request using a pre-computed hash value.</summary>
131+
<returns>An <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampRequest" /> representing the chosen values.</returns>
132132
<remarks>To be added.</remarks>
133133
</Docs>
134134
</Member>
@@ -481,4 +481,4 @@
481481
</Docs>
482482
</Member>
483483
</Members>
484-
</Type>
484+
</Type>

xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@
4141
</ReturnValue>
4242
<Parameters />
4343
<Docs>
44-
<summary>To be added.</summary>
45-
<returns>To be added.</returns>
44+
<summary>Gets a Signed Cryptographic Message Syntax (CMS) representation of the RFC3161 timestamp token.</summary>
45+
<returns>The <see cref="T:System.Security.Cryptography.Pkcs.SignedCms" /> representation of the <see cref="T:System.Security.Cryptography.Pkcs.Rfc3161TimestampToken" />.</returns>
4646
<remarks>To be added.</remarks>
4747
</Docs>
4848
</Member>

0 commit comments

Comments
 (0)