diff options
| author | Jeffrey Walton <noloader@gmail.com> | 2020-12-25 21:28:48 -0500 |
|---|---|---|
| committer | Jeffrey Walton <noloader@gmail.com> | 2020-12-25 21:28:48 -0500 |
| commit | 25f4945683ba1769d1bae12961abf29c087c89d3 (patch) | |
| tree | b47ec030a427a32aba783235f0432141c6695a02 /config_int.h | |
| parent | 03d4dc45e00481fbb08a8e9b2f7b634df7b6a620 (diff) | |
| download | cryptopp-git-25f4945683ba1769d1bae12961abf29c087c89d3.tar.gz | |
Update documentation
Diffstat (limited to 'config_int.h')
| -rw-r--r-- | config_int.h | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/config_int.h b/config_int.h index 9bf8a0a7..8b2d882d 100644 --- a/config_int.h +++ b/config_int.h @@ -137,21 +137,27 @@ const lword LWORD_MAX = W64LIT(0xffffffffffffffff); #if defined(CRYPTOPP_DOXYGEN_PROCESSING)
/// \brief Half word used for multiprecision integer arithmetic
- /// \details The typedef for <tt>hword</tt> varies depending on the platform.
- /// On 32-bit platforms it is usually <tt>word16</tt>. On 64-bit platforms it
- /// is usually <tt>word32</tt>.
+ /// \details hword is used for multiprecision integer arithmetic.
+ /// The typedef for <tt>hword</tt> varies depending on the platform.
+ /// On 32-bit platforms it is usually <tt>word16</tt>. On 64-bit platforms
+ /// it is usually <tt>word32</tt>.
+ /// \details Library users typically use byte, word16, word32 and word64.
/// \since Crypto++ 2.0
typedef word32 hword;
/// \brief Full word used for multiprecision integer arithmetic
- /// \details The typedef for <tt>word</tt> varies depending on the platform.
- /// On 32-bit platforms it is usually <tt>word32</tt>. On 64-bit platforms it
- /// is usually <tt>word64</tt>.
+ /// \details word is used for multiprecision integer arithmetic.
+ /// The typedef for <tt>word</tt> varies depending on the platform.
+ /// On 32-bit platforms it is usually <tt>word32</tt>. On 64-bit platforms
+ /// it is usually <tt>word64</tt>.
+ /// \details Library users typically use byte, word16, word32 and word64.
/// \since Crypto++ 2.0
typedef word64 word;
/// \brief Double word used for multiprecision integer arithmetic
- /// \details The typedef for <tt>dword</tt> varies depending on the platform.
- /// On 32-bit platforms it is usually <tt>word64</tt>. On 64-bit platforms it
- /// is usually <tt>word128</tt>.
+ /// \details dword is used for multiprecision integer arithmetic.
+ /// The typedef for <tt>dword</tt> varies depending on the platform.
+ /// On 32-bit platforms it is usually <tt>word64</tt>. On 64-bit platforms
+ /// it is usually <tt>word128</tt>.
+ /// \details Library users typically use byte, word16, word32 and word64.
/// \sa CRYPTOPP_WORD128_AVAILABLE
/// \since Crypto++ 2.0
typedef word128 dword;
|