Skip to content

Commit 8d239e9

Browse files
bartonjsRon Petrusha
authored andcommitted
Add missing CmsRecipient docs, make existing docs match style guide (#2800)
1 parent 1a08bff commit 8d239e9

File tree

1 file changed

+55
-28
lines changed

1 file changed

+55
-28
lines changed

xml/System.Security.Cryptography.Pkcs/CmsRecipient.xml

Lines changed: 55 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<AssemblyVersion>4.0.2.0</AssemblyVersion>
3737
</AssemblyInfo>
3838
<Docs>
39-
<summary>Constructs an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class.</summary>
39+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class.</summary>
4040
</Docs>
4141
</MemberGroup>
4242
<Member MemberName=".ctor">
@@ -66,8 +66,8 @@
6666
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
6767
</Parameters>
6868
<Docs>
69-
<param name="certificate">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the recipient certificate.</param>
70-
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)" /> constructor constructs an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class by using the specified recipient certificate.</summary>
69+
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
70+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified certificate, using the default encryption mode for the public key algorithm and an <see cref="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber"/> subject identifier.</summary>
7171
<remarks>
7272
<format type="text/markdown"><![CDATA[
7373
@@ -77,12 +77,13 @@
7777
|Property|Default value|
7878
|--------------|-------------------|
7979
|<xref:System.Security.Cryptography.Pkcs.CmsRecipient.RecipientIdentifierType%2A>|<xref:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber>|
80+
|<xref:System.Security.Cryptography.Pkcs.CmsRecipient.RSAEncryptionPadding%2A>|null|
8081
8182
]]></format>
8283
</remarks>
83-
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
84-
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
84+
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
8585
<altmember cref="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2)" />
86+
<altmember cref="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.RSAEncryptionPadding)" />
8687
</Docs>
8788
</Member>
8889
<Member MemberName=".ctor">
@@ -113,13 +114,14 @@
113114
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
114115
</Parameters>
115116
<Docs>
116-
<param name="recipientIdentifierType">A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration that specifies the type of the identifier of the recipient.</param>
117-
<param name="certificate">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that represents the recipient certificate.</param>
118-
<summary>The <see cref="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2)" /> constructor constructs an instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class by using the specified recipient identifier type and recipient certificate.</summary>
117+
<param name="recipientIdentifierType">The scheme to use for identifying which recipient certificate was used.</param>
118+
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
119+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified certificate and recipient identifier type, using the default encryption mode for the public key algorithm.</summary>
119120
<remarks>To be added.</remarks>
120-
<exception cref="T:System.ArgumentNullException">A null reference was passed to a method that does not accept it as a valid argument.</exception>
121-
<exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic operation could not be completed.</exception>
121+
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> parameter is <see langword="null" />.</exception>
122+
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="recipientIdentifierType" /> value is not supported.</exception>
122123
<altmember cref="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)" />
124+
<altmember cref="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2,System.Security.Cryptography.RSAEncryptionPadding)" />
123125
</Docs>
124126
</Member>
125127
<Member MemberName=".ctor">
@@ -141,10 +143,27 @@
141143
<Parameter Name="rsaEncryptionPadding" Type="System.Security.Cryptography.RSAEncryptionPadding" Index="1" FrameworkAlternate="dotnet-plat-ext-3.0" />
142144
</Parameters>
143145
<Docs>
144-
<param name="certificate">To be added.</param>
145-
<param name="rsaEncryptionPadding">To be added.</param>
146-
<summary>To be added.</summary>
147-
<remarks>To be added.</remarks>
146+
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
147+
<param name="rsaEncryptionPadding">The RSA padding mode to use when encrypting for this recipient.</param>
148+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified RSA certificate and RSA encryption padding, using an <see cref="F:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber"/> subject identifier.</summary>
149+
<remarks>
150+
<format type="text/markdown"><![CDATA[
151+
152+
## Remarks
153+
The <xref:System.Security.Cryptography.Pkcs.CmsRecipient> class has the following default property values.
154+
155+
|Property|Default value|
156+
|--------------|-------------------|
157+
|<xref:System.Security.Cryptography.Pkcs.CmsRecipient.RecipientIdentifierType%2A>|<xref:System.Security.Cryptography.Pkcs.SubjectIdentifierType.IssuerAndSerialNumber>|
158+
159+
]]></format>
160+
</remarks>
161+
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> or <paramref name="rsaEncryptionPadding" /> parameter is <see langword="null" />.</exception>
162+
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter public key is not recognized as an RSA public key.
163+
164+
-or-
165+
166+
The <paramref name="recipientIdentifierType" /> value is not supported.</exception>
148167
</Docs>
149168
</Member>
150169
<Member MemberName=".ctor">
@@ -167,11 +186,14 @@
167186
<Parameter Name="rsaEncryptionPadding" Type="System.Security.Cryptography.RSAEncryptionPadding" Index="2" FrameworkAlternate="dotnet-plat-ext-3.0" />
168187
</Parameters>
169188
<Docs>
170-
<param name="recipientIdentifierType">To be added.</param>
171-
<param name="certificate">To be added.</param>
172-
<param name="rsaEncryptionPadding">To be added.</param>
173-
<summary>To be added.</summary>
189+
<param name="recipientIdentifierType">The scheme to use for identifying which recipient certificate was used.</param>
190+
<param name="certificate">The certificate to use when encrypting for this recipient.</param>
191+
<param name="rsaEncryptionPadding">The RSA padding mode to use when encrypting for this recipient.</param>
192+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.Pkcs.CmsRecipient" /> class with a specified RSA certificate, RSA encryption padding, and subject identifier.</summary>
174193
<remarks>To be added.</remarks>
194+
<exception cref="T:System.ArgumentNullException">The <paramref name="certificate" /> or <paramref name="rsaEncryptionPadding" /> parameter is <see langword="null" />.</exception>
195+
<exception cref="T:System.Security.Cryptography.CryptographicException">The <paramref name="certificate" /> parameter public key is not recognized as an RSA public key.</exception>
196+
<altmember cref="M:System.Security.Cryptography.Pkcs.CmsRecipient.#ctor(System.Security.Cryptography.Pkcs.SubjectIdentifierType,System.Security.Cryptography.X509Certificates.X509Certificate2)" />
175197
</Docs>
176198
</Member>
177199
<Member MemberName="Certificate">
@@ -201,10 +223,9 @@
201223
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2</ReturnType>
202224
</ReturnValue>
203225
<Docs>
204-
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipient.Certificate" /> property retrieves the certificate associated with the recipient.</summary>
205-
<value>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> object that holds the certificate associated with the recipient.</value>
226+
<summary>Gets the certificate to use when encrypting for this recipient.</summary>
227+
<value>The certificate to use when encrypting for this recipient.</value>
206228
<remarks>To be added.</remarks>
207-
<altmember cref="P:System.Security.Cryptography.Pkcs.CmsRecipient.RecipientIdentifierType" />
208229
</Docs>
209230
</Member>
210231
<Member MemberName="RecipientIdentifierType">
@@ -234,10 +255,9 @@
234255
<ReturnType>System.Security.Cryptography.Pkcs.SubjectIdentifierType</ReturnType>
235256
</ReturnValue>
236257
<Docs>
237-
<summary>The <see cref="P:System.Security.Cryptography.Pkcs.CmsRecipient.RecipientIdentifierType" /> property retrieves the type of the identifier of the recipient.</summary>
238-
<value>A member of the <see cref="T:System.Security.Cryptography.Pkcs.SubjectIdentifierType" /> enumeration that specifies the type of the identifier of the recipient.</value>
258+
<summary>Gets the scheme to use for identifying which recipient certificate was used.</summary>
259+
<value>The scheme to use for identifying which recipient certificate was used.</value>
239260
<remarks>To be added.</remarks>
240-
<altmember cref="P:System.Security.Cryptography.Pkcs.CmsRecipient.Certificate" />
241261
</Docs>
242262
</Member>
243263
<Member MemberName="RSAEncryptionPadding">
@@ -259,10 +279,17 @@
259279
<ReturnType>System.Security.Cryptography.RSAEncryptionPadding</ReturnType>
260280
</ReturnValue>
261281
<Docs>
262-
<summary>To be added.</summary>
263-
<value>To be added.</value>
264-
<remarks>To be added.</remarks>
282+
<summary>Gets the RSA encryption padding to use when encrypting for this recipient.</summary>
283+
<value>The RSA encryption padding to use when encrypting for this recipient.</value>
284+
<remarks>
285+
<format type="text/markdown"><![CDATA[
286+
287+
## Remarks
288+
A `null` value indicates that the default encryption padding for the certificate's public key should be used.
289+
290+
]]></format>
291+
</remarks>
265292
</Docs>
266293
</Member>
267294
</Members>
268-
</Type>
295+
</Type>

0 commit comments

Comments
 (0)