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

Update documentation

pull/757/head
Jeffrey Walton 2018-12-03 06:55:57 -05:00
parent 6729b29410
commit 0b1162aa34
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
cryptlib.h
View File

@ -472,25 +472,31 @@ public:
#if CRYPTOPP_DOXYGEN_PROCESSING #if CRYPTOPP_DOXYGEN_PROCESSING
/// \brief Default channel for BufferedTransformation /// \brief Default channel for BufferedTransformation
/// \details DEFAULT_CHANNEL is equal to an empty string /// \details DEFAULT_CHANNEL is equal to an empty string
/// \details Crypto++ 6.0 placed DEFAULT_CHANNEL in the header, rather than declaring it as extern and /// \details The definition for DEFAULT_CHANNEL is in <tt>cryptlib.cpp</tt>.
/// placing the definition in the source file. As an external definition the string DEFAULT_CHANNEL /// It can be subject to <A HREF="https://isocpp.org/wiki/faq/ctors">Static
/// was subject to static initialization order fiasco problems. /// Initialization Order Fiasco</A>. If you experience a crash in
/// DEFAULT_CHANNEL where the string object is NULL, then you probably have
/// a global object using DEFAULT_CHANNEL before it has been constructed.
const std::string DEFAULT_CHANNEL; const std::string DEFAULT_CHANNEL;
/// \brief Channel for additional authenticated data /// \brief Channel for additional authenticated data
/// \details AAD_CHANNEL is equal to "AAD" /// \details AAD_CHANNEL is equal to "AAD"
/// \details Crypto++ 6.0 placed AAD_CHANNEL in the header, rather than declaring it as extern and /// \details The definition for AAD_CHANNEL is in <tt>cryptlib.cpp</tt>.
/// placing the definition in the source file. As an external definition the string AAD_CHANNEL /// It can be subject to <A HREF="https://isocpp.org/wiki/faq/ctors">Static
/// was subject to static initialization order fiasco problems. /// Initialization Order Fiasco</A>. If you experience a crash in
/// AAD_CHANNEL where the string object is NULL, then you probably have a
/// global object using AAD_CHANNEL before it has been constructed.
const std::string AAD_CHANNEL; const std::string AAD_CHANNEL;
/// \brief An empty set of name-value pairs /// \brief An empty set of name-value pairs
/// \details Crypto++ 6.0 placed g_nullNameValuePairs in the header, rather than declaring it as extern /// \details The definition for g_nullNameValuePairs is in <tt>cryptlib.cpp</tt>.
/// and placing the definition in the source file. As an external definition the g_nullNameValuePairs /// It can be subject to <A HREF="https://isocpp.org/wiki/faq/ctors">Static
/// was subject to static initialization order fiasco problems. /// Initialization Order Fiasco</A>. If you experience a crash in
/// g_nullNameValuePairs where the string object is NULL, then you probably
/// have a global object using g_nullNameValuePairs before it has been
/// constructed.
const NameValuePairs& g_nullNameValuePairs; const NameValuePairs& g_nullNameValuePairs;
// Sun Studio 12.3 and earlier can't handle NameValuePairs initialization
#else #else
extern const std::string DEFAULT_CHANNEL; extern const std::string DEFAULT_CHANNEL;
extern const std::string AAD_CHANNEL; extern const std::string AAD_CHANNEL;