summaryrefslogtreecommitdiff
path: root/fhmqv.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2019-08-03 22:33:46 -0400
committerJeffrey Walton <noloader@gmail.com>2019-08-03 22:33:46 -0400
commit4e6dd922f7eba0f85e4dbf89227a55a08d57e6f5 (patch)
treeeb8f644fb67e70b61d3d1fcef2dc279beb06c153 /fhmqv.h
parentc3e0d123b20d1024c2a7848ee1b1c5b6bc014542 (diff)
downloadcryptopp-git-4e6dd922f7eba0f85e4dbf89227a55a08d57e6f5.tar.gz
Update documentation
Diffstat (limited to 'fhmqv.h')
-rw-r--r--fhmqv.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/fhmqv.h b/fhmqv.h
index 103eeda0..52951542 100644
--- a/fhmqv.h
+++ b/fhmqv.h
@@ -201,7 +201,7 @@ public:
memcpy(publicKey, privateKey+StaticPrivateKeyLength(), EphemeralPublicKeyLength());
}
- /// \brief Derive shared secre from your private keys and couterparty's public keys
+ /// \brief Derive shared secret from your private keys and couterparty's public keys
/// \param agreedValue the shared secret
/// \param staticPrivateKey your long term private key
/// \param ephemeralPrivateKey your ephemeral private key
@@ -216,11 +216,11 @@ public:
/// static public key is validated. If you have previously validated the
/// couterparty's static public key, then use
/// <tt>validateStaticOtherPublicKey=false</tt> to save time.
- /// \pre size of agreedValue == AgreedValueLength()
- /// \pre length of staticPrivateKey == StaticPrivateKeyLength()
- /// \pre length of ephemeralPrivateKey == EphemeralPrivateKeyLength()
- /// \pre length of staticOtherPublicKey == StaticPublicKeyLength()
- /// \pre length of ephemeralOtherPublicKey == EphemeralPublicKeyLength()
+ /// \pre <tt>COUNTOF(agreedValue) == AgreedValueLength()
+ /// \pre <tt>COUNTOF(staticPrivateKey) == StaticPrivateKeyLength()</tt>
+ /// \pre <tt>COUNTOF(ephemeralPrivateKey) == EphemeralPrivateKeyLength()</tt>
+ /// \pre <tt>COUNTOF(staticOtherPublicKey) == StaticPublicKeyLength()</tt>
+ /// \pre <tt>COUNTOF(ephemeralOtherPublicKey) == EphemeralPublicKeyLength()</tt>
bool Agree(byte *agreedValue,
const byte *staticPrivateKey, const byte *ephemeralPrivateKey,
const byte *staticOtherPublicKey, const byte *ephemeralOtherPublicKey,