summaryrefslogtreecommitdiff
path: root/config_int.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2020-12-27 02:07:45 -0500
committerJeffrey Walton <noloader@gmail.com>2020-12-27 02:07:45 -0500
commit618ffe9373fb7174ae962dcbd294394521615d0e (patch)
treea27eb507f1addda6213ea93d535dafff59737b34 /config_int.h
parent082fb46fc1207b5a44b97d86a457bcf1ea4997fc (diff)
downloadcryptopp-git-618ffe9373fb7174ae962dcbd294394521615d0e.tar.gz
Update documentation
Diffstat (limited to 'config_int.h')
-rw-r--r--config_int.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/config_int.h b/config_int.h
index 7e6dc7b3..2c55ec7c 100644
--- a/config_int.h
+++ b/config_int.h
@@ -46,6 +46,12 @@ NAMESPACE_BEGIN(CryptoPP)
// the NaCl gear. Also see https://github.com/weidai11/cryptopp/issues/609.
/// \brief 8-bit unsigned datatype
+/// \details The Crypto++ <tt>byte</tt> was originally in global namespace to avoid
+/// ambiguity with other byte typedefs. <tt>byte</tt> was moved to Crypto++ namespace
+/// due to C++17, <tt>std::byte</tt> and potential compile problems.
+/// \sa CRYPTOPP_NO_GLOBAL_BYTE <A HREF="http://github.com/weidai11/cryptopp/issues/442">Issue 442</A>,
+/// <A HREF="https://www.cryptopp.com/wiki/Configure.sh">std::byte</A> on the
+/// Crypto++ wiki
/// \since Crypto++ 1.0
typedef unsigned char byte;
/// \brief 16-bit unsigned datatype