From 2f341691495a8ed62e9e8b8ba28a7716c8228c04 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 5 Apr 2016 21:05:13 -0400 Subject: [PATCH] Updated documentation --- cryptlib.h | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/cryptlib.h b/cryptlib.h index 551f6c86..a79637cf 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -451,8 +451,18 @@ DOCUMENTED_NAMESPACE_BEGIN(Name) DOCUMENTED_NAMESPACE_END //! \brief Namespace containing weak and wounded algorithms. -//! \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. +//! \details Weak is part of the CryptoPP namespace. Schemes and algorithms are moved into Weak +//! when their security level is reduced to an unacceptable level by contemporary standards. +//! \details To use an algorithm in the Weak namespace, you must \c \#define +//! CRYPTOPP_ENABLE_NAMESPACE_WEAK 1 before including a header for a weak or wounded +//! algorithm. For example: +//!
+//!     \c \#define CRYPTOPP_ENABLE_NAMESPACE_WEAK 1
+//!     \c \#include 
+//!     ...
+//!     CryptoPP::Weak::MD5 md5;
+//!   
+ DOCUMENTED_NAMESPACE_BEGIN(Weak) // weak and wounded algorithms DOCUMENTED_NAMESPACE_END