Skip to content

Commit 1c7f6a8

Browse files
bartonjsmairaw
authored andcommitted
Add documentation for PbeParameters (#2786)
* Add documentation for PbeParameters * Update PbeEncryptionAlgorithm.xml
1 parent b4a4043 commit 1c7f6a8

File tree

2 files changed

+21
-19
lines changed

2 files changed

+21
-19
lines changed

xml/System.Security.Cryptography/PbeEncryptionAlgorithm.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<BaseTypeName>System.Enum</BaseTypeName>
1717
</Base>
1818
<Docs>
19-
<summary>To be added.</summary>
19+
<summary>Specifies encryption algorithms to be used with Password-Based Encryption (PBE).</summary>
2020
<remarks>To be added.</remarks>
2121
</Docs>
2222
<Members>
@@ -40,7 +40,7 @@
4040
</ReturnValue>
4141
<MemberValue>1</MemberValue>
4242
<Docs>
43-
<summary>To be added.</summary>
43+
<summary>Indicates the encryption should be performed with the AES-128 algorithm in CBC mode with PKCS#7 padding.</summary>
4444
</Docs>
4545
</Member>
4646
<Member MemberName="Aes192Cbc">
@@ -63,7 +63,7 @@
6363
</ReturnValue>
6464
<MemberValue>2</MemberValue>
6565
<Docs>
66-
<summary>To be added.</summary>
66+
<summary>Indicates the encryption should be performed with the AES-192 algorithm in CBC mode with PKCS#7 padding.</summary>
6767
</Docs>
6868
</Member>
6969
<Member MemberName="Aes256Cbc">
@@ -86,7 +86,7 @@
8686
</ReturnValue>
8787
<MemberValue>3</MemberValue>
8888
<Docs>
89-
<summary>To be added.</summary>
89+
<summary>Indicates that encryption be performed with the AES-256 algorithm in CBC mode with PKCS#7 padding.</summary>
9090
</Docs>
9191
</Member>
9292
<Member MemberName="TripleDes3KeyPkcs12">
@@ -109,7 +109,7 @@
109109
</ReturnValue>
110110
<MemberValue>4</MemberValue>
111111
<Docs>
112-
<summary>To be added.</summary>
112+
<summary>Indicates the encryption should be performed with the TripleDES algorithm in CBC mode with a 192-bit key derived using the Key Derivation Function (KDF) from PKCS#12.</summary>
113113
</Docs>
114114
</Member>
115115
<Member MemberName="Unknown">
@@ -132,8 +132,8 @@
132132
</ReturnValue>
133133
<MemberValue>0</MemberValue>
134134
<Docs>
135-
<summary>To be added.</summary>
135+
<summary>Indicates that no encryption algorithm has been selected.</summary>
136136
</Docs>
137137
</Member>
138138
</Members>
139-
</Type>
139+
</Type>

xml/System.Security.Cryptography/PbeParameters.xml

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@
1717
</Base>
1818
<Interfaces />
1919
<Docs>
20-
<summary>To be added.</summary>
20+
<summary>Represents parameters to be used for Password-Based Encryption (PBE).</summary>
2121
<remarks>To be added.</remarks>
22+
<threadsafe>All public and protected members of <see cref="T:System.Security.Cryptography.PbeParameters" /> are thread-safe and may be used concurrently from multiple threads.</threadsafe>
2223
</Docs>
2324
<Members>
2425
<Member MemberName=".ctor">
@@ -42,11 +43,12 @@
4243
<Parameter Name="iterationCount" Type="System.Int32" />
4344
</Parameters>
4445
<Docs>
45-
<param name="encryptionAlgorithm">To be added.</param>
46-
<param name="hashAlgorithm">To be added.</param>
47-
<param name="iterationCount">To be added.</param>
48-
<summary>To be added.</summary>
46+
<param name="encryptionAlgorithm">The algorithm to use when encrypting data.</param>
47+
<param name="hashAlgorithm">The name of a hash algorithm to use with the Key Derivation Function (KDF) to turn a password into an encryption key.</param>
48+
<param name="iterationCount">The iteration count to provide to the Key Derivation Function (KDF) to turn a password into an encryption key.</param>
49+
<summary>Initializes a new instance of the <see cref="T:System.Security.Cryptography.PbeParameters"/> class.</summary>
4950
<remarks>To be added.</remarks>
51+
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="iterationCount"/> is less than 1.</exception>
5052
</Docs>
5153
</Member>
5254
<Member MemberName="EncryptionAlgorithm">
@@ -68,8 +70,8 @@
6870
<ReturnType>System.Security.Cryptography.PbeEncryptionAlgorithm</ReturnType>
6971
</ReturnValue>
7072
<Docs>
71-
<summary>To be added.</summary>
72-
<value>To be added.</value>
73+
<summary>Gets the algorithm to use when encrypting data.</summary>
74+
<value>The algorithm to use when encrypting data.</value>
7375
<remarks>To be added.</remarks>
7476
</Docs>
7577
</Member>
@@ -92,8 +94,8 @@
9294
<ReturnType>System.Security.Cryptography.HashAlgorithmName</ReturnType>
9395
</ReturnValue>
9496
<Docs>
95-
<summary>To be added.</summary>
96-
<value>To be added.</value>
97+
<summary>Gets the name of the hash algorithm to use with the Key Derivation Function (KDF) to turn a password into an encryption key.</summary>
98+
<value>The name of the hash algorithm to use with the Key Derivation Function (KDF) to turn a password into an encryption key.</value>
9799
<remarks>To be added.</remarks>
98100
</Docs>
99101
</Member>
@@ -116,10 +118,10 @@
116118
<ReturnType>System.Int32</ReturnType>
117119
</ReturnValue>
118120
<Docs>
119-
<summary>To be added.</summary>
120-
<value>To be added.</value>
121+
<summary>Gets the iteration count to provide to the Key Derivation Function (KDF) to turn a password into an encryption key.</summary>
122+
<value>The iteration count to provide to the Key Derivation Function (KDF) to turn a password into an encryption key.</value>
121123
<remarks>To be added.</remarks>
122124
</Docs>
123125
</Member>
124126
</Members>
125-
</Type>
127+
</Type>

0 commit comments

Comments
 (0)