From a20192a0cedbec8fa30341fcba25becfb87877b9 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Fri, 8 Apr 2016 17:34:15 -0400 Subject: Updated documentation --- pubkey.h | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'pubkey.h') diff --git a/pubkey.h b/pubkey.h index 965dcb56..a91df165 100644 --- a/pubkey.h +++ b/pubkey.h @@ -1,8 +1,5 @@ // pubkey.h - written and placed in the public domain by Wei Dai -#ifndef CRYPTOPP_PUBKEY_H -#define CRYPTOPP_PUBKEY_H - //! \file pubkey.h //! \brief This file contains helper classes/functions for implementing public key algorithms. //! \details The class hierachies in this header file tend to look like this: @@ -34,6 +31,9 @@ //! \details The \p TF_ prefix means an implementation using trapdoor functions on integers. //! \details The \p DL_ prefix means an implementation using group operations (in groups where discrete log is hard). +#ifndef CRYPTOPP_PUBKEY_H +#define CRYPTOPP_PUBKEY_H + #include "config.h" #if CRYPTOPP_MSC_VERSION @@ -201,6 +201,10 @@ public: //! \details If \p IsRandomized() returns \p false, then \p NullRNG() can be used. bool IsRandomized() const {return false;} + //! \brief Calculates the inverse of an element + //! \param rng a \p RandomNumberGenerator derived class + //! \param x the element + //! \returns the inverse of the element in the group virtual Integer CalculateInverse(RandomNumberGenerator &rng, const Integer &x) const =0; }; -- cgit v1.2.1