diff options
author | Jeffrey Walton <noloader@gmail.com> | 2020-12-27 02:02:30 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2020-12-27 02:02:30 -0500 |
commit | 082fb46fc1207b5a44b97d86a457bcf1ea4997fc (patch) | |
tree | df6980bb93a9a6a872ea16ebfeb8b39f50f11653 /config_int.h | |
parent | 0d7b9ebe5fad7934fe81a36004e625878df983c8 (diff) | |
download | cryptopp-git-082fb46fc1207b5a44b97d86a457bcf1ea4997fc.tar.gz |
Update documentation
Diffstat (limited to 'config_int.h')
-rw-r--r-- | config_int.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/config_int.h b/config_int.h index 52cfeaf5..7e6dc7b3 100644 --- a/config_int.h +++ b/config_int.h @@ -104,7 +104,8 @@ typedef signed int sword32; /// \brief Declare an unsigned word64
/// \details W64LIT is used to portability declare or assign 64-bit literal values.
- /// Use the macro like shown below.
+ /// W64LIT will append the proper suffix to ensure the compiler accepts the literal.
+ /// \details Use the macro like shown below.
/// <pre>
/// word64 x = W64LIT(0xffffffffffffffff);
/// </pre>
@@ -113,7 +114,8 @@ typedef signed int sword32; /// \brief Declare a signed word64
/// \details SW64LIT is used to portability declare or assign 64-bit literal values.
- /// Use the macro like shown below.
+ /// SW64LIT will append the proper suffix to ensure the compiler accepts the literal.
+ /// \details Use the macro like shown below.
/// <pre>
/// sword64 x = SW64LIT(0xffffffffffffffff);
/// </pre>
@@ -151,6 +153,8 @@ typedef word64 lword; /// \brief Large word type max value
/// \details LWORD_MAX is the maximum value for large word types.
+/// Since an <tt>lword</tt> is an unsigned type, the value is
+/// <tt>0xffffffffffffffff</tt>. W64LIT will append the proper suffix.
const lword LWORD_MAX = W64LIT(0xffffffffffffffff);
#if defined(CRYPTOPP_DOXYGEN_PROCESSING)
|