Fix documentation mistakes in MLKem and MLKemAlgorithm

Author: vcsjones

src/libraries/Common/src/System/Security/Cryptography/MLKem.cs

@@ -56,7 +56,7 @@ public abstract class MLKem : IDisposable
         ///   The specific ML-KEM algorithm for this key.
         /// </param>
         /// <exception cref="ArgumentNullException">
-        ///   <paramref name="algorithm" /> is <see langword="null" />
+        ///   <paramref name="algorithm" /> is <see langword="null" />.
         /// </exception>
         protected MLKem(MLKemAlgorithm algorithm)
         {
@@ -74,10 +74,10 @@ protected MLKem(MLKemAlgorithm algorithm)
         ///   The generated key.
         /// </returns>
         /// <exception cref="ArgumentNullException">
-        ///   <paramref name="algorithm" /> is <see langword="null" />
+        ///   <paramref name="algorithm" /> is <see langword="null" />.
         /// </exception>
         /// <exception cref="CryptographicException">
-        ///   An error occured generating the ML-KEM key.
+        ///   An error occurred generating the ML-KEM key.
         /// </exception>
         /// <exception cref="PlatformNotSupportedException">
         ///   The platform does not support ML-KEM. Callers can use the <see cref="IsSupported" /> property
@@ -326,7 +326,7 @@ public byte[] ExportPrivateSeed()
         ///   <see cref="MLKemAlgorithm.PrivateSeedSizeInBytes" /> from <paramref name="algorithm" />.
         /// </exception>
         /// <exception cref="ArgumentNullException">
-        ///   <paramref name="algorithm" /> is <see langword="null" />
+        ///   <paramref name="algorithm" /> is <see langword="null" />.
         /// </exception>
         /// <exception cref="CryptographicException">
         ///   An error occurred while importing the key.
@@ -357,9 +357,9 @@ public static MLKem ImportPrivateSeed(MLKemAlgorithm algorithm, ReadOnlySpan<byt
         ///   <see cref="MLKemAlgorithm.PrivateSeedSizeInBytes" /> from <paramref name="algorithm" />.
         /// </exception>
         /// <exception cref="ArgumentNullException">
-        ///   <para><paramref name="algorithm" /> is <see langword="null" /></para>
+        ///   <para><paramref name="algorithm" /> is <see langword="null" />.</para>
         ///   <para>-or-</para>
-        ///   <para><paramref name="source" /> is <see langword="null" /></para>
+        ///   <para><paramref name="source" /> is <see langword="null" />.</para>
         /// </exception>
         /// <exception cref="CryptographicException">
         ///   An error occurred while importing the key.
@@ -385,7 +385,7 @@ public static MLKem ImportPrivateSeed(MLKemAlgorithm algorithm, byte[] source)
         ///   <paramref name="source"/> has a length that is not valid for the ML-KEM algorithm.
         /// </exception>
         /// <exception cref="ArgumentNullException">
-        ///   <paramref name="algorithm" /> is <see langword="null" />
+        ///   <paramref name="algorithm" /> is <see langword="null" />.
         /// </exception>
         /// <exception cref="CryptographicException">
         ///   An error occurred while importing the key.
@@ -415,9 +415,9 @@ public static MLKem ImportDecapsulationKey(MLKemAlgorithm algorithm, ReadOnlySpa
         ///   <paramref name="source"/> has a length that is not valid for the ML-KEM algorithm.
         /// </exception>
         /// <exception cref="ArgumentNullException">
-        ///   <para><paramref name="algorithm" /> is <see langword="null" /></para>
+        ///   <para><paramref name="algorithm" /> is <see langword="null" />.</para>
         ///   <para>-or-</para>
-        ///   <para><paramref name="source" /> is <see langword="null" /></para>
+        ///   <para><paramref name="source" /> is <see langword="null" />.</para>
         /// </exception>
         /// <exception cref="CryptographicException">
         ///   An error occurred while importing the key.
@@ -472,9 +472,9 @@ public static MLKem ImportEncapsulationKey(MLKemAlgorithm algorithm, ReadOnlySpa
         ///   <paramref name="source"/> has a length that is not valid for the ML-KEM algorithm.
         /// </exception>
         /// <exception cref="ArgumentNullException">
-        ///   <para><paramref name="algorithm" /> is <see langword="null" /></para>
+        ///   <para><paramref name="algorithm" /> is <see langword="null" />.</para>
         ///   <para>-or-</para>
-        ///   <para><paramref name="source" /> is <see langword="null" /></para>
+        ///   <para><paramref name="source" /> is <see langword="null" />.</para>
         /// </exception>
         /// <exception cref="CryptographicException">
         ///   An error occurred while importing the key.
@@ -707,7 +707,7 @@ public bool TryExportPkcs8PrivateKey(Span<byte> destination, out int bytesWritte
         ///   Export the current key in the PKCS#8 PrivateKeyInfo format.
         /// </summary>
         /// <returns>
-        ///   A byte array containing the PKCS#8 PrivateKeyInfo representation of the this key.
+        ///   A byte array containing the PKCS#8 PrivateKeyInfo representation of this key.
         /// </returns>
         /// <exception cref="ObjectDisposedException">
         ///   This instance has been disposed.
@@ -923,7 +923,7 @@ public bool TryExportEncryptedPkcs8PrivateKey(
         ///   The password-based encryption (PBE) parameters to use when encrypting the key material.
         /// </param>
         /// <returns>
-        ///   A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of the this key.
+        ///   A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of this key.
         /// </returns>
         /// <exception cref="ArgumentNullException">
         ///    <paramref name="pbeParameters"/> is <see langword="null"/>.
@@ -963,7 +963,7 @@ public byte[] ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<byte> passwordBytes, P
         ///   The password-based encryption (PBE) parameters to use when encrypting the key material.
         /// </param>
         /// <returns>
-        ///   A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of the this key.
+        ///   A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of this key.
         /// </returns>
         /// <exception cref="ArgumentNullException">
         ///    <paramref name="pbeParameters"/> is <see langword="null"/>.
@@ -1003,7 +1003,7 @@ public byte[] ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<char> password, PbePar
         ///   The password-based encryption (PBE) parameters to use when encrypting the key material.
         /// </param>
         /// <returns>
-        ///   A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of the this key.
+        ///   A byte array containing the PKCS#8 EncryptedPrivateKeyInfo representation of this key.
         /// </returns>
         /// <exception cref="ArgumentNullException">
         ///    <paramref name="pbeParameters" /> or <paramref name="password" /> is <see langword="null" />.

src/libraries/Common/src/System/Security/Cryptography/MLKemAlgorithm.cs

@@ -63,44 +63,44 @@ private MLKemAlgorithm(
         public string Name { get; }
 
         /// <summary>
-        ///   Gets size of the encapsulation key for the algorithm, in bytes.
+        ///   Gets the size of the encapsulation key for the algorithm, in bytes.
         /// </summary>
         /// <value>
-        /// The size of the encapsulation key for the algorithm, in bytes.
+        ///   The size of the encapsulation key for the algorithm, in bytes.
         /// </value>
         public int EncapsulationKeySizeInBytes { get; }
 
         /// <summary>
-        ///   Gets size of the decapsulation key for the algorithm, in bytes.
+        ///   Gets the size of the decapsulation key for the algorithm, in bytes.
         /// </summary>
         /// <value>
-        /// The size of the decapsulation key for the algorithm, in bytes.
+        ///   The size of the decapsulation key for the algorithm, in bytes.
         /// </value>
         public int DecapsulationKeySizeInBytes { get; }
 
         /// <summary>
-        ///   Gets size of the ciphertext for the algorithm, in bytes.
+        ///   Gets the size of the ciphertext for the algorithm, in bytes.
         /// </summary>
         /// <value>
-        /// The size of the ciphertext for the algorithm, in bytes.
+        ///   The size of the ciphertext for the algorithm, in bytes.
         /// </value>
         public int CiphertextSizeInBytes { get; }
 
         /// <summary>
-        ///   Gets size of the shared secret for the algorithm, in bytes.
+        ///   Gets the size of the shared secret for the algorithm, in bytes.
         /// </summary>
         /// <value>
-        /// The size of the shared secret for the algorithm, in bytes.
+        ///   The size of the shared secret for the algorithm, in bytes.
         /// </value>
         // Right now every shared secret for ML-KEM is 32 bytes. If or when a different shared secret
         // size is needed, then it can be provided as input to the private constructor.
         public int SharedSecretSizeInBytes { get; } = 32;
 
         /// <summary>
-        ///   Gets size of the private seed for the algorithm, in bytes.
+        ///   Gets the size of the private seed for the algorithm, in bytes.
         /// </summary>
         /// <value>
-        /// The size of the private seed for the algorithm, in bytes.
+        ///   The size of the private seed for the algorithm, in bytes.
         /// </value>
         // Right now every seed for ML-KEM is 64 bytes. If or when a different seed
         // size is needed, then it can be provided as input to the private constructor.