diff options
author | Jeffrey Walton <noloader@gmail.com> | 2017-11-29 10:54:33 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2017-11-29 10:54:33 -0500 |
commit | 61ec50dabe14c5d4582ac187706ea27645b3562b (patch) | |
tree | 18a2eebb7adc8c9556ce132d7081a105fa058d6b /xtr.h | |
parent | 16ebfa72bf130c4725e652e4d3688d97d3feb0ee (diff) | |
download | cryptopp-git-61ec50dabe14c5d4582ac187706ea27645b3562b.tar.gz |
Change Doxygen comment style from //! to ///
Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw
Diffstat (limited to 'xtr.h')
-rw-r--r-- | xtr.h | 16 |
1 files changed, 8 insertions, 8 deletions
@@ -1,9 +1,9 @@ #ifndef CRYPTOPP_XTR_H
#define CRYPTOPP_XTR_H
-//! \file xtr.h
-//! \brief The XTR public key system
-//! \details The XTR public key system by Arjen K. Lenstra and Eric R. Verheul
+/// \file xtr.h
+/// \brief The XTR public key system
+/// \details The XTR public key system by Arjen K. Lenstra and Eric R. Verheul
#include "cryptlib.h"
#include "modarith.h"
@@ -12,8 +12,8 @@ NAMESPACE_BEGIN(CryptoPP)
-//! \class GFP2Element
-//! \brief an element of GF(p^2)
+/// \class GFP2Element
+/// \brief an element of GF(p^2)
class GFP2Element
{
public:
@@ -42,8 +42,8 @@ public: Integer c1, c2;
};
-//! \class GFP2_ONB
-//! \brief GF(p^2), optimal normal basis
+/// \class GFP2_ONB
+/// \brief GF(p^2), optimal normal basis
template <class F>
class GFP2_ONB : public AbstractRing<GFP2Element>
{
@@ -211,7 +211,7 @@ protected: mutable Integer t;
};
-//! \brief Creates primes p,q and generator g for XTR
+/// \brief Creates primes p,q and generator g for XTR
void XTR_FindPrimesAndGenerator(RandomNumberGenerator &rng, Integer &p, Integer &q, GFP2Element &g, unsigned int pbits, unsigned int qbits);
GFP2Element XTR_Exponentiate(const GFP2Element &b, const Integer &e, const Integer &p);
|