Update documentation

1 files changed, 9 insertions, 1 deletions

diff --git a/simple.h b/simple.h
index fec7824e..8e2cdd4b 100644
--- a/simple.h
+++ b/simple.h
@@ -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();}

 };