summaryrefslogtreecommitdiff
path: root/dh.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-07-27 19:15:21 -0400
committerJeffrey Walton <noloader@gmail.com>2017-07-27 19:15:21 -0400
commit2c9a3039e85061ff094e460e7afae1aed934350b (patch)
treed868f186df1474265502750f8a4016b374aa6128 /dh.h
parentfec712491ec5a002cc46177fb7afe1d2412f0185 (diff)
downloadcryptopp-git-2c9a3039e85061ff094e460e7afae1aed934350b.tar.gz
Update documentation
This cleanup was performed using Clang and -Wdocumentation -Wno-documentation-deprecated-sync
Diffstat (limited to 'dh.h')
-rw-r--r--dh.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/dh.h b/dh.h
index a71897a6..3d3dba12 100644
--- a/dh.h
+++ b/dh.h
@@ -15,10 +15,11 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class DH_Domain
//! \brief Diffie-Hellman domain
//! \tparam GROUP_PARAMETERS group parameters
-//! \tparam COFACTOR_OPTION \ref CofactorMultiplicationOption "cofactor multiplication option"
+//! \tparam COFACTOR_OPTION cofactor multiplication option
//! \details A Diffie-Hellman domain is a set of parameters that must be shared
//! by two parties in a key agreement protocol, along with the algorithms
//! for generating key pairs and deriving agreed values.
+//! \details For COFACTOR_OPTION, see CofactorMultiplicationOption.
//! \sa DL_SimpleKeyAgreementDomainBase
//! \since Crypto++ 1.0
template <class GROUP_PARAMETERS, class COFACTOR_OPTION = typename GROUP_PARAMETERS::DefaultCofactorOption>