Update documentation

pull/461/head
Jeffrey Walton 2017-08-05 07:53:52 -04:00
parent 0357e508e4
commit 086ad70feb
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 9 additions and 1 deletions

View File

@ -30,7 +30,7 @@ public:
};
//! \class AlgorithmImpl
//! \brief Base class for identifying alogorithm
//! \brief Base class information
//! \tparam BASE an Algorithm derived class
//! \tparam ALGORITHM_INFO an Algorithm derived class
//! \details AlgorithmImpl provides StaticAlgorithmName from the template parameter BASE
@ -38,7 +38,15 @@ template <class BASE, class ALGORITHM_INFO=BASE>
class CRYPTOPP_NO_VTABLE AlgorithmImpl : public BASE
{
public:
//! \brief The algorithm name
//! \returns the algorithm name
//! \details StaticAlgorithmName returns the algorithm's name as a static member function.
//! The name is taken from information provided by BASE.
static std::string CRYPTOPP_API StaticAlgorithmName() {return ALGORITHM_INFO::StaticAlgorithmName();}
//! \brief The algorithm name
//! \returns the algorithm name
//! \details AlgorithmName returns the algorithm's name as a member function.
//! The name is is acquired by calling StaticAlgorithmName.
std::string AlgorithmName() const {return ALGORITHM_INFO::StaticAlgorithmName();}
};