arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

pull/154/head
Jeffrey Walton 2016-04-05 21:05:13 -04:00
parent caea6f1c59
commit 2f34169149
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
cryptlib.h
View File

@ -451,8 +451,18 @@ DOCUMENTED_NAMESPACE_BEGIN(Name)
DOCUMENTED_NAMESPACE_END DOCUMENTED_NAMESPACE_END
//! \brief Namespace containing weak and wounded algorithms. //! \brief Namespace containing weak and wounded algorithms.
//! \details Weak is part of the CryptoPP namespace. Schemes and algorithms are moved into Weak //! \details Weak is part of the CryptoPP namespace. Schemes and algorithms are moved into Weak
//! when their security level is reduced to an unacceptable value by contemporary standards. //! when their security level is reduced to an unacceptable level by contemporary standards.
//! \details To use an algorithm in the Weak namespace, you must <tt>\c \#define
//! CRYPTOPP_ENABLE_NAMESPACE_WEAK 1</tt> before including a header for a weak or wounded
//! algorithm. For example:
//! <pre>
//! \c \#define CRYPTOPP_ENABLE_NAMESPACE_WEAK 1
//! \c \#include <md5.h>
//! ...
//! CryptoPP::Weak::MD5 md5;
//! </pre>
DOCUMENTED_NAMESPACE_BEGIN(Weak) DOCUMENTED_NAMESPACE_BEGIN(Weak)
// weak and wounded algorithms // weak and wounded algorithms
DOCUMENTED_NAMESPACE_END DOCUMENTED_NAMESPACE_END