From 43dbf5a9ecc33100d92394a8bcbb7d29cf2453e1 Mon Sep 17 00:00:00 2001
From: Peter Dettman <peter.dettman@bouncycastle.org>
Date: Wed, 26 Jul 2023 17:56:13 +0700
Subject: Update XML doc

---
 crypto/src/pqc/crypto/IMessageSigner.cs | 37 +++++++++++----------------------
 1 file changed, 12 insertions(+), 25 deletions(-)

(limited to 'crypto')

diff --git a/crypto/src/pqc/crypto/IMessageSigner.cs b/crypto/src/pqc/crypto/IMessageSigner.cs
index f04ca4477..cef23898c 100644
--- a/crypto/src/pqc/crypto/IMessageSigner.cs
+++ b/crypto/src/pqc/crypto/IMessageSigner.cs
@@ -2,36 +2,23 @@ using Org.BouncyCastle.Crypto;
 
 namespace Org.BouncyCastle.Pqc.Crypto
 {
-    /**
-     * Base interface for a PQC signing algorithm.
-     */
+    /// <summary>Base interface for a PQC signature algorithm.</summary>
     public interface IMessageSigner
     {
-        /**
-         * initialise the signer for signature generation or signature
-         * verification.
-         *
-         * @param forSigning true if we are generating a signature, false
-         *                   otherwise.
-         * @param param      key parameters for signature generation.
-         */
+        /// <summary>Initialise this instance for signature generation or verification.</summary>
+        /// <param name="forSigning">true if we are generating a signature, false otherwise.</param>
+        /// <param name="param">parameters for signature generation or verification.</param>
         void Init(bool forSigning, ICipherParameters param);
 
-        /**
-         * sign the passed in message (usually the output of a hash function).
-         *
-         * @param message the message to be signed.
-         * @return the signature of the message
-         */
+        /// <summary>Sign a message.</summary>
+        /// <param name="message">the message to be signed.</param>
+        /// <returns>the signature of the message.</returns>
         byte[] GenerateSignature(byte[] message);
 
-        /**
-         * verify the message message against the signature value.
-         *
-         * @param message the message that was supposed to have been signed.
-         * @param signature the signature of the message
-         */
+        /// <summary>Verify a purported signature for a message.</summary>
+        /// <param name="message">the message supposedly signed.</param>
+        /// <param name="signature">the purported signature to verify.</param>
+        /// <returns>true if and only if the signature verified against the message.</returns>
         bool VerifySignature(byte[] message, byte[] signature);
     }
-
-}
\ No newline at end of file
+}
-- 
cgit 1.4.1