Merge pull request #5106 from krwq/sys-security-docs

Add missing XML docs to System.Security.*
dotnet · Nov 17, 2020 · ef6ffd3 · ef6ffd3
2 parents 2583a26 + 93088c5
commit ef6ffd3
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 10 deletions.
diff --git a/xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml b/xml/System.Security.Cryptography.Pkcs/Rfc3161TimestampToken.xml
@@ -252,7 +252,7 @@ If the digest does not match, the algorithm does not match, or the TSA certifica
       </Parameters>
       <Docs>
         <param name="hash">The cryptographic hash to verify against this time-stamp token.</param>
-        <param name="hashAlgorithmId">To be added.</param>
+        <param name="hashAlgorithmId">The OID of the hash algorithm.</param>
         <param name="signerCertificate">When this method returns, the certificate from the Timestamp Authority (TSA) which signed this token, or <see langword="null" /> if a signer certificate cannot be determined. This parameter is treated as uninitialized.</param>
         <param name="extraCandidates">An optional collection of certificates to consider as the Timestamp Authority (TSA) certificates, in addition to any certificates that may be included within the token.</param>
         <summary>Verifies that the current token is a valid time-stamp token for the provided data hash and algorithm identifier.</summary>

diff --git a/xml/System.Security.Cryptography/RSA.xml b/xml/System.Security.Cryptography/RSA.xml
@@ -2365,7 +2365,7 @@ An error occurred creating the signature.</exception>
       </Parameters>
       <Docs>
         <param name="hash">The hash value of the data to be signed.</param>
-        <param name="destination">To be added.</param>
+        <param name="destination">The buffer to receive the RSA signature.</param>
         <param name="hashAlgorithm">The hash algorithm used to create the hash value of the data.</param>
         <param name="padding">The padding.</param>
         <param name="bytesWritten">When this method returns, the total number of bytes written into <paramref name="destination" />. This parameter is treated as uninitialized.</param>

diff --git a/xml/System.Security.Cryptography/TripleDESCng.xml b/xml/System.Security.Cryptography/TripleDESCng.xml
@@ -501,9 +501,19 @@
         <Parameter Name="disposing" Type="System.Boolean" />
       </Parameters>
       <Docs>
-        <param name="disposing">To be added.</param>
-        <summary>To be added.</summary>
-        <remarks>To be added.</remarks>
+        <param name="disposing">
+          <see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
+        <summary>Releases the unmanaged resources used by the <see cref="T:System.Security.Cryptography.SymmetricAlgorithm" /> and optionally releases the managed resources.</summary>
+        <remarks>
+          <format type="text/markdown"><![CDATA[
+
+## Remarks
+ This method is called by the public `Dispose()` method and the `Finalize` method. `Dispose()` invokes the protected `Dispose(Boolean)` method with the `disposing` parameter set to `true`. `Finalize` invokes `Dispose` with `disposing` set to `false`.
+
+ When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this <xref:System.Security.Cryptography.SymmetricAlgorithm> references. This method invokes the `Dispose()` method of each referenced object.
+
+ ]]></format>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="GenerateIV">
@@ -687,9 +697,15 @@
         <ReturnType>System.Security.Cryptography.KeySizes[]</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
-        <remarks>To be added.</remarks>
+        <summary>Gets the key sizes, in bits, that are supported by the symmetric algorithm.</summary>
+        <value>An array that contains the key sizes supported by the algorithm.</value>
+        <remarks>
+          <format type="text/markdown"><![CDATA[  
+  
+## Remarks  
+ For TripleDES, the legal key sizes are 128 and 192 bits.
+]]></format>
+        </remarks>
       </Docs>
     </Member>
   </Members>

diff --git a/xml/System.Security.Permissions/KeyContainerPermissionAccessEntryCollection.xml b/xml/System.Security.Permissions/KeyContainerPermissionAccessEntryCollection.xml
@@ -81,7 +81,7 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Initializes a new instance of the KeyContainerPermissionAccessEntryCollection class.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>

diff --git a/xml/System.Security.Permissions/KeyContainerPermissionAccessEntryEnumerator.xml b/xml/System.Security.Permissions/KeyContainerPermissionAccessEntryEnumerator.xml
@@ -87,7 +87,7 @@
       </AssemblyInfo>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
+        <summary>Initializes a new instance of the KeyContainerPermissionAccessEntryEnumerator class.</summary>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>